Module: Scorpio::OpenAPI::V2

Includes:
Tags
Defined in:
lib/scorpio/openapi/v2.rb,
lib/scorpio/openapi/v2/dialect.rb

Defined Under Namespace

Modules: Document, JsonReference, Operation, PathItem, Paths, Response, Tag

Constant Summary collapse

Info =
Document.definitions['info']
Contact =
Document.definitions['contact']
License =
Document.definitions['license']
Definitions =
Document.definitions['definitions']
ParameterDefinitions =
Document.definitions['parameterDefinitions']
ResponseDefinitions =
Document.definitions['responseDefinitions']
ExternalDocs =
Document.definitions['externalDocs']
Examples =
Document.definitions['examples']
MimeType =
Document.definitions['mimeType']
Responses =
Document.definitions['responses']
ResponseValue =
Document.definitions['responseValue']
Headers =
Document.definitions['headers']
Header =
Document.definitions['header']
VendorExtension =
Document.definitions['vendorExtension']
BodyParameter =
Document.definitions['bodyParameter']
HeaderParameterSubSchema =
Document.definitions['headerParameterSubSchema']
QueryParameterSubSchema =
Document.definitions['queryParameterSubSchema']
FormDataParameterSubSchema =
Document.definitions['formDataParameterSubSchema']
PathParameterSubSchema =
Document.definitions['pathParameterSubSchema']
NonBodyParameter =
Document.definitions['nonBodyParameter']
Parameter =
Document.definitions['parameter']
Schema =
Document.definitions['schema']
FileSchema =
Document.definitions['fileSchema']
PrimitivesItems =
Document.definitions['primitivesItems']
Security =
Document.definitions['security']
SecurityRequirement =
Document.definitions['securityRequirement']
Xml =
Document.definitions['xml']
SecurityDefinitions =
Document.definitions['securityDefinitions']
BasicAuthenticationSecurity =
Document.definitions['basicAuthenticationSecurity']
ApiKeySecurity =
Document.definitions['apiKeySecurity']
OAuth2ImplicitSecurity =
Document.definitions['oauth2ImplicitSecurity']
OAuth2PasswordSecurity =
Document.definitions['oauth2PasswordSecurity']
OAuth2ApplicationSecurity =
Document.definitions['oauth2ApplicationSecurity']
OAuth2AccessCodeSecurity =
Document.definitions['oauth2AccessCodeSecurity']
OAuth2Scopes =
Document.definitions['oauth2Scopes']
MediaTypeList =
Document.definitions['mediaTypeList']
ParametersList =
Document.definitions['parametersList']
SchemesList =
Document.definitions['schemesList']
CollectionFormat =
Document.definitions['collectionFormat']
CollectionFormatWithMulti =
Document.definitions['collectionFormatWithMulti']
Title =
Document.definitions['title']
Description =
Document.definitions['description']
Default =
Document.definitions['default']
MultipleOf =
Document.definitions['multipleOf']
Maximum =
Document.definitions['maximum']
ExclusiveMaximum =
Document.definitions['exclusiveMaximum']
Minimum =
Document.definitions['minimum']
ExclusiveMinimum =
Document.definitions['exclusiveMinimum']
MaxLength =
Document.definitions['maxLength']
MinLength =
Document.definitions['minLength']
Pattern =
Document.definitions['pattern']
MaxItems =
Document.definitions['maxItems']
MinItems =
Document.definitions['minItems']
UniqueItems =
Document.definitions['uniqueItems']
Enum =
Document.definitions['enum']
VOCABULARY =
JSI::Schema::Vocabulary.new(
  elements: [
    JSI::Schema::Elements::SELF[],

    JSI::Schema::Elements::REF[exclusive: true],

    JSI::Schema::Elements::MULTIPLE_OF[],

    JSI::Schema::Elements::MAXIMUM_BOOLEAN_EXCLUSIVE[],

    JSI::Schema::Elements::MINIMUM_BOOLEAN_EXCLUSIVE[],

    JSI::Schema::Elements::MAX_LENGTH[],

    JSI::Schema::Elements::MIN_LENGTH[],

    JSI::Schema::Elements::PATTERN[],

    # TODO this should not include additionalItems
    JSI::Schema::Elements::ITEMS[],

    JSI::Schema::Elements::MAX_ITEMS[],

    JSI::Schema::Elements::MIN_ITEMS[],

    JSI::Schema::Elements::UNIQUE_ITEMS[],

    JSI::Schema::Elements::MAX_PROPERTIES[],

    JSI::Schema::Elements::MIN_PROPERTIES[],

    JSI::Schema::Elements::REQUIRED[],

    # TODO this should not include patternProperties
    JSI::Schema::Elements::PROPERTIES[],

    JSI::Schema::Elements::ENUM[],

    JSI::Schema::Elements::TYPE[],

    JSI::Schema::Elements::ALL_OF[],

    JSI::Schema::Elements::INFO_STRING[keyword: 'title'],
    JSI::Schema::Elements::INFO_STRING[keyword: 'description'],

    JSI::Schema::Elements::INFO_BOOL[keyword: 'readOnly'],

    JSI::Schema::Elements::DEFAULT[],

    JSI::Schema::Elements::FORMAT[],

    JSI::Schema::Element.new(keyword: 'example') { }, # no actions
  ],
)
DIALECT =
JSI::Schema::Dialect.new(
  vocabularies: [VOCABULARY],
  integer_disallows_0_fraction: true,
)

Method Summary

Methods included from Tags

#named