class

Open::Api

Inherits YAML::Serializable < JSON::Serializable < Reference < Object

Constants

COMP_TYPES = { schema: Open::Api::Schema, response: Open::Api::Response, parameter: Open::Api::Parameter, header: Open::Api::Header, security_scheme: Open::Api::Security::Scheme, }

VERSION = {{ (`shards version \"/tmp/tmp.HNpHFO/src/src/open-api\"`).chomp.stringify }}

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

new(pull : JSON::PullParser)

new(info : Open::Api::Info)

new(title : String = "Open Api Server")

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

Class methods

route_meta

route_meta=(route_meta : Hash(String, Hash(String, RouteMetaDatum)))

schema_refs

schema_refs=(schema_refs : Hash(String, Open::Api::Schema))

Instance methods

add_path(path, op : String | Open::Api::Operation, item : Open::Api::OperationItem)

components

components=(components : Open::Api::Components)

has_header_ref?(name : String) : Bool | Nil

Returns true if a Open::Api::Header is registered under the given name. Returns false otherwise.

has_parameter_ref?(name : String) : Bool | Nil

Returns true if a Open::Api::Parameter is registered under the given name. Returns false otherwise.

has_response_ref?(name : String) : Bool | Nil

Returns true if a Open::Api::Response is registered under the given name. Returns false otherwise.

has_schema_ref?(name : String) : Bool | Nil

Returns true if a Open::Api::Schema is registered under the given name. Returns false otherwise.

has_security_scheme_ref?(name : String) : Bool | Nil

Returns true if a Open::Api::Security::Scheme is registered under the given name. Returns false otherwise.

header_ref(name : String) : Open::Api::Ref

Retrieves a Open::Api::Ref by name if it is registered

info

info=(info : Open::Api::Info)

openapi

openapi=(openapi : String)

parameter_ref(name : String) : Open::Api::Ref

Retrieves a Open::Api::Ref by name if it is registered

paths

paths=(paths : Open::Api::Paths)

register_parameter(name : String, obj : Open::Api::Parameter)

Register a Open::Api::Parameter to be used by the OpenAPI spec. Will be stored in components.parameters. Use #parameter_ref to fetch a Open::Api::Ref to a parameter definition.

register_response(name : String, obj : Open::Api::Response)

Register a Open::Api::Response to be used by the OpenAPI spec. Will be stored in components.responses. Use #response_ref to fetch a Open::Api::Ref to a response definition.

register_schema(name : String, obj : Open::Api::Schema)

Register a Open::Api::Schema to be used by the OpenAPI spec. Will be stored in components.schemas. Use #schema_ref to fetch a Open::Api::Ref to a schema definition.

register_security_scheme(name : String, obj : Open::Api::Security::Scheme)

Register a Open::Api::Security::Scheme to be used by the OpenAPI spec. Will be stored in components.security_schemes. Use #security_scheme_ref to fetch a Open::Api::Ref to a security_scheme definition.

response_ref(name : String) : Open::Api::Ref

Retrieves a Open::Api::Ref by name if it is registered

schema_ref(name : String) : Open::Api::Ref

Retrieves a Open::Api::Ref by name if it is registered

security

Apply the security globally to all operations

security=(security : Array(Open::Api::Security::Requirement) | Nil)

Apply the security globally to all operations

security_scheme_ref(name : String) : Open::Api::Ref

Retrieves a Open::Api::Ref by name if it is registered

servers

servers=(servers : Array(Open::Api::Server))