/ 
Whelk-1.02
River stage zero No dependents

Changes for version 1.02 - 2025-03-04

  • Added response_code to endpoint definition, which changes success code in generated OpenAPI
  • Added 'schemas' method to resources as a special method executed before 'api' method is executed
  • Not setting response in endpoint definition now assumes empty response (status 204)
  • API Failures now use more specific HTTP response codes
  • Changed how wrappers set their response schemas
    • Status classes 4XX and 5XX are now used by built in wrappers
    • Wrapper maps statuses to NXX, instead of N00 (for example 2XX instead of 200)

Documentation

Whelk::Manual
Reference to APIs with Whelk
Whelk::Manual::Kelp
Setting up Whelk inside Kelp

Modules

Kelp::Module::Whelk
Whelk as a Kelp module
Whelk
A friendly API framework based on Kelp
Whelk::Exception
Exceptions for your API
Whelk::Formatter
Base class for formatters
Whelk::OpenAPI
Whelk's default OpenAPI generator class
Whelk::Resource
Base Kelp controller for Whelk
Whelk::Role::Resource
Role for Whelk API resources
Whelk::Schema
Whelk validation language
Whelk::Schema::Definition
Base class for a Whelk type
Whelk::Wrapper
Base class for wrappers

Provides

Whelk::Config
in lib/Whelk/Config.pm
Whelk::Endpoint
in lib/Whelk/Endpoint.pm
Whelk::Endpoint::Parameters
in lib/Whelk/Endpoint/Parameters.pm
Whelk::Formatter::JSON
in lib/Whelk/Formatter/JSON.pm
Whelk::Formatter::YAML
in lib/Whelk/Formatter/YAML.pm
Whelk::ResourceMeta
in lib/Whelk/ResourceMeta.pm
Whelk::Schema::Definition::Array
in lib/Whelk/Schema/Definition/Array.pm
Whelk::Schema::Definition::Boolean
in lib/Whelk/Schema/Definition/Boolean.pm
Whelk::Schema::Definition::Empty
in lib/Whelk/Schema/Definition/Empty.pm
Whelk::Schema::Definition::Integer
in lib/Whelk/Schema/Definition/Integer.pm
Whelk::Schema::Definition::Null
in lib/Whelk/Schema/Definition/Null.pm
Whelk::Schema::Definition::Number
in lib/Whelk/Schema/Definition/Number.pm
Whelk::Schema::Definition::Object
in lib/Whelk/Schema/Definition/Object.pm
Whelk::Schema::Definition::String
in lib/Whelk/Schema/Definition/String.pm
Whelk::Schema::Definition::_Scalar
in lib/Whelk/Schema/Definition/_Scalar.pm
Whelk::Schema::ExtraRule
in lib/Whelk/Schema/ExtraRule.pm
Whelk::StrictBase
in lib/Whelk/StrictBase.pm
Whelk::Wrapper::Simple
in lib/Whelk/Wrapper/Simple.pm
Whelk::Wrapper::WithStatus
in lib/Whelk/Wrapper/WithStatus.pm

Examples

Other files