Module: Scorpio::OpenAPI::V3

Defined in:

lib/scorpio/openapi.rb,
lib/scorpio/openapi.rb,
lib/scorpio/openapi/document.rb,
lib/scorpio/openapi/operation.rb,
lib/scorpio/openapi/v3/server.rb

Overview

(this block is here just so the above informative comment is not interpreted as module doc)

Defined Under Namespace

Classes: Document, Operation, Server

Constant Summary

Reference =

naming these is not strictly necessary, but is nice to have. generated: puts JSI::Schema.new(::YAML.load_file(Scorpio.root.join('documents/github.com/OAI/OpenAPI-Specification/blob/oas3-schema/schemas/v3.0/schema.yaml')))['definitions'].select { |k,v| ['object', nil].include?(v['type']) }.keys.map { |k| "#{k[0].upcase}#{k[1..-1]} = openapi_class.call('definitions', '#{k}')" }

openapi_class.call('definitions', 'Reference')

Info =

openapi_class.call('definitions', 'Info')

Contact =

openapi_class.call('definitions', 'Contact')

License =

openapi_class.call('definitions', 'License')

ServerVariable =

openapi_class.call('definitions', 'ServerVariable')

Components =

openapi_class.call('definitions', 'Components')

Schema =

openapi_class.call('definitions', 'Schema')

Discriminator =

openapi_class.call('definitions', 'Discriminator')

XML =

openapi_class.call('definitions', 'XML')

Response =

openapi_class.call('definitions', 'Response')

MediaType =

openapi_class.call('definitions', 'MediaType')

MediaTypeWithExample =

openapi_class.call('definitions', 'MediaTypeWithExample')

MediaTypeWithExamples =

openapi_class.call('definitions', 'MediaTypeWithExamples')

Example =

openapi_class.call('definitions', 'Example')

Header =

openapi_class.call('definitions', 'Header')

HeaderWithSchema =

openapi_class.call('definitions', 'HeaderWithSchema')

HeaderWithSchemaWithExample =

openapi_class.call('definitions', 'HeaderWithSchemaWithExample')

HeaderWithSchemaWithExamples =

openapi_class.call('definitions', 'HeaderWithSchemaWithExamples')

HeaderWithContent =

openapi_class.call('definitions', 'HeaderWithContent')

Paths =

openapi_class.call('definitions', 'Paths')

PathItem =

openapi_class.call('definitions', 'PathItem')

Responses =

openapi_class.call('definitions', 'Responses')

SecurityRequirement =

openapi_class.call('definitions', 'SecurityRequirement')

Tag =

openapi_class.call('definitions', 'Tag')

ExternalDocumentation =

openapi_class.call('definitions', 'ExternalDocumentation')

Parameter =

openapi_class.call('definitions', 'Parameter')

ParameterWithSchema =

openapi_class.call('definitions', 'ParameterWithSchema')

ParameterWithSchemaWithExample =

openapi_class.call('definitions', 'ParameterWithSchemaWithExample')

ParameterWithSchemaWithExampleInPath =

openapi_class.call('definitions', 'ParameterWithSchemaWithExampleInPath')

ParameterWithSchemaWithExampleInQuery =

openapi_class.call('definitions', 'ParameterWithSchemaWithExampleInQuery')

ParameterWithSchemaWithExampleInHeader =

openapi_class.call('definitions', 'ParameterWithSchemaWithExampleInHeader')

ParameterWithSchemaWithExampleInCookie =

openapi_class.call('definitions', 'ParameterWithSchemaWithExampleInCookie')

ParameterWithSchemaWithExamples =

openapi_class.call('definitions', 'ParameterWithSchemaWithExamples')

ParameterWithSchemaWithExamplesInPath =

openapi_class.call('definitions', 'ParameterWithSchemaWithExamplesInPath')

ParameterWithSchemaWithExamplesInQuery =

openapi_class.call('definitions', 'ParameterWithSchemaWithExamplesInQuery')

ParameterWithSchemaWithExamplesInHeader =

openapi_class.call('definitions', 'ParameterWithSchemaWithExamplesInHeader')

ParameterWithSchemaWithExamplesInCookie =

openapi_class.call('definitions', 'ParameterWithSchemaWithExamplesInCookie')

ParameterWithContent =

openapi_class.call('definitions', 'ParameterWithContent')

ParameterWithContentInPath =

openapi_class.call('definitions', 'ParameterWithContentInPath')

ParameterWithContentNotInPath =

openapi_class.call('definitions', 'ParameterWithContentNotInPath')

RequestBody =

openapi_class.call('definitions', 'RequestBody')

SecurityScheme =

openapi_class.call('definitions', 'SecurityScheme')

APIKeySecurityScheme =

openapi_class.call('definitions', 'APIKeySecurityScheme')

HTTPSecurityScheme =

openapi_class.call('definitions', 'HTTPSecurityScheme')

NonBearerHTTPSecurityScheme =

openapi_class.call('definitions', 'NonBearerHTTPSecurityScheme')

BearerHTTPSecurityScheme =

openapi_class.call('definitions', 'BearerHTTPSecurityScheme')

OAuth2SecurityScheme =

openapi_class.call('definitions', 'OAuth2SecurityScheme')

OpenIdConnectSecurityScheme =

openapi_class.call('definitions', 'OpenIdConnectSecurityScheme')

OAuthFlows =

openapi_class.call('definitions', 'OAuthFlows')

ImplicitOAuthFlow =

openapi_class.call('definitions', 'ImplicitOAuthFlow')

PasswordOAuthFlow =

openapi_class.call('definitions', 'PasswordOAuthFlow')

ClientCredentialsFlow =

openapi_class.call('definitions', 'ClientCredentialsFlow')

AuthorizationCodeOAuthFlow =

openapi_class.call('definitions', 'AuthorizationCodeOAuthFlow')

Link =

openapi_class.call('definitions', 'Link')

LinkWithOperationRef =

openapi_class.call('definitions', 'LinkWithOperationRef')

LinkWithOperationId =

openapi_class.call('definitions', 'LinkWithOperationId')

Callback =

openapi_class.call('definitions', 'Callback')

Encoding =

openapi_class.call('definitions', 'Encoding')