scorpio 0.6.4 → 0.7.0

data/documents/{github.com/OAI/OpenAPI-Specification/blob/oas3-schema/schemas/v3.0 → spec.openapis.org/oas/3.0}/schema.yaml

@@ -1,3 +1,6 @@
+id: https://spec.openapis.org/oas/3.0/schema/2021-09-28
+$schema: http://json-schema.org/draft-04/schema#
+description: The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3
 type: object
 required:
   - openapi
@@ -85,7 +88,7 @@ definitions:
         format: email
     patternProperties:
       '^x-': {}
-    additionalProperties: false    
+    additionalProperties: false
 
   License:
     type: object
@@ -143,8 +146,8 @@ definitions:
         patternProperties:
           '^[a-zA-Z0-9\.\-_]+$':
             oneOf:
-              - $ref: '#/definitions/SchemaReference'
               - $ref: '#/definitions/Schema'
+              - $ref: '#/definitions/SchemaReference'
       responses:
         type: object
         patternProperties:
@@ -335,8 +338,8 @@ definitions:
         $ref: '#/definitions/XML'
     patternProperties:
       '^x-': {}
-    additionalProperties: false        
-  
+    additionalProperties: false
+
   Discriminator:
     type: object
     required:
@@ -397,11 +400,6 @@ definitions:
     additionalProperties: false
 
   MediaType:
-    oneOf:
-      - $ref: '#/definitions/MediaTypeWithExample'
-      - $ref: '#/definitions/MediaTypeWithExamples'
-
-  MediaTypeWithExample:
     type: object
     properties:
       schema:
@@ -409,23 +407,6 @@ definitions:
           - $ref: '#/definitions/Schema'
           - $ref: '#/definitions/SchemaReference'
       example: {}
-      encoding:
-        type: object
-        additionalProperties:
-          $ref: '#/definitions/Encoding'
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false 
-
-  MediaTypeWithExamples:
-    type: object
-    required:
-      - examples
-    properties:
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
       examples:
         type: object
         additionalProperties:
@@ -438,7 +419,9 @@ definitions:
           $ref: '#/definitions/Encoding'
     patternProperties:
       '^x-': {}
-    additionalProperties: false 
+    additionalProperties: false
+    allOf:
+      - $ref: '#/definitions/ExampleXORExamples'
 
   Example:
     type: object
@@ -456,19 +439,7 @@ definitions:
     additionalProperties: false
 
   Header:
-    oneOf:
-      - $ref: '#/definitions/HeaderWithSchema'
-      - $ref: '#/definitions/HeaderWithContent'
-
-  HeaderWithSchema:
-    oneOf:
-      - $ref: '#/definitions/HeaderWithSchemaWithExample'
-      - $ref: '#/definitions/HeaderWithSchemaWithExamples'
-
-  HeaderWithSchemaWithExample:
     type: object
-    required:
-      - schema
     properties:
       description:
         type: string
@@ -495,42 +466,13 @@ definitions:
         oneOf:
           - $ref: '#/definitions/Schema'
           - $ref: '#/definitions/SchemaReference'
+      content:
+        type: object
+        additionalProperties:
+          $ref: '#/definitions/MediaType'
+        minProperties: 1
+        maxProperties: 1
       example: {}
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false  
-
-  HeaderWithSchemaWithExamples:
-    type: object
-    required:
-      - schema
-      - examples
-    properties:
-      description:
-        type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      style:
-        type: string
-        enum:
-          - simple
-        default: simple
-      explode:
-        type: boolean
-      allowReserved:
-        type: boolean
-        default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
       examples:
         type: object
         additionalProperties:
@@ -540,37 +482,14 @@ definitions:
     patternProperties:
       '^x-': {}
     additionalProperties: false
-
-  HeaderWithContent:
-    type: object
-    required:
-      - content
-    properties:
-      description:
-        type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      content:
-        type: object
-        additionalProperties:
-          $ref: '#/definitions/MediaType'
-        minProperties: 1
-        maxProperties: 1
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
+    allOf:
+      - $ref: '#/definitions/ExampleXORExamples'
+      - $ref: '#/definitions/SchemaXORContent'
 
   Paths:
     type: object
     patternProperties:
-      '^\/': 
+      '^\/':
         $ref: '#/definitions/PathItem'
       '^x-': {}
     additionalProperties: false
@@ -681,7 +600,7 @@ definitions:
       '^x-': {}
     minProperties: 1
     additionalProperties: false
- 
+
 
   SecurityRequirement:
     type: object
@@ -719,43 +638,43 @@ definitions:
       '^x-': {}
     additionalProperties: false
 
-  Parameter:
-    oneOf:
-      - $ref: '#/definitions/ParameterWithSchema'
-      - $ref: '#/definitions/ParameterWithContent'
-  
-  ParameterWithSchema:
-    oneOf:
-      - $ref: '#/definitions/ParameterWithSchemaWithExample'
-      - $ref: '#/definitions/ParameterWithSchemaWithExamples'
+  ExampleXORExamples:
+    description: Example and examples are mutually exclusive
+    not:
+      required: [example, examples]
 
-  ParameterWithSchemaWithExample:
+  SchemaXORContent:
+    description: Schema and content are mutually exclusive, at least one is required
+    not:
+      required: [schema, content]
     oneOf:
-      - $ref: '#/definitions/ParameterWithSchemaWithExampleInPath'
-      - $ref: '#/definitions/ParameterWithSchemaWithExampleInQuery'
-      - $ref: '#/definitions/ParameterWithSchemaWithExampleInHeader'
-      - $ref: '#/definitions/ParameterWithSchemaWithExampleInCookie'
+      - required: [schema]
+      - required: [content]
+        description: Some properties are not allowed if content is present
+        allOf:
+          - not:
+              required: [style]
+          - not:
+              required: [explode]
+          - not:
+              required: [allowReserved]
+          - not:
+              required: [example]
+          - not:
+              required: [examples]
 
-  ParameterWithSchemaWithExampleInPath:
+  Parameter:
     type: object
-    required:
-      - name
-      - in
-      - schema
-      - required
     properties:
       name:
         type: string
       in:
         type: string
-        enum:
-          - path
       description:
         type: string
       required:
         type: boolean
-        enum:
-          - true
+        default: false
       deprecated:
         type: boolean
         default: false
@@ -764,11 +683,6 @@ definitions:
         default: false
       style:
         type: string
-        enum:
-          - matrix
-          - label
-          - simple
-        default: simple
       explode:
         type: boolean
       allowReserved:
@@ -778,526 +692,158 @@ definitions:
         oneOf:
           - $ref: '#/definitions/Schema'
           - $ref: '#/definitions/SchemaReference'
+      content:
+        type: object
+        additionalProperties:
+          $ref: '#/definitions/MediaType'
+        minProperties: 1
+        maxProperties: 1
       example: {}
+      examples:
+        type: object
+        additionalProperties:
+          oneOf:
+            - $ref: '#/definitions/Example'
+            - $ref: '#/definitions/Reference'
     patternProperties:
       '^x-': {}
     additionalProperties: false
-
-  ParameterWithSchemaWithExampleInQuery:
-    type: object
     required:
       - name
       - in
-      - schema
+    allOf:
+      - $ref: '#/definitions/ExampleXORExamples'
+      - $ref: '#/definitions/SchemaXORContent'
+    oneOf:
+      - $ref: '#/definitions/PathParameter'
+      - $ref: '#/definitions/QueryParameter'
+      - $ref: '#/definitions/HeaderParameter'
+      - $ref: '#/definitions/CookieParameter'
+
+  PathParameter:
+    description: Parameter in path
+    required:
+      - required
     properties:
-      name:
-        type: string
       in:
-        type: string
-        enum:
-          - query
-      description:
-        type: string
+        enum: [path]
+      style:
+        enum: [matrix, label, simple]
+        default: simple
       required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
+        enum: [true]
+
+  QueryParameter:
+    description: Parameter in query
+    properties:
+      in:
+        enum: [query]
       style:
-        type: string
-        enum:
-          - form
-          - spaceDelimited
-          - pipeDelimited
-          - deepObject
+        enum: [form, spaceDelimited, pipeDelimited, deepObject]
         default: form
-      explode:
-        type: boolean
-      allowReserved:
+
+  HeaderParameter:
+    description: Parameter in header
+    properties:
+      in:
+        enum: [header]
+      style:
+        enum: [simple]
+        default: simple
+
+  CookieParameter:
+    description: Parameter in cookie
+    properties:
+      in:
+        enum: [cookie]
+      style:
+        enum: [form]
+        default: form
+
+  RequestBody:
+    type: object
+    required:
+      - content
+    properties:
+      description:
+        type: string
+      content:
+        type: object
+        additionalProperties:
+          $ref: '#/definitions/MediaType'
+      required:
         type: boolean
         default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
-      example: {}
     patternProperties:
       '^x-': {}
-    additionalProperties: false    
+    additionalProperties: false
+
+  SecurityScheme:
+    oneOf:
+      - $ref: '#/definitions/APIKeySecurityScheme'
+      - $ref: '#/definitions/HTTPSecurityScheme'
+      - $ref: '#/definitions/OAuth2SecurityScheme'
+      - $ref: '#/definitions/OpenIdConnectSecurityScheme'
 
-  ParameterWithSchemaWithExampleInHeader:
+  APIKeySecurityScheme:
     type: object
     required:
+      - type
       - name
       - in
-      - schema
     properties:
+      type:
+        type: string
+        enum:
+          - apiKey
       name:
         type: string
       in:
         type: string
         enum:
           - header
+          - query
+          - cookie
       description:
         type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      style:
-        type: string
-        enum:
-          - simple
-        default: simple
-      explode:
-        type: boolean
-      allowReserved:
-        type: boolean
-        default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
-      example: {}
     patternProperties:
       '^x-': {}
-    additionalProperties: false    
+    additionalProperties: false
 
-  ParameterWithSchemaWithExampleInCookie:
+  HTTPSecurityScheme:
     type: object
     required:
-      - name
-      - in
-      - schema
+      - scheme
+      - type
     properties:
-      name:
+      scheme:
         type: string
-      in:
+      bearerFormat:
         type: string
-        enum:
-          - cookie
       description:
         type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      style:
+      type:
         type: string
         enum:
-          - form
-        default: form
-      explode:
-        type: boolean
-      allowReserved:
-        type: boolean
-        default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
-      example: {}
+          - http
     patternProperties:
       '^x-': {}
-    additionalProperties: false  
-
-  ParameterWithSchemaWithExamples:
+    additionalProperties: false
     oneOf:
-      - $ref: '#/definitions/ParameterWithSchemaWithExamplesInPath'
-      - $ref: '#/definitions/ParameterWithSchemaWithExamplesInQuery'
-      - $ref: '#/definitions/ParameterWithSchemaWithExamplesInHeader'
-      - $ref: '#/definitions/ParameterWithSchemaWithExamplesInCookie'
+      - description: Bearer
+        properties:
+          scheme:
+            type: string
+            pattern: ^[Bb][Ee][Aa][Rr][Ee][Rr]$
 
-  ParameterWithSchemaWithExamplesInPath:
-    type: object
-    required:
-      - name
-      - in
-      - schema
-      - required
-      - examples
-    properties:
-      name:
-        type: string
-      in:
-        type: string
-        enum:
-          - path
-      description:
-        type: string
-      required:
-        type: boolean
-        enum:
-          - true
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      style:
-        type: string
-        enum:
-          - matrix
-          - label
-          - simple
-        default: simple
-      explode:
-        type: boolean
-      allowReserved:
-        type: boolean
-        default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
-      examples:
-        type: object
-        additionalProperties:
-          oneOf:
-            - $ref: '#/definitions/Example'
-            - $ref: '#/definitions/SchemaReference'
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
-
-  ParameterWithSchemaWithExamplesInQuery:
-    type: object
-    required:
-      - name
-      - in
-      - schema
-      - examples
-    properties:
-      name:
-        type: string
-      in:
-        type: string
-        enum:
-          - query
-      description:
-        type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      style:
-        type: string
-        enum:
-          - form
-          - spaceDelimited
-          - pipeDelimited
-          - deepObject
-        default: form
-      explode:
-        type: boolean
-      allowReserved:
-        type: boolean
-        default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
-      examples:
-        type: object
-        additionalProperties:
-          oneOf:
-            - $ref: '#/definitions/Example'
-            - $ref: '#/definitions/SchemaReference'
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false    
-
-  ParameterWithSchemaWithExamplesInHeader:
-    type: object
-    required:
-      - name
-      - in
-      - schema
-      - examples
-    properties:
-      name:
-        type: string
-      in:
-        type: string
-        enum:
-          - header
-      description:
-        type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      style:
-        type: string
-        enum:
-          - simple
-        default: simple
-      explode:
-        type: boolean
-      allowReserved:
-        type: boolean
-        default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
-      examples:
-        type: object
-        additionalProperties:
-          oneOf:
-            - $ref: '#/definitions/Example'
-            - $ref: '#/definitions/Reference'
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false    
-
-  ParameterWithSchemaWithExamplesInCookie:
-    type: object
-    required:
-      - name
-      - in
-      - schema
-      - examples
-    properties:
-      name:
-        type: string
-      in:
-        type: string
-        enum:
-          - cookie
-      description:
-        type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      style:
-        type: string
-        enum:
-          - form
-        default: form
-      explode:
-        type: boolean
-      allowReserved:
-        type: boolean
-        default: false
-      schema:
-        oneOf:
-          - $ref: '#/definitions/Schema'
-          - $ref: '#/definitions/SchemaReference'
-      examples:
-        type: object
-        additionalProperties:
-          oneOf:
-            - $ref: '#/definitions/Example'
-            - $ref: '#/definitions/Reference'
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
-
-  ParameterWithContent:
-    oneOf:
-      - $ref: '#/definitions/ParameterWithContentInPath'
-      - $ref: '#/definitions/ParameterWithContentNotInPath'
-
-  ParameterWithContentInPath:
-    type: object
-    required:
-      - name
-      - in
-      - content
-    properties:
-      name:
-        type: string
-      in:
-        type: string
-        enum:
-          - path
-      description:
-        type: string
-      required:
-        type: boolean
-        enum:
-          - true
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      content:
-        type: object
-        additionalProperties:
-          $ref: '#/definitions/MediaType'
-        minProperties: 1
-        maxProperties: 1
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
-
-  ParameterWithContentNotInPath:
-    type: object
-    required:
-      - name
-      - in
-      - content
-    properties:
-      name:
-        type: string
-      in:
-        type: string
-        enum:
-          - query
-          - header
-          - cookie
-      description:
-        type: string
-      required:
-        type: boolean
-        default: false
-      deprecated:
-        type: boolean
-        default: false
-      allowEmptyValue:
-        type: boolean
-        default: false
-      content:
-        type: object
-        additionalProperties:
-          $ref: '#/definitions/MediaType'
-        minProperties: 1
-        maxProperties: 1
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
-
-  RequestBody:
-    type: object
-    required:
-      - content
-    properties:
-      description:
-        type: string
-      content:
-        type: object
-        additionalProperties:
-          $ref: '#/definitions/MediaType'
-      required:
-        type: boolean
-        default: false
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
-
-  SecurityScheme:
-    oneOf:
-      - $ref: '#/definitions/APIKeySecurityScheme'
-      - $ref: '#/definitions/HTTPSecurityScheme'
-      - $ref: '#/definitions/OAuth2SecurityScheme'
-      - $ref: '#/definitions/OpenIdConnectSecurityScheme'
-  
-  APIKeySecurityScheme:
-    type: object
-    required:
-      - type
-      - name
-      - in
-    properties:
-      type:
-        type: string
-        enum:
-          - apiKey      
-      name:
-        type: string
-      in:
-        type: string
-        enum:
-          - header
-          - query
-          - cookie
-      description:
-        type: string
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
-  
-  HTTPSecurityScheme:
-    oneOf:
-      - $ref: '#/definitions/NonBearerHTTPSecurityScheme'
-      - $ref: '#/definitions/BearerHTTPSecurityScheme'
-
-  NonBearerHTTPSecurityScheme:
-    type: object
-    required:
-      - scheme
-      - type
-    properties:
-      scheme:
-        type: string
+      - description: Non Bearer
         not:
-          enum:
-            - bearer
-      description:
-        type: string
-      type:
-        type: string
-        enum:
-          - http
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
-
-  BearerHTTPSecurityScheme:
-    type: object
-    required:
-      - type
-      - scheme
-    properties:
-      scheme:
-        type: string
-        enum:
-          - bearer
-      bearerFormat:
-        type: string
-      type:
-        type: string
-        enum:
-          - http
-      description:
-        type: string
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
+          required: [bearerFormat]
+        properties:
+          scheme:
+            not:
+              type: string
+              pattern: ^[Bb][Ee][Aa][Rr][Ee][Rr]$
 
   OAuth2SecurityScheme:
     type: object
@@ -1326,7 +872,7 @@ definitions:
       type:
         type: string
         enum:
-          - openIdConnect      
+          - openIdConnect
       openIdConnectUrl:
         type: string
         format: uri-reference
@@ -1375,6 +921,7 @@ definitions:
     type: object
     required:
       - tokenUrl
+      - scopes
     properties:
       tokenUrl:
         type: string
@@ -1394,6 +941,7 @@ definitions:
     type: object
     required:
       - tokenUrl
+      - scopes
     properties:
       tokenUrl:
         type: string
@@ -1414,6 +962,7 @@ definitions:
     required:
       - authorizationUrl
       - tokenUrl
+      - scopes
     properties:
       authorizationUrl:
         type: string
@@ -1433,13 +982,10 @@ definitions:
     additionalProperties: false
 
   Link:
-    oneOf:
-      - $ref: '#/definitions/LinkWithOperationRef'
-      - $ref: '#/definitions/LinkWithOperationId'
-
-  LinkWithOperationRef:
     type: object
     properties:
+      operationId:
+        type: string
       operationRef:
         type: string
         format: uri-reference
@@ -1454,23 +1000,9 @@ definitions:
     patternProperties:
       '^x-': {}
     additionalProperties: false
-
-  LinkWithOperationId:
-    type: object
-    properties:
-      operationId:
-        type: string
-      parameters:
-        type: object
-        additionalProperties: {}
-      requestBody: {}
-      description:
-        type: string
-      server:
-        $ref: '#/definitions/Server'
-    patternProperties:
-      '^x-': {}
-    additionalProperties: false
+    not:
+      description: Operation Id and Operation Ref are mutually exclusive
+      required: [operationId, operationRef]
 
   Callback:
     type: object
@@ -1487,7 +1019,9 @@ definitions:
       headers:
         type: object
         additionalProperties:
-          $ref: '#/definitions/Header'
+          oneOf:
+            - $ref: '#/definitions/Header'
+            - $ref: '#/definitions/Reference'
       style:
         type: string
         enum:
@@ -1500,4 +1034,6 @@ definitions:
       allowReserved:
         type: boolean
         default: false
+    patternProperties:
+      '^x-': {}
     additionalProperties: false