├── .eslintrc ├── .gitattributes ├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── data ├── 2.0 │ ├── Contact_Object.yaml │ ├── Definitions_Object.yaml │ ├── Example_Object.yaml │ ├── External_Documentation_Object.yaml │ ├── Header_Object.yaml │ ├── Header_Object_Array.yaml │ ├── Header_Object_Not_Array.yaml │ ├── Header_Object_Number_Or_Integer.yaml │ ├── Header_Object_String.yaml │ ├── Headers_Object.yaml │ ├── Info_Object.yaml │ ├── Licence_Object.yaml │ ├── Operation_Object.yaml │ ├── Parameter_Object.yaml │ ├── Parameter_Object_Array.yaml │ ├── Parameter_Object_Body.yaml │ ├── Parameter_Object_File.yaml │ ├── Parameter_Object_Not_Array_Or_File.yaml │ ├── Parameter_Object_Not_Body.yaml │ ├── Parameter_Object_Number_Or_Integer.yaml │ ├── Parameter_Object_String.yaml │ ├── Parameters_Definition_Object.yaml │ ├── Path_Item_Object.yaml │ ├── Paths_Object.yaml │ ├── Reference_Object.yaml │ ├── Response_Object.yaml │ ├── Responses_Definitions_Object.yaml │ ├── Responses_Object.yaml │ ├── Schema_Object.yaml │ ├── Schema_Object_Array.yaml │ ├── Schema_Object_Number_Or_Integer.yaml │ ├── Schema_Object_Object.yaml │ ├── Schema_Object_OpenAPI.yaml │ ├── Schema_Object_String.yaml │ ├── Scopes_Object.yaml │ ├── Security_Definitions_Object.yaml │ ├── Security_Requirement_Object.yaml │ ├── Security_Scheme_Object.yaml │ ├── Security_Scheme_Object_ApiKey.yaml │ ├── Security_Scheme_Object_Oauth.yaml │ ├── Specification_Extensions.yaml │ ├── Swagger_Object.yaml │ └── Tag_Object.yaml ├── 3.0.0-rc0 │ ├── Callback_Object.yaml │ ├── Callbacks_Object.yaml │ ├── Components_Callbacks_Map.yaml │ ├── Components_Examples_Map.yaml │ ├── Components_Headers_Map.yaml │ ├── Components_Links_Map.yaml │ ├── Components_Object.yaml │ ├── Components_Parameters_Map.yaml │ ├── Components_Request_Bodies_Map.yaml │ ├── Components_Responses_Map.yaml │ ├── Components_Schemas_Map.yaml │ ├── Components_Security_Schemes_Map.yaml │ ├── Contact_Object.yaml │ ├── Content_Object.yaml │ ├── Encoding_Object.yaml │ ├── Encoding_Property_Object.yaml │ ├── Example_Object.yaml │ ├── External_Documentation_Object.yaml │ ├── Header_Object.yaml │ ├── Headers_Object.yaml │ ├── Info_Object.yaml │ ├── Licence_Object.yaml │ ├── Link_Object.yaml │ ├── Link_Parameters_Object.yaml │ ├── Links_Object.yaml │ ├── Media_Type_Object.yaml │ ├── OAuth_Flow_Object.yaml │ ├── OAuth_Flows_Object.yaml │ ├── OpenAPI_Object.yaml │ ├── Operation_Object.yaml │ ├── Parameter_Object.yaml │ ├── Parameter_Object_Content.yaml │ ├── Parameter_Object_Style_Schema.yaml │ ├── Path_Item_Object.yaml │ ├── Paths_Object.yaml │ ├── Reference_Object.yaml │ ├── Request_Body_Object.yaml │ ├── Response_Object.yaml │ ├── Responses_Object.yaml │ ├── Schema_Object.yaml │ ├── Schema_Object_Array.yaml │ ├── Schema_Object_JSON.yaml │ ├── Schema_Object_Modified_JSON.yaml │ ├── Schema_Object_Number_Or_Integer.yaml │ ├── Schema_Object_Object.yaml │ ├── Schema_Object_OpenAPI.yaml │ ├── Schema_Object_String.yaml │ ├── Scopes_Object.yaml │ ├── Security_Requirement_Object.yaml │ ├── Security_Scheme_Object.yaml │ ├── Server_Object.yaml │ ├── Server_Variable_Object.yaml │ ├── Server_Variables_Object.yaml │ ├── Specification_Extensions.yaml │ ├── Tag_Object.yaml │ └── Z_Object.yaml ├── 3.0.1 │ ├── Callback_Object.yaml │ ├── Components_Object.yaml │ ├── Contact_Object.yaml │ ├── Discriminator_Object.yaml │ ├── Encoding_Object.yaml │ ├── Example_Object.yaml │ ├── External_Documentation_Object.yaml │ ├── Header_Object.yaml │ ├── Header_Object_Content.yaml │ ├── Header_Object_Style_Schema.yaml │ ├── Info_Object.yaml │ ├── Licence_Object.yaml │ ├── Link_Object.yaml │ ├── Media_Type_Object.yaml │ ├── OpenAPI_Object.yaml │ ├── Operation_Object.yaml │ ├── Parameter_Object.yaml │ ├── Parameter_Object_Content.yaml │ ├── Parameter_Object_Style_Schema.yaml │ ├── Path_Item_Object.yaml │ ├── Paths_Object.yaml │ ├── Reference_Object.yaml │ ├── Request_Body_Object.yaml │ ├── Response_Object.yaml │ ├── Responses_Object.yaml │ ├── Schema_Object.yaml │ ├── Schema_Object_Array.yaml │ ├── Schema_Object_Composition_Inheritance.yaml │ ├── Schema_Object_JSON.yaml │ ├── Schema_Object_Number_Or_Integer.yaml │ ├── Schema_Object_Object.yaml │ ├── Schema_Object_OpenAPI.yaml │ ├── Schema_Object_String.yaml │ ├── Security_Requirement_Object.yaml │ ├── Server_Object.yaml │ ├── Server_Variable_Object.yaml │ ├── Specification_Extensions.yaml │ ├── Tag_Object.yaml │ ├── XML_Object.yaml │ └── Z_Object.yaml └── spec-versions.json ├── gulpfile.js ├── package-lock.json ├── package.json ├── scripts └── deploy.sh ├── test └── buildTree.js └── web ├── static ├── CNAME ├── css │ ├── bootstrap.min.css │ ├── main.css │ └── tree.css ├── fonts │ ├── fontawesome-webfont.eot │ ├── fontawesome-webfont.svg │ ├── fontawesome-webfont.ttf │ ├── fontawesome-webfont.woff │ └── fontawesome-webfont.woff2 ├── handlebars.min.js ├── images │ ├── forkme.png │ ├── icons │ │ ├── apple-touch-icon-114x114.png │ │ ├── apple-touch-icon-120x120.png │ │ ├── apple-touch-icon-144x144.png │ │ ├── apple-touch-icon-152x152.png │ │ ├── apple-touch-icon-57x57.png │ │ ├── apple-touch-icon-60x60.png │ │ ├── apple-touch-icon-72x72.png │ │ ├── apple-touch-icon-76x76.png │ │ ├── favicon-128.png │ │ ├── favicon-16x16.png │ │ ├── favicon-196x196.png │ │ ├── favicon-32x32.png │ │ ├── favicon-96x96.png │ │ ├── favicon.ico │ │ ├── mstile-144x144.png │ │ ├── mstile-150x150.png │ │ ├── mstile-310x150.png │ │ ├── mstile-310x310.png │ │ └── mstile-70x70.png │ └── markdown.png ├── index.html └── js │ ├── bootstrap.min.js │ ├── buildTree.js │ ├── d3.min.js │ ├── drawTree.js │ ├── fingerprint2.min.js │ ├── handlebars.min.js │ ├── jquery.min.js │ ├── main.js │ └── marked.min.js └── templates └── tooltip.hbs /.eslintrc: -------------------------------------------------------------------------------- 1 | extends: google 2 | env: 3 | browser: true 4 | node: true 5 | mocha: true 6 | rules: 7 | quotes: 8 | - 2 9 | - single 10 | brace-style: 11 | - 2 12 | - stroustrup -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | .vscode -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | 3 | node_js: 4 | - 6 5 | 6 | cache: bundler 7 | 8 | branches: 9 | only: 10 | - master 11 | 12 | env: 13 | global: 14 | - DEPLOY_BRANCH=gh-pages 15 | - BUILD_TARGET=dist 16 | 17 | before_script: 18 | - npm install -g gulp-cli 19 | - npm install -g mocha 20 | script: npm run build 21 | 22 | deploy: 23 | provider: script 24 | skip_cleanup: true 25 | script: scripts/deploy.sh 26 | on: 27 | branch: master -------------------------------------------------------------------------------- /data/2.0/Contact_Object.yaml: -------------------------------------------------------------------------------- 1 | Contact Object: 2 | description: Contact information for the exposed API. 3 | allowExtension: true 4 | fields: 5 | - name: name 6 | type: string 7 | description: The identifying name of the contact person/organization. 8 | - name: url 9 | type: string 10 | description: | 11 | The URL pointing to the contact information. 12 | MUST be in the format of a URL. 13 | - name: email 14 | type: string 15 | description: | 16 | The email address of the contact person/organization. 17 | MUST be in the format of an email address. 18 | -------------------------------------------------------------------------------- /data/2.0/Definitions_Object.yaml: -------------------------------------------------------------------------------- 1 | Definitions Object: 2 | description: An object to hold data types that can be consumed and produced by operations. These data types can be primitives, arrays or models. 3 | fields: 4 | - 5 | name: "{name}" 6 | type: Schema Object 7 | description: A single definition, mapping a *name* to the schema it defines. 8 | patterned: true 9 | -------------------------------------------------------------------------------- /data/2.0/Example_Object.yaml: -------------------------------------------------------------------------------- 1 | Example Object: 2 | description: Allows sharing examples for operation responses. 3 | fields: 4 | - name: "{mime type}" 5 | type: Any 6 | description: | 7 | The name of the property MUST be one of the Operation produces values (either implicit or inherited). 8 | The value SHOULD be an example of what such a response would look like. -------------------------------------------------------------------------------- /data/2.0/External_Documentation_Object.yaml: -------------------------------------------------------------------------------- 1 | External Documentation Object: 2 | description: Allows referencing an external resource for extended documentation. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: description 7 | type: string 8 | description: A short description of the target documentation. 9 | md: GFM 10 | - 11 | name: url 12 | type: string 13 | description: | 14 | The URL for the target documentation. 15 | Value MUST be in the format of a URL. 16 | required: true 17 | -------------------------------------------------------------------------------- /data/2.0/Header_Object.yaml: -------------------------------------------------------------------------------- 1 | Header Object: 2 | fields: 3 | - 4 | name: description 5 | type: string 6 | description: A short description of the header. 7 | - 8 | name: type 9 | type: string 10 | description: The type of the object. 11 | values: 12 | - value: string 13 | - value: number 14 | - value: integer 15 | - value: boolean 16 | - value: array 17 | - 18 | name: default 19 | type: "*" 20 | description: | 21 | Declares the value of the header that the server will use if none is provided. 22 | (Note: "default" has no meaning for required headers.) 23 | See http://json-schema.org/latest/json-schema-validation.html#anchor101. 24 | Unlike JSON Schema this value MUST conform to the defined type for the header. 25 | - 26 | name: 27 | type: Header Object Array 28 | description: Fields if *type* is *array*. 29 | - 30 | name: 31 | type: Header Object Not Array 32 | description: Fields if *type* is *string*, *number*, *integer* or *boolean*. -------------------------------------------------------------------------------- /data/2.0/Header_Object_Array.yaml: -------------------------------------------------------------------------------- 1 | Header Object Array: 2 | description: Fields if *type* is *array*. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: items 7 | type: Items Object 8 | description: Describes the type of items in the array. 9 | - 10 | name: collectionFormat 11 | type: string 12 | description: | 13 | Determines the format of the array if type array is used. 14 | values: 15 | - 16 | value: csv 17 | description: Comma separated values *foo,bar*. 18 | default: true 19 | - 20 | value: ssv 21 | description: Space separated values *foo bar*. 22 | - 23 | value: tsv 24 | description: Tab separated values *foo\\tbar*. 25 | - 26 | value: pipes 27 | description: Pipe separated values *foo|bar*. 28 | - 29 | value: multi 30 | description: | 31 | Corresponds to multiple parameter instances instead of multiple values for a single instance *foo=bar&foo=baz*. 32 | This is valid only for parameters in *query* or *formData*. 33 | - 34 | name: maxItems 35 | type: number 36 | description: Maximum count of items in array 37 | - 38 | name: minItems 39 | type: number 40 | description: Minimum count of items in array. 41 | - 42 | name: uniqueItems 43 | type: boolean 44 | description: Allow only unique items in array. 45 | -------------------------------------------------------------------------------- /data/2.0/Header_Object_Not_Array.yaml: -------------------------------------------------------------------------------- 1 | Header Object Not Array: 2 | description: Fields if *type* is *string*, *number*, *integer* or *boolean*. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: format 7 | type: string 8 | description: | 9 | The extending format for the previously mentioned type. 10 | See Data Type Formats for further details. 11 | 12 | Common Name | type | format| Comments 13 | ------------|------|-------|--------- 14 | integer | integer | int32 | signed 32 bits 15 | long | integer | int64 | signed 64 bits 16 | float | number | float | 17 | double | number | double| 18 | string | string | | 19 | byte | string | byte | base64 encoded characters 20 | binary | string | binary| any sequence of octets 21 | boolean | boolean | | 22 | date | string | date | As defined by full-date - RFC3339 23 | dateTime | string | date-time | As defined by date-time - RFC3339 24 | password | string | password | Used to hint UIs the input needs to be obscured. 25 | - 26 | name: 27 | type: Header Object String 28 | description: Fields if *type* is *string*. 29 | - 30 | name: 31 | type: Header Object Number Or Integer 32 | description: Fields if *type* is *number* or *integer*. 33 | - 34 | name: enum 35 | type: "[*]" 36 | description: | 37 | Authorized values. 38 | See http://json-schema.org/latest/json-schema-validation.html#anchor76. 39 | -------------------------------------------------------------------------------- /data/2.0/Header_Object_Number_Or_Integer.yaml: -------------------------------------------------------------------------------- 1 | Header Object Number Or Integer: 2 | description: A number or integer header 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: maximum 7 | type: number 8 | description: | 9 | Maximum value. 10 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 11 | - 12 | name: exclusiveMaximum 13 | type: boolean 14 | description: | 15 | Indicate if the value must be < maximum. 16 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 17 | - 18 | name: minimum 19 | type: number 20 | description: | 21 | Minimum value. 22 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 23 | - 24 | name: exclusiveMinimum 25 | type: boolean 26 | description: | 27 | Indicate if the value must value > minimum. 28 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 29 | - 30 | name: multipleOf 31 | type: number 32 | description: | 33 | The value must be a multiple of *multiplOf*. 34 | See http://json-schema.org/latest/json-schema-validation.html#anchor14. 35 | -------------------------------------------------------------------------------- /data/2.0/Header_Object_String.yaml: -------------------------------------------------------------------------------- 1 | Header Object String: 2 | description: A string header 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: pattern 7 | type: string 8 | description: | 9 | This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. 10 | See http://json-schema.org/latest/json-schema-validation.html#anchor33. 11 | See https://regex101.com/ 12 | - 13 | name: maxLength 14 | type: integer 15 | description: | 16 | Maximum string's length. 17 | See http://json-schema.org/latest/json-schema-validation.html#anchor26. 18 | - 19 | name: minLength 20 | type: integer 21 | description: | 22 | Minimum string's length. 23 | See http://json-schema.org/latest/json-schema-validation.html#anchor29. 24 | -------------------------------------------------------------------------------- /data/2.0/Headers_Object.yaml: -------------------------------------------------------------------------------- 1 | Headers Object: 2 | description: The name of the property corresponds to the name of the header. The value describes the type of the header. 3 | fields: 4 | - 5 | name: "{name}" 6 | patterned: true 7 | type: Header Object 8 | description: | 9 | The name of the property corresponds to the name of the header. 10 | The value describes the type of the header. 11 | -------------------------------------------------------------------------------- /data/2.0/Info_Object.yaml: -------------------------------------------------------------------------------- 1 | Info Object: 2 | description: Provides metadata about the API. The metadata can be used by the clients if needed. 3 | allowExtension: true 4 | fields: 5 | - name: title 6 | type: string 7 | required: true 8 | description: The title of the application. 9 | - name: description 10 | type: string 11 | md: GFM 12 | description: A short description of the application. 13 | - name: termsOfService 14 | type: string 15 | description: The Terms of Service for the API. 16 | - name: contact 17 | type: Contact Object 18 | description: The contact information for the exposed API. 19 | - name: licence 20 | type: Licence Object 21 | description: The license information for the exposed API. 22 | - name: version 23 | type: string 24 | required: true 25 | description: Provides the version of the application API (not to be confused with the specification version). 26 | -------------------------------------------------------------------------------- /data/2.0/Licence_Object.yaml: -------------------------------------------------------------------------------- 1 | Licence Object: 2 | description: License information for the exposed API. 3 | allowExtension: true 4 | fields: 5 | - name: name 6 | type: string 7 | required: true 8 | description: The license name used for the API. 9 | - 10 | name: url 11 | type: string 12 | description: | 13 | A URL to the license used for the API. 14 | MUST be in the format of a URL. 15 | -------------------------------------------------------------------------------- /data/2.0/Operation_Object.yaml: -------------------------------------------------------------------------------- 1 | Operation Object: 2 | description: Describes a single API operation on a path. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: tags 7 | type: "[string]" 8 | description: | 9 | A list of tags for API documentation control. 10 | Tags can be used for logical grouping of operations by resources or any other qualifier. 11 | - 12 | name: summary 13 | type: string 14 | description: | 15 | A short summary of what the operation does. 16 | For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters. 17 | - 18 | name: description 19 | type: string 20 | description: A verbose explanation of the operation behavior. 21 | md: GFM 22 | - 23 | name: externalDocs 24 | type: External Documentation Object 25 | description: Additional external documentation for this operation. 26 | - 27 | name: operationId 28 | type: string 29 | description: | 30 | Unique string used to identify the operation. 31 | The id MUST be unique among all operations described in the API. 32 | Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions. 33 | - 34 | name: consumes 35 | type: "[string]" 36 | description: | 37 | A list of MIME types the operation can consume. 38 | This overrides the consumes definition at the Swagger Object. 39 | An empty value MAY be used to clear the global definition. 40 | Value MUST be as described under Mime Types. 41 | - 42 | name: produces 43 | type: "[string]" 44 | description: | 45 | A list of MIME types the operation can produce. 46 | This overrides the produces definition at the Swagger Object. 47 | An empty value MAY be used to clear the global definition. 48 | Value MUST be as described under Mime Types. 49 | - 50 | name: parameters 51 | type: "[Parameter Object]" 52 | description: | 53 | A list of parameters that are applicable for this operation. 54 | If a parameter is already defined at the Path Item, the new definition will override it, but can never remove it. 55 | The list MUST NOT include duplicated parameters. 56 | A unique parameter is defined by a combination of a name and location. 57 | The list can use the Reference Object to link to parameters that are defined at the Swagger Object's parameters. 58 | There can be one *body* parameter at most. 59 | allowReference: true 60 | - 61 | name: responses 62 | type: Responses Object 63 | required: true 64 | description: The list of possible responses as they are returned from executing this operation. 65 | - 66 | name: schemes 67 | type: "[string]" 68 | description: | 69 | The transfer protocol for the operation. 70 | The value overrides the Swagger Object schemes definition. 71 | values: 72 | - value: http 73 | - value: https 74 | - value: ws 75 | description: Web socket scheme 76 | - value: wss 77 | description: Secured web socket scheme 78 | - 79 | name: deprecated 80 | type: boolean 81 | description: | 82 | Declares this operation to be deprecated. 83 | Usage of the declared operation should be refrained. 84 | Default value is false. 85 | - 86 | name: security 87 | type: "[Security Requirement Object]" 88 | description: | 89 | A declaration of which security schemes are applied for this operation. 90 | The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). 91 | This definition overrides any declared top-level security. 92 | To remove a top-level security declaration, an empty array can be used. 93 | -------------------------------------------------------------------------------- /data/2.0/Parameter_Object.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object: 2 | description: | 3 | Describes a single operation parameter. 4 | A unique parameter is defined by a combination of a name and location (in). 5 | allowExtension: true 6 | fields: 7 | - 8 | name: in 9 | type: string 10 | description: The location of the parameter. 11 | values: 12 | - 13 | value: query 14 | description: "Parameters that are appended to the URL. For example, in */items?id=value*, the query parameter is id." 15 | - 16 | value: header 17 | description: Custom headers that are expected as part of the request. 18 | - 19 | value: path 20 | description: | 21 | Used together with Path Templating, where the parameter value is actually part of the operation's URL. 22 | This does not include the host or base path of the API. 23 | For example, in */items/{itemId}*, the path parameter is itemId. 24 | - 25 | value: formData 26 | description: | 27 | Used to describe the payload of an HTTP request when either *application/x-www-form-urlencoded* or *multipart/form-data* are used as the content type of the request (in OpenAPI's definition, the consumes property of an operation). 28 | This is the only parameter type that can be used to send files, thus supporting the file type. 29 | Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. 30 | Form parameters have a different format based on the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4): 31 | 32 | - application/x-www-form-urlencoded - Similar to the format of Query parameters but as a payload. For example, foo=1&bar=openapi - both foo and bar are form parameters. This is normally used for simple parameters that are being transferred. 33 | - multipart/form-data - Each parameter takes a section in the payload with an internal header. For example, for the header Content-Disposition: form-data; name="submit-name" the name of the parameter is submit-name. This type of form parameters is more commonly used for file transfers. 34 | - 35 | value: body 36 | description: | 37 | The payload that's appended to the HTTP request. 38 | Since there can only be one payload, there can only be one body parameter. 39 | The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. 40 | Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation. 41 | - 42 | name: 43 | type: Parameter Object Body 44 | description: Fields if *in* value is *body*. 45 | - 46 | name: 47 | type: Parameter Object Not Body 48 | description: Fields if *in* value is *query*, *header*, *path* or *formData*. 49 | - 50 | name: description 51 | type: string 52 | md: GFM 53 | description: | 54 | A brief description of the parameter. 55 | This could contain examples of use. 56 | - 57 | name: required 58 | type: boolean 59 | description: | 60 | Determines whether this parameter is mandatory. 61 | If the parameter is in *path*, this property is required and its value MUST be true. 62 | Otherwise, the property MAY be included and its default value is false. 63 | -------------------------------------------------------------------------------- /data/2.0/Parameter_Object_Array.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Array: 2 | description:: Fields if parameter type is array. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: items 7 | type: Items Object 8 | description: Describes the type of items in the array. 9 | - 10 | name: collectionFormat 11 | type: string 12 | description: | 13 | Determines the format of the array if type array is used. 14 | values: 15 | - 16 | value: csv 17 | description: Comma separated values *foo,bar*. 18 | default: true 19 | - 20 | value: ssv 21 | description: Space separated values *foo bar*. 22 | - 23 | value: tsv 24 | description: Tab separated values *foo\\tbar*. 25 | - 26 | value: pipes 27 | description: Pipe separated values *foo|bar*. 28 | - 29 | value: multi 30 | description: | 31 | Corresponds to multiple parameter instances instead of multiple values for a single instance *foo=bar&foo=baz*. 32 | This is valid only for parameters in *query* or *formData*. 33 | - 34 | name: maxItems 35 | type: number 36 | description: Maximum count of items in array 37 | - 38 | name: minItems 39 | type: number 40 | description: Minimum count of items in array. 41 | - 42 | name: uniqueItems 43 | type: boolean 44 | description: Allow only unique items in array. 45 | -------------------------------------------------------------------------------- /data/2.0/Parameter_Object_Body.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Body: 2 | description: Fields if *in* value is *body*. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: body 7 | required: true 8 | type: Schema Object 9 | description: The schema defining the type used for the body parameter. 10 | -------------------------------------------------------------------------------- /data/2.0/Parameter_Object_File.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object File: 2 | description: A File parameter 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: maxLength 7 | type: integer 8 | description: See http://json-schema.org/latest/json-schema-validation.html#anchor26. 9 | - 10 | name: minLength 11 | type: integer 12 | description: See http://json-schema.org/latest/json-schema-validation.html#anchor29. 13 | -------------------------------------------------------------------------------- /data/2.0/Parameter_Object_Not_Array_Or_File.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Not Array Or File: 2 | description: Fields if *type* value is *string*, *number*, *integer* or *boolean*. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: format 7 | type: string 8 | description: | 9 | The extending format for the previously mentioned type. 10 | See Data Type Formats for further details. 11 | 12 | Common Name | type | format| Comments 13 | ------------|------|-------|--------- 14 | integer | integer | int32 | signed 32 bits 15 | long | integer | int64 | signed 64 bits 16 | float | number | float | 17 | double | number | double| 18 | string | string | | 19 | byte | string | byte | base64 encoded characters 20 | binary | string | binary| any sequence of octets 21 | boolean | boolean | | 22 | date | string | date | As defined by full-date - RFC3339 23 | dateTime | string | date-time | As defined by date-time - RFC3339 24 | password | string | password | Used to hint UIs the input needs to be obscured. 25 | - 26 | name: allowEmptyValue 27 | type: boolean 28 | description: | 29 | Sets the ability to pass empty-valued parameters. 30 | This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value. 31 | Default value is false. 32 | - 33 | name: 34 | type: Parameter Object String 35 | description: Fields if *type* is *string*. 36 | - 37 | name: 38 | type: Parameter Object Number Or Integer 39 | description: Fields if *type* is *number* or *integer*. 40 | - 41 | name: enum 42 | type: "[Any]" 43 | description: | 44 | Authorized values. 45 | See http://json-schema.org/latest/json-schema-validation.html#anchor76. 46 | -------------------------------------------------------------------------------- /data/2.0/Parameter_Object_Not_Body.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Not Body: 2 | description: Fields if *in* value is *query*, *header*, *path* or *formData*. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: type 7 | type: string 8 | description: | 9 | The type of the parameter. 10 | Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). 11 | values: 12 | - value: string 13 | - value: number 14 | - value: integer 15 | - value: boolean 16 | - value: array 17 | - value: file 18 | description: If type is *file*, the consumes MUST be either *multipart/form-data* or *application/x-www-form-urlencoded* and the parameter MUST be in *formData*. 19 | - 20 | name: 21 | type: Parameter Object Array 22 | description: Fields if *type* value is *array*. 23 | - 24 | name: 25 | type: Parameter Object File 26 | description: Fields if *type* value is *file*. 27 | - 28 | name: 29 | type: Parameter Object Not Array Or File 30 | description: Fields if *type* value is *string*, *number*, *integer* or *boolean*. 31 | - 32 | name: default 33 | type: "*" 34 | description: | 35 | Declares the value of the parameter that the server will use if none is provided. 36 | For example a *count* to control the number of results per page might default to 100 if not supplied by the client in the request. 37 | (Note: *default* has no meaning for required parameters.) 38 | Unlike JSON Schema this value MUST conform to the defined type for this parameter. 39 | See http://json-schema.org/latest/json-schema-validation.html#anchor101. -------------------------------------------------------------------------------- /data/2.0/Parameter_Object_Number_Or_Integer.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Number Or Integer: 2 | description: A number or integer parameter 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: maximum 7 | type: number 8 | description: | 9 | Maximum value. 10 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 11 | - 12 | name: exclusiveMaximum 13 | type: boolean 14 | description: | 15 | Indicate if the value must be < maximum. 16 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 17 | - 18 | name: minimum 19 | type: number 20 | description: | 21 | Minimum value. 22 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 23 | - 24 | name: exclusiveMinimum 25 | type: boolean 26 | description: | 27 | Indicate if the value must value > minimum. 28 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 29 | - 30 | name: multipleOf 31 | type: number 32 | description: | 33 | The value must be a multiple of *multiplOf*. 34 | See http://json-schema.org/latest/json-schema-validation.html#anchor14. 35 | -------------------------------------------------------------------------------- /data/2.0/Parameter_Object_String.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object String: 2 | description: A string parameter 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: pattern 7 | type: string 8 | description: | 9 | This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. 10 | See http://json-schema.org/latest/json-schema-validation.html#anchor33. 11 | See https://regex101.com/ 12 | - 13 | name: maxLength 14 | type: integer 15 | description: | 16 | Maximum string's length. 17 | See http://json-schema.org/latest/json-schema-validation.html#anchor26. 18 | - 19 | name: minLength 20 | type: integer 21 | description: | 22 | Minimum string's length. 23 | See http://json-schema.org/latest/json-schema-validation.html#anchor29. 24 | -------------------------------------------------------------------------------- /data/2.0/Parameters_Definition_Object.yaml: -------------------------------------------------------------------------------- 1 | Parameters Definitions Object: 2 | description: 3 | fields: 4 | - 5 | name: "{name}" 6 | type: Parameter Object 7 | description: A single parameter definition, mapping a *name* to the parameter it defines. 8 | patterned: true 9 | -------------------------------------------------------------------------------- /data/2.0/Path_Item_Object.yaml: -------------------------------------------------------------------------------- 1 | Path Item Object: 2 | description: | 3 | Describes the operations available on a single path. 4 | A Path Item may be empty, due to ACL constraints. 5 | The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available. 6 | allowExtension: true 7 | fields: 8 | - 9 | name: $ref 10 | type: string 11 | description: | 12 | Allows for an external definition of this path item. 13 | The referenced structure MUST be in the format of a Path Item Object. 14 | If there are conflicts between the referenced definition and this Path Item's definition, the behavior is undefined. 15 | - 16 | name: get 17 | type: Operation Object 18 | description: A definition of a GET operation on this path. 19 | - 20 | name: put 21 | type: Operation Object 22 | description: A definition of a PUT operation on this path. 23 | - 24 | name: post 25 | type: Operation Object 26 | description: A definition of a POST operation on this path. 27 | - 28 | name: delete 29 | type: Operation Object 30 | description: A definition of a DELETE operation on this path. 31 | - 32 | name: options 33 | type: Operation Object 34 | description: A definition of a OPTIONS operation on this path. 35 | - 36 | name: head 37 | type: Operation Object 38 | description: A definition of a HEAD operation on this path. 39 | - 40 | name: patch 41 | type: Operation Object 42 | description: A definition of a PATCH operation on this path. 43 | - 44 | name: parameters 45 | type: "[Parameter Object]" 46 | allowReference: true 47 | description: | 48 | A list of parameters that are applicable for all the operations described under this path. 49 | These parameters can be overridden at the operation level, but cannot be removed there. 50 | The list MUST NOT include duplicated parameters. 51 | A unique parameter is defined by a combination of a name and location. 52 | The list can use the Reference Object to link to parameters that are defined at the Swagger Object's parameters. 53 | There can be one *body* parameter at most. 54 | -------------------------------------------------------------------------------- /data/2.0/Paths_Object.yaml: -------------------------------------------------------------------------------- 1 | Paths Object: 2 | description: | 3 | Holds the relative paths to the individual endpoints. 4 | The path is appended to the basePath in order to construct the full URL. 5 | The Paths may be empty, due to ACL constraints. 6 | allowExtension: true 7 | fields: 8 | - name: "/{path}" 9 | type: Path Item Object 10 | required: true 11 | description: | 12 | A relative path to an individual endpoint. 13 | The field name MUST begin with a slash. 14 | The path is appended to the basePath in order to construct the full URL. 15 | Path templating is allowed. 16 | -------------------------------------------------------------------------------- /data/2.0/Reference_Object.yaml: -------------------------------------------------------------------------------- 1 | Reference Object: 2 | name: $ref 3 | type: string 4 | description: | 5 | A simple object to allow referencing other definitions in the specification. 6 | It can be used to reference parameters and responses that are defined at the top level for reuse. 7 | The Reference Object is a JSON Reference that uses a JSON Pointer as its value. 8 | For this specification, only canonical dereferencing is supported. -------------------------------------------------------------------------------- /data/2.0/Response_Object.yaml: -------------------------------------------------------------------------------- 1 | Response Object: 2 | description: Describes a single response from an API Operation. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: description 7 | type: string 8 | required: true 9 | md: GFM 10 | description: A short description of the response. GFM syntax can be used for rich text representation. 11 | - 12 | name: schema 13 | type: Schema Object 14 | description: | 15 | A definition of the response structure. 16 | It can be a primitive, an array or an object. 17 | If this field does not exist, it means no content is returned as part of the response. 18 | As an extension to the Schema Object, its root type value may also be "file". 19 | This SHOULD be accompanied by a relevant produces mime-type. 20 | - 21 | name: headers 22 | type: Headers Object 23 | description: A list of headers that are sent with the response. 24 | - 25 | name: example 26 | type: Example Object 27 | description: An example of the response message. 28 | -------------------------------------------------------------------------------- /data/2.0/Responses_Definitions_Object.yaml: -------------------------------------------------------------------------------- 1 | Responses Definitions Object: 2 | description: | 3 | An object to hold responses to be reused across operations. 4 | Response definitions can be referenced to the ones defined here. 5 | This does not define global operation responses. 6 | fields: 7 | - 8 | name: "{name}" 9 | type: Response Object 10 | patterned: true 11 | description: A single response definition, mapping a "name" to the response it defines. 12 | -------------------------------------------------------------------------------- /data/2.0/Responses_Object.yaml: -------------------------------------------------------------------------------- 1 | Responses Object: 2 | description: | 3 | A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors. 4 | 5 | The default can be used a default response object for all HTTP codes that are not covered individually by the specification. 6 | 7 | The Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful operation call. 8 | allowExtension: true 9 | fields: 10 | - 11 | name: default 12 | #allowReference: true 13 | type: Response Object 14 | description: The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. Reference Object can be used to link to a response that is defined at the Swagger Object's responses section. 15 | - 16 | name: "{HTTP status code}" 17 | #allowReference: true 18 | type: Response Object 19 | description: Any HTTP status code can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. Reference Object can be used to link to a response that is defined at the Swagger Object's responses section. -------------------------------------------------------------------------------- /data/2.0/Schema_Object.yaml: -------------------------------------------------------------------------------- 1 | Schema Object: 2 | description: | 3 | The Schema Object allows the definition of input and output data types. 4 | These types can be objects, but also primitives and arrays. 5 | This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it. 6 | On top of this subset, there are extensions provided by this specification to allow for more complete documentation. 7 | allowExtension: true 8 | fields: 9 | - 10 | name: '$ref' 11 | type: string 12 | description: A JSON Reference 13 | - 14 | name: title 15 | type: string 16 | description: The object's title 17 | - 18 | name: description 19 | type: String 20 | md: GFM 21 | description: The object's description 22 | - 23 | name: default 24 | type: '*' 25 | description: The default value. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. 26 | - 27 | name: enum 28 | type: '[*]' 29 | description: Object's authorized values 30 | - 31 | name: allOf 32 | type: '[Schema Object | Reference Object]' 33 | noFollow: true 34 | description: | 35 | OpenAPI Specification allows combining and extending model definitions using the allOf property of JSON Schema, in effect offering model composition. allOf takes in an array of object definitions that are validated independently but together compose a single object. 36 | While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, OpenAPI Specification adds the support of the discriminator field. When used, the discriminator will be the name of the property used to decide which schema definition is used to validate the structure of the model. As such, the discriminator field MUST be a required field. The value of the chosen property has to be the friendly name given to the model under the definitions property. As such, inline schema definitions, which do not have a given id, cannot be used in polymorphism. 37 | - 38 | name: type 39 | description: Object's type 40 | type: string 41 | values: 42 | - 43 | value: array 44 | description: A JSON array. 45 | - 46 | value: boolean 47 | description: A JSON boolean. 48 | - 49 | value: integer 50 | description: A JSON number without a fraction or exponent part. 51 | - 52 | value: number 53 | description: Any JSON number. Number includes integer. 54 | - 55 | value: 'null' 56 | description: The JSON null value. 57 | - 58 | value: object 59 | description: A JSON object. 60 | default: true 61 | - 62 | value: string 63 | description: A JSON string. 64 | - 65 | name: 66 | type: Schema Object Array 67 | description: Fields when *type* is *array* 68 | - 69 | name: 70 | type: Schema Object String 71 | description: Fields when *type* is *string* 72 | - 73 | name: 74 | type: Schema Object Number Or Integer 75 | description: Fields when *type* is *number* or *integer* 76 | - 77 | name: 78 | type: Schema Object Object 79 | description: Fields when *type* is *object* 80 | - 81 | name: 82 | type: Schema Object OpenAPI 83 | description: Fields when *type* is *object* -------------------------------------------------------------------------------- /data/2.0/Schema_Object_Array.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Array: 2 | description:: Fields if type is array. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: items 7 | type: Items Object 8 | description: Describes the type of items in the array. 9 | - 10 | name: maxItems 11 | type: number 12 | description: Maximum count of items in array 13 | - 14 | name: minItems 15 | type: number 16 | description: Minimum count of items in array. 17 | - 18 | name: uniqueItems 19 | type: boolean 20 | description: Allow only unique items in array. 21 | -------------------------------------------------------------------------------- /data/2.0/Schema_Object_Number_Or_Integer.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Number Or Integer: 2 | description: A number or integer value 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: format 7 | type: string 8 | description: | 9 | The extending format for the previously mentioned type. 10 | See Data Type Formats for further details. 11 | 12 | Common Name | type | format| Comments 13 | ------------|------|-------|--------- 14 | integer | integer | int32 | signed 32 bits 15 | long | integer | int64 | signed 64 bits 16 | float | number | float | 17 | double | number | double| 18 | 19 | - 20 | name: maximum 21 | type: number 22 | description: | 23 | Maximum value. 24 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 25 | - 26 | name: exclusiveMaximum 27 | type: boolean 28 | description: | 29 | Indicate if the value must be < maximum. 30 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 31 | - 32 | name: minimum 33 | type: number 34 | description: | 35 | Minimum value. 36 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 37 | - 38 | name: exclusiveMinimum 39 | type: boolean 40 | description: | 41 | Indicate if the value must value > minimum. 42 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 43 | - 44 | name: multipleOf 45 | type: number 46 | description: | 47 | The value must be a multiple of *multiplOf*. 48 | See http://json-schema.org/latest/json-schema-validation.html#anchor14. 49 | -------------------------------------------------------------------------------- /data/2.0/Schema_Object_Object.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Object: 2 | fieldsGroup: true 3 | description: type value is object. 4 | fields: 5 | - 6 | name: properties 7 | description: List of properties. 8 | type: '[Schema Object | Reference Object]' 9 | noFollow: true 10 | - 11 | name: additionalProperties 12 | description: Additionnal properties to create a map. 13 | type: '[Schema Object | Reference Object]' 14 | noFollow: true 15 | - 16 | name: required 17 | type: "[string]" 18 | description: The list of required properties. 19 | - 20 | name: maxProperties 21 | type: integer 22 | description: An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. 23 | - 24 | name: minProperties 25 | type: integer 26 | description: An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. -------------------------------------------------------------------------------- /data/2.0/Schema_Object_OpenAPI.yaml: -------------------------------------------------------------------------------- 1 | Schema Object OpenAPI: 2 | fieldsGroup: true 3 | description: Other than the JSON Schema subset fields, the following fields may be used for further schema documentation. 4 | fields: 5 | - 6 | name: discriminator 7 | type: string 8 | description: | 9 | Adds support for polymorphism. 10 | The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. 11 | The property name used MUST be defined at this schema and it MUST be in the required property list. 12 | When used, the value MUST be the name of this schema or any schema that inherits it. 13 | - 14 | name: readOnly 15 | type: boolean 16 | description: | 17 | Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false. 18 | - 19 | name: xml 20 | type: XML Object 21 | description: | 22 | This MAY be used only on properties schemas. It has no effect on root schemas. 23 | Adds Additional metadata to describe the XML representation format of this property. 24 | - 25 | name: externalDocs 26 | type: External Documentation Object 27 | description: Additional external documentation for this schema. 28 | - 29 | name: example 30 | type: Any 31 | description: A free-form property to include an example of an instance for this schema. -------------------------------------------------------------------------------- /data/2.0/Schema_Object_String.yaml: -------------------------------------------------------------------------------- 1 | Schema Object String: 2 | description: type value is string 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: format 7 | type: String 8 | description: | 9 | The extending format for the previously mentioned type. 10 | See Data Type Formats for further details. 11 | 12 | Common Name | format | Comments 13 | ------------|-----------|--------- 14 | byte | byte | base64 encoded characters 15 | binary | binary | any sequence of octets 16 | date | date | As defined by full-date - RFC3339 17 | dateTime | date-time | As defined by date-time - RFC3339 18 | password | password | Used to hint UIs the input needs to be obscured. 19 | - 20 | name: pattern 21 | type: string 22 | description: | 23 | This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. 24 | See http://json-schema.org/latest/json-schema-validation.html#anchor33. 25 | See https://regex101.com/ 26 | - 27 | name: maxLength 28 | type: integer 29 | description: | 30 | Maximum string's length. 31 | See http://json-schema.org/latest/json-schema-validation.html#anchor26. 32 | - 33 | name: minLength 34 | type: integer 35 | description: | 36 | Minimum string's length. 37 | See http://json-schema.org/latest/json-schema-validation.html#anchor29. 38 | -------------------------------------------------------------------------------- /data/2.0/Scopes_Object.yaml: -------------------------------------------------------------------------------- 1 | Scopes Object: 2 | description: Lists the available scopes for an OAuth2 security scheme. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: {name} 7 | type: string 8 | description: Maps between a name of a scope to a short description of it (as the value of the property). 9 | patterned: true 10 | -------------------------------------------------------------------------------- /data/2.0/Security_Definitions_Object.yaml: -------------------------------------------------------------------------------- 1 | Security Definitions Object: 2 | description: | 3 | A declaration of the security schemes available to be used in the specification. 4 | This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme. 5 | allowExtension: true 6 | fields: 7 | - 8 | name: "{name}" 9 | type: Security Scheme Object 10 | description: A single security scheme definition, mapping a *name* to the scheme it defines. 11 | patterned: true 12 | -------------------------------------------------------------------------------- /data/2.0/Security_Requirement_Object.yaml: -------------------------------------------------------------------------------- 1 | Security Requirement Object: 2 | allowExtension: true 3 | fields: 4 | - 5 | name: "{name}" 6 | type: "[string]" 7 | description: | 8 | Each name must correspond to a security scheme which is declared in the Security Definitions. 9 | If the security scheme is of type *oauth2*, then the value is a list of scope names required for the execution. 10 | For other security scheme types, the array MUST be empty. 11 | -------------------------------------------------------------------------------- /data/2.0/Security_Scheme_Object.yaml: -------------------------------------------------------------------------------- 1 | Security Scheme Object: 2 | description: | 3 | Allows the definition of a security scheme that can be used by the operations. 4 | Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code). 5 | allowExtension: true 6 | fields: 7 | - 8 | name: type 9 | type: string 10 | description: The type of the security scheme. 11 | required: true 12 | values: 13 | - value: basic 14 | - value: apiKey 15 | - value: oauth2 16 | - 17 | name: description 18 | type: string 19 | description: A short description for security scheme. 20 | - 21 | name: 22 | type: Security Scheme Object ApiKey 23 | description: Fields if *type* value is *apiKey*. 24 | - 25 | name: 26 | type: Security Scheme Object Oauth 27 | description: Fields if *type* value is *oauth2*. 28 | -------------------------------------------------------------------------------- /data/2.0/Security_Scheme_Object_ApiKey.yaml: -------------------------------------------------------------------------------- 1 | Security Scheme Object ApiKey: 2 | description: 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: apiKey 7 | type: string 8 | description: The name of the header or query parameter to be used. 9 | required: true 10 | - 11 | name: in 12 | type: string 13 | description: The location of the API key. 14 | required: true 15 | values: 16 | - value: query 17 | - value: header 18 | -------------------------------------------------------------------------------- /data/2.0/Security_Scheme_Object_Oauth.yaml: -------------------------------------------------------------------------------- 1 | Security Scheme Object Oauth: 2 | description: 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: flow 7 | type: string 8 | description: The flow used by the OAuth2 security scheme. 9 | values: 10 | - value: implicit 11 | - value: password 12 | - value: application 13 | - value: accessCode 14 | required: true 15 | - 16 | name: authorizationUrl 17 | type: string 18 | description: The authorization URL to be used for this flow (implicit or access code). This SHOULD be in the form of a URL. 19 | required: true 20 | - 21 | name: tokenUrl 22 | type: string 23 | description: The token URL to be used for this flow (password, application or access code). This SHOULD be in the form of a URL. 24 | required: true 25 | - 26 | name: scopes 27 | type: Scopes Object 28 | description: The available scopes for the OAuth2 security scheme. 29 | -------------------------------------------------------------------------------- /data/2.0/Specification_Extensions.yaml: -------------------------------------------------------------------------------- 1 | Specification Extensions: 2 | name: ^x- 3 | type: Any 4 | patterned: true 5 | openapiType: true 6 | specificationAnchor: vendorExtensions 7 | description: | 8 | While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points. 9 | The field name MUST begin with *x-*, for example, *x-internal-id.* 10 | The value can be null, a primitive, an array or an object. 11 | When the value is an object or an array of object, the object's fields names do not need to start with *x-*. 12 | The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). 13 | -------------------------------------------------------------------------------- /data/2.0/Swagger_Object.yaml: -------------------------------------------------------------------------------- 1 | Swagger Object: 2 | name: OpenAPI 2.0 3 | description: | 4 | OpenAPI 2.0 top level object. This is the *root* document object for the API specification. 5 | It combines what previously was the Resource Listing and API Declaration (version 1.2 and earlier) together into one document. 6 | allowExtension: true 7 | fields: 8 | - name: swagger 9 | type: string 10 | required: true 11 | description: | 12 | Specifies the OpenAPI Specification version being used. 13 | It can be used by the Swagger UI and other clients to interpret the API listing. 14 | values: 15 | - value: "2.0" 16 | description: The value MUST be 2.0 17 | - name: info 18 | type: Info Object 19 | required: true 20 | description: | 21 | Provides metadata about the API. 22 | The metadata can be used by the clients if needed. 23 | - name : host 24 | type: string 25 | description: | 26 | The host (name or ip) serving the API. 27 | This MUST be the host only and does not include the scheme nor sub-paths. 28 | It MAY include a port. 29 | If the host is not included, the host serving the documentation is to be used (including the port). 30 | The host does not support path templating. 31 | - name: basePath 32 | type: string 33 | required: false 34 | description: | 35 | The base path on which the API is served, which is relative to the host. 36 | If it is not included, the API is served directly under the host. 37 | The value MUST start with a leading slash (/). 38 | The basePath does not support path templating. 39 | - name: schemes 40 | type: "[string]" 41 | description: | 42 | The transfer protocol of the API. 43 | If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself. 44 | values: 45 | - value: http 46 | - value: https 47 | - value: ws 48 | description: "[Web socket](https://en.wikipedia.org/wiki/WebSocket) scheme" 49 | - value: wss 50 | description: "Secured [web socket](https://en.wikipedia.org/wiki/WebSocket) scheme" 51 | - name: consumes 52 | type: "[string]" 53 | description: | 54 | A list of MIME types the APIs can consume. 55 | This is global to all APIs but can be overridden on specific API calls. 56 | Value MUST be as described under Mime Types. 57 | - name: produces 58 | type: "[string]" 59 | description: | 60 | A list of MIME types the APIs can produce. 61 | This is global to all APIs but can be overridden on specific API calls. 62 | Value MUST be as described under Mime Types. 63 | - name: paths 64 | type: Paths Object 65 | required: true 66 | description: The available paths and operations for the API. 67 | - name: definitions 68 | type: Definitions Object 69 | description: An object to hold data types produced and consumed by operations. 70 | - name: parameters 71 | type: Parameters Definitions Object 72 | description: | 73 | An object to hold parameters that can be used across operations. 74 | This property does not define global parameters for all operations. 75 | - name: responses 76 | type: Responses Definitions Object 77 | description: | 78 | An object to hold responses that can be used across operations. 79 | This property does not define global responses for all operations. 80 | - name: securityDefinitions 81 | type: Security Definitions Object 82 | description: Security scheme definitions that can be used across the specification. 83 | - name: security 84 | type: "[Security Requirement Object]" 85 | description: | 86 | A declaration of which security schemes are applied for the API as a whole. 87 | The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). 88 | Individual operations can override this definition. 89 | - name: tags 90 | type: "[Tag Object]" 91 | description: | 92 | A list of tags used by the specification with additional metadata. 93 | The order of the tags can be used to reflect on their order by the parsing tools. 94 | Not all tags that are used by the *Operation Object* must be declared. 95 | The tags that are not declared may be organized randomly or based on the tools' logic. 96 | Each tag name in the list MUST be unique. 97 | - name: externalDocs 98 | type: External Documentation Object 99 | description: Additional external documentation. 100 | -------------------------------------------------------------------------------- /data/2.0/Tag_Object.yaml: -------------------------------------------------------------------------------- 1 | Tag Object: 2 | description: | 3 | Allows adding meta data to a single tag that is used by the *Operation Object*. 4 | It is not mandatory to have a Tag Object per tag used there. 5 | allowExtension: true 6 | fields: 7 | - 8 | name: name 9 | type: string 10 | description: The name of the tag. 11 | required: true 12 | - 13 | name: description 14 | type: string 15 | description: A short description for the tag. 16 | md: GFM 17 | - 18 | name: externalDocs 19 | type: ExternalDocumentation 20 | description: Additional external documentation for this tag. 21 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Callback_Object.yaml: -------------------------------------------------------------------------------- 1 | Callback Object: 2 | changelog: 3 | isNew: true 4 | allowExtension: true 5 | description: A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. 6 | fields: 7 | - name: "{expression}" 8 | type: Path Item Object 9 | noFollow: true 10 | description: A Path Item Object used to define a callback request and expected responses 11 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Callbacks_Object.yaml: -------------------------------------------------------------------------------- 1 | Callbacks Object: 2 | changelog: 3 | isNew: true 4 | allowExtension: true 5 | description: An object to hold reusable Callback Objects. 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Callback Object 10 | type: Callback Object 11 | allowReference: true -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Callbacks_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Callbacks Map: 2 | changelog: 3 | isNew: true 4 | description: An object to hold reusable Callback Objects. 5 | specificationAnchor: componentsObject 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Callback Object 10 | type: Callback Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Examples_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Examples Map: 2 | description: An object to hold reusable Example Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Example Object 10 | type: Example Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Headers_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Headers Map: 2 | description: An object to hold reusable Header Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Header Object 10 | type: Header Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Links_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Links Map: 2 | description: An object to hold reusable Link Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Link Object 10 | type: Link Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Object.yaml: -------------------------------------------------------------------------------- 1 | Components Object: 2 | description: Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | details: Contains former root `responses`, `parameters` (split into `parameters` and `requestBodies`) and `definitions` (as `schemas`). 7 | fields: 8 | - 9 | name: schemas 10 | type: Components Schemas Map 11 | changelog: 12 | isInfo: true 13 | details: Replace root `definitions` 14 | description: A map of reusable Schema Objects. 15 | - 16 | name: responses 17 | type: Components Responses Map 18 | changelog: 19 | isInfo: true 20 | details: Replace root `responses` 21 | description: A map of reusable Response Objects. 22 | - 23 | name: parameters 24 | type: Components Parameters Map 25 | changelog: 26 | isInfo: true 27 | details: Replace root `parameters` (Only non body parameters, body ones are in `requestBodies`). 28 | description: A map of reusable Parameter Objects. 29 | - 30 | name: examples 31 | type: Components Examples Map 32 | description: A map of reusable Example Objects. 33 | - 34 | name: requestBodies 35 | type: Components Request Bodies Map 36 | changelog: 37 | isInfo: true 38 | details: Partially replace root `parameters` (Body parameters only, others are in `parameters`). 39 | description: A map of reusable Request Bodies Objects. 40 | - 41 | name: headers 42 | type: Components Headers Map 43 | description: A map of reusable Header Objects. 44 | - 45 | name: securitySchemes 46 | type: Components Security Schemes Map 47 | changelog: 48 | isInfo: true 49 | details: Replace root `securityDefinitions`. 50 | description: A map of reusable Security Scheme Objects. 51 | - 52 | name: links 53 | type: Components Links Map 54 | description: A map of reusable Link Objects. 55 | - 56 | name: callbacks 57 | type: Components Callbacks Map 58 | description: A map of reusable Callback Objects. 59 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Parameters_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Parameters Map: 2 | description: An object to hold reusable Parameters Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A reusable Parameter Object 10 | type: Parameter Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Request_Bodies_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Request Bodies Map: 2 | description: An object to hold reusable Request Body Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Request Body Object 10 | type: Request Body Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Responses_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Responses Map: 2 | description: An object to hold reusable Response Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Response Object 10 | type: Response Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Schemas_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Schemas Map: 2 | description: An object to hold reusable Schema Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Schema Object 10 | type: Schema Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Components_Security_Schemes_Map.yaml: -------------------------------------------------------------------------------- 1 | Components Security Schemes Map: 2 | description: An object to hold reusable Schema Objects. 3 | specificationAnchor: componentsObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: "{name}" 9 | description: A resusable Security Scheme Object 10 | type: Security Scheme Object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Contact_Object.yaml: -------------------------------------------------------------------------------- 1 | Contact Object: 2 | description: Contact information for the exposed API. 3 | allowExtension: true 4 | fields: 5 | - name: name 6 | type: string 7 | description: The identifying name of the contact person/organization. 8 | - name: url 9 | type: string 10 | description: | 11 | The URL pointing to the contact information. 12 | MUST be in the format of a URL. 13 | - name: email 14 | type: string 15 | description: | 16 | The email address of the contact person/organization. 17 | MUST be in the format of an email address. 18 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Content_Object.yaml: -------------------------------------------------------------------------------- 1 | Content Object: 2 | description: | 3 | Describes a set of supported media types. A Content Object can be used in Request Body Object, Parameter Objects, Header Objects, and Response Objects. 4 | 5 | Each key in the Content Object is the media type of the Media Type Object. 6 | changelog: 7 | isNew: true 8 | details: Replace `consumes` and `produces`. Reusable `Content Object` can be described in `components`. 9 | fields: 10 | - name: "{media type}" 11 | type: Media Type Object 12 | description: A media type object -------------------------------------------------------------------------------- /data/3.0.0-rc0/Encoding_Object.yaml: -------------------------------------------------------------------------------- 1 | Encoding Object: 2 | description: An object representing multipart region encoding for requestBody objects. 3 | changelog: 4 | isNew: true 5 | fields: 6 | - name: "{property}" 7 | type: Encoding Property Object 8 | description: The property name to which the special encoding are applied. This field MUST exist in the schema as a property. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Encoding_Property_Object.yaml: -------------------------------------------------------------------------------- 1 | Encoding Property Object: 2 | description: A single encoding definition applied to a single schema property. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: contentType 9 | type: string 10 | description: "The Content-Type to use for encoding a specific property. Default value depends on the property type: for string with format being binary - application/octet-stream; for other primitive types - plain/text; for object - application/json; for array - the default is defined based on the inner type." 11 | - 12 | name: Headers 13 | type: object 14 | description: A string map allowing additional information to be provided as headers, for example Content-Disposition. Note Content-Type is described separately and will be ignored from this section. 15 | - 16 | name: style 17 | type: string 18 | description: The Content-Type to use for encoding a specific property. See (#parameterContent) for details on the style property. The behavior follows the same values allowed for query parameters, including default values. 19 | - 20 | name: explode 21 | type: boolean 22 | description: When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Example_Object.yaml: -------------------------------------------------------------------------------- 1 | Example Object: 2 | description: Allows sharing examples for operation requests and responses. This object can either be a freeform object, array or primitive value. To represent examples of media types that cannot naturally represented in the OpenAPI definition, a string value can be used to contain the example with escaping where necessary. 3 | changelog: 4 | isNew: true 5 | fields: 6 | - 7 | name: "" 8 | type: freeform object or array or primitive value 9 | description: Allows sharing examples for operation requests and responses. This object can either be a freeform object, array or primitive value. To represent examples of media types that cannot naturally represented in the OpenAPI definition, a string value can be used to contain the example with escaping where necessary. -------------------------------------------------------------------------------- /data/3.0.0-rc0/External_Documentation_Object.yaml: -------------------------------------------------------------------------------- 1 | External Documentation Object: 2 | description: Allows referencing an external resource for extended documentation. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: description 7 | type: string 8 | description: A short description of the target documentation. CommonMark syntax can be used for rich text representation. 9 | md: CommonMarck 10 | - 11 | name: url 12 | type: string 13 | description: The URL for the target documentation. Value MUST be in the format of a URL. 14 | required: true 15 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Header_Object.yaml: -------------------------------------------------------------------------------- 1 | Header Object: 2 | description: | 3 | The Header Object follows the structure of the Parameter Object, with the following changes: 4 | 5 | - name MUST NOT be specified, it is given in the Headers Object. 6 | - in MUST NOT be specified, it is implicitly in header. 7 | - All traits that are affected by the location MUST follow the location of header (for example, style). 8 | 9 | Note: allowEmptyValue shouldn't be used too (only for query parameters) 10 | allowExtension: true 11 | changelog: 12 | isModified: true 13 | details: Response headers are defined almost like parameters and can now be defined in `OpenAPI Object.components.headers` and reused with a `$ref`. 14 | deletedProperties: 15 | - 16 | name: default 17 | replacedBy: schema.default or content.{media type}.schema.default 18 | see: Schema Object 19 | - 20 | name: items 21 | replacedBy: schema.items or content.{media type}.schema.items 22 | see: Schema Object 23 | - 24 | name: collectionFormat 25 | replacedBy: schema.collectionFormat or content.{media type}.schema.collectionFormat 26 | see: Schema Object 27 | - 28 | name: maxItems 29 | replacedBy: schema.maxItems or content.{media type}.schema.maxItems 30 | see: Schema Object 31 | - 32 | name: minItems 33 | replacedBy: schema.minItems or content.{media type}.schema.minItems 34 | see: Schema Object 35 | - 36 | name: uniqueItems 37 | replacedBy: schema.uniqueItems or content.{media type}.schema.uniqueItems 38 | see: Schema Object 39 | - 40 | name: format 41 | replacedBy: schema.format or content.{media type}.schema.format 42 | see: Schema Object 43 | - 44 | name: enum 45 | replacedBy: schema.enum or content.{media type}.schema.enum 46 | see: Schema Object 47 | - 48 | name: pattern 49 | replacedBy: schema.pattern or content.{media type}.schema.pattern 50 | see: Schema Object 51 | - 52 | name: maxLength 53 | replacedBy: schema.maxLength or content.{media type}.schema.maxLength 54 | see: Schema Object 55 | - 56 | name: minLength 57 | replacedBy: schema.minLength or content.{media type}.schema.minLength 58 | see: Schema Object 59 | - 60 | name: maximum 61 | replacedBy: schema.maximum or content.{media type}.schema.maximum 62 | see: Schema Object 63 | - 64 | name: exclusiveMaximum 65 | replacedBy: schema.exclusiveMaximum or content.{media type}.schema.exclusiveMaximum 66 | see: Schema Object 67 | - 68 | name: minimum 69 | replacedBy: schema.minimum or content.{media type}.schema.minimum 70 | see: Schema Object 71 | - 72 | name: exclusiveMinimum 73 | replacedBy: schema.exclusiveMinimum or content.{media type}.schema.exclusiveMinimum 74 | see: Schema Object 75 | - 76 | name: multipleOf 77 | replacedBy: schema.multipleOf or content.{media type}.schema.multipleOf 78 | see: Schema Object 79 | 80 | fields: 81 | - 82 | name: description 83 | type: string 84 | md: CommonMark 85 | description: | 86 | A brief description of the parameter. This could contain examples of use. CommonMark syntax can be used for rich text representation. 87 | - 88 | name: required 89 | type: boolean 90 | description: | 91 | Determines whether this parameter is mandatory. If the parameter location is "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false. 92 | - 93 | name: deprecated 94 | type: boolean 95 | description: Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. 96 | changelog: 97 | isNew: true 98 | - 99 | name: 100 | type: Parameter Object Style Schema 101 | description: The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a style and schema can be used to describe the structure and syntax of the parameter. 102 | - 103 | name: 104 | type: Parameter Object Content 105 | description: For more complex scenarios a Content Object can be used to define the media type and schema of the parameter. This option is mutually exclusive with the simple scenario above. When example or examples are provided in conjunction with the schema object, the example must follow the prescribed serialization strategy for the parameter. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Headers_Object.yaml: -------------------------------------------------------------------------------- 1 | Headers Object: 2 | description: Lists the headers that can be sent in a response or forwarded via a link. Note that RFC 7230 states header names are case insensitive. 3 | fields: 4 | - name: "{name}" 5 | type: Header Object 6 | description: The name of the property corresponds to the name of the header. The value describes the type of the header. 7 | allowReference: true 8 | changelog: 9 | isModified: true 10 | details: Headers can now be defined in components to be reused -------------------------------------------------------------------------------- /data/3.0.0-rc0/Info_Object.yaml: -------------------------------------------------------------------------------- 1 | Info Object: 2 | description: Provides metadata about the API. The metadata can be used by the clients if needed. 3 | allowExtension: true 4 | fields: 5 | - name: title 6 | type: string 7 | required: true 8 | description: The title of the application. 9 | - name: description 10 | type: string 11 | md: CommonMark 12 | description: A short description of the application. CommonMark syntax can be used for rich text representation. 13 | - name: termsOfService 14 | type: string 15 | description: A URL to the Terms of Service for the API. 16 | - name: contact 17 | type: Contact Object 18 | description: The contact information for the exposed API. 19 | - name: licence 20 | type: Licence Object 21 | description: The license information for the exposed API. 22 | - name: version 23 | type: string 24 | required: true 25 | description: The version of the API definition (which is distinct from the OpenAPI specification version or the API implementation version). 26 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Licence_Object.yaml: -------------------------------------------------------------------------------- 1 | Licence Object: 2 | description: License information for the exposed API. 3 | allowExtension: true 4 | fields: 5 | - name: name 6 | type: string 7 | required: true 8 | description: The license name used for the API. 9 | - 10 | name: url 11 | type: string 12 | description: | 13 | A URL to the license used for the API. 14 | MUST be in the format of a URL. 15 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Link_Object.yaml: -------------------------------------------------------------------------------- 1 | Link Object: 2 | description: The Link Object is responsible for defining a possible operation based on a single response. 3 | specificationAnchor: link-object 4 | allowExtension: true 5 | changelog: 6 | isNew: true 7 | fields: 8 | - 9 | name: href 10 | type: string 11 | description: a relative or absolute URL to a linked resource. This field is mutually exclusive with the operationId field. 12 | - 13 | name: operationId 14 | type: string 15 | description: the name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive with the href field. Relative href values MAY be used to locate an existing Operation Object in the OAS. 16 | - 17 | name: parameters 18 | type: Link Parameters Object 19 | description: an object representing parameters to pass to an operation as specified with operationId or identified via href. 20 | - 21 | name: headers 22 | type: Headers Object 23 | description: an object representing headers to pass to the linked resource. Where conflicts occur between these headers, and those defined in the related operation, these headers override. 24 | - 25 | name: description 26 | type: string 27 | md: CommonMark 28 | description: a description of the link, supports CommonMark syntax. 29 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Link_Parameters_Object.yaml: -------------------------------------------------------------------------------- 1 | Link Parameters Object: 2 | description: | 3 | Using the operationId to reference an operation in the definition has many benefits, including the ability to define media type options, security requirements, response and error payloads. Many operations require parameters to be passed, and these MAY be dynamic depending on the response itself. 4 | 5 | To specify parameters required by the operation, we can use a Link Parameters Object. This object contains parameter names along with static or dynamic values 6 | changelog: 7 | isNew: true 8 | fields: 9 | - name: "{name}" 10 | type: "Any or expression" 11 | specificationAnchor: variableSubstitution 12 | description: A constant value or [expression](https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md#variableSubstitution) to be evaluated and passed to the linked operation. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Links_Object.yaml: -------------------------------------------------------------------------------- 1 | Links Object: 2 | allowExtension: true 3 | description: | 4 | The links object represents a set of possible design-time links for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations. 5 | 6 | As opposed to dynamic links (links provided in the response payload), the OAS linking mechanism does not require that link information be provided in a specific response format at runtime. 7 | 8 | For computing links, and providing instructions to execute them, variable substitution is used for accessing values in a response and using them as values while invoking the linked operation. 9 | changelog: 10 | isNew: true 11 | fields: 12 | - 13 | name: "{name}" 14 | description: A short name for the link, following the naming constraints of the names for Component Objects. 15 | type: Link Object 16 | allowReference: true -------------------------------------------------------------------------------- /data/3.0.0-rc0/Media_Type_Object.yaml: -------------------------------------------------------------------------------- 1 | Media Type Object: 2 | description: Each Media Type Object provides schema and examples for a the media type identified by its key. Media Type Objects can be used in a Content Object. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - name: schema 8 | type: Schema Object 9 | description: The schema defining the type used for the request body. 10 | - 11 | name: examples 12 | type: "[Example Object]" 13 | allowReference: true 14 | description: Examples of the media type. Each example in the Examples array SHOULD be in the correct format as specified in the media type. The examples object is mutually exclusive to the example object. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema. 15 | - 16 | name: example 17 | type: Example Object 18 | allowReference: true 19 | description: Example of the content type. The example object SHOULD be in the correct format as specified in the parameter encoding. The example object is mutually exclusive to the examples object. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the the schema. 20 | - 21 | name: encoding 22 | type: Encoding Object 23 | description: Encoding of the media type. The encoding object SHOULD only apply to requestBody objects when the content type is multipart. -------------------------------------------------------------------------------- /data/3.0.0-rc0/OAuth_Flow_Object.yaml: -------------------------------------------------------------------------------- 1 | OAuth Flow Object: 2 | description: Configuration details for a supported OAuth Flow 3 | specificationAnchor: oauthFlowObject 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: authorizationUrl 9 | type: string 10 | validity: oauth2 ("implicit", "authorizationCode") 11 | required: true 12 | description: The authorization URL to be used for this flow. This MUST be in the form of a URL. 13 | - 14 | name: tokenUrl 15 | type: string 16 | validity: oauth2 ("password", "clientCredentials", "authorizationCode") 17 | required: true 18 | description: The token URL to be used for this flow. This MUST be in the form of a URL. 19 | - 20 | name: refreshUrl 21 | type: string 22 | validity: oauth2 23 | description: The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. 24 | - 25 | name: scopes 26 | type: Scopes Object 27 | validity: oauth2 28 | description: The available scopes for the OAuth2 security scheme. -------------------------------------------------------------------------------- /data/3.0.0-rc0/OAuth_Flows_Object.yaml: -------------------------------------------------------------------------------- 1 | OAuth Flows Object: 2 | description: Allows configuration of the supported OAuth Flows. 3 | changelog: 4 | isNew: true 5 | specificationAnchor: oauthFlowsObject 6 | allowExtension: true 7 | fields: 8 | - 9 | name: implicit 10 | type: OAuth Flow Object 11 | description: Configuration for the OAuth Implicit flow 12 | - 13 | name: password 14 | type: OAuth Flow Object 15 | description: Configuration for the OAuth Resource Owner Password flow 16 | - 17 | name: clientCredentials 18 | type: OAuth Flow Object 19 | description: Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. 20 | - 21 | name: authorizationCode 22 | type: OAuth Flow Object 23 | description: Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. -------------------------------------------------------------------------------- /data/3.0.0-rc0/OpenAPI_Object.yaml: -------------------------------------------------------------------------------- 1 | OpenAPI Object: 2 | name: OpenAPI 3.0.0-rc0 3 | specificationAnchor: oasObject 4 | description: | 5 | OpenAPI 3.0.0 top level object. 6 | This is the root document object for the API specification. It combines what previously was the Resource Listing and API Declaration (version 1.2 and earlier) together into one document. 7 | allowExtension: true 8 | changelog: 9 | isModified: true 10 | details: | 11 | The new OpenAPI specification version 3.0.0 offers many welcomed improvements and new features (see OpenAPI [blog post series about this](https://www.openapis.org/news/blogs/2016/10/tdc-structural-improvements-explaining-30-spec-part-2)). 12 | 13 | Here are the noticeable changes on top level (*navigate through the tree to see what happened on other levels*): 14 | - Bye bye `swagger` and hello `openapi`. 15 | - Reusable definitions are centralized in `components` making the document more consistent (the previous version mixed reusable and global definitions on the same level). 16 | 17 | deletedProperties: 18 | - name: swagger 19 | replacedBy: openapi 20 | see: OpenAPI Object 21 | - name: host 22 | replacedBy: servers[].url 23 | see: Server Object 24 | - name: basePath 25 | replacedBy: servers[].url 26 | see: Server Object 27 | - name: schemes 28 | replacedBy: servers[].url 29 | see: Server Object 30 | - name: definitions 31 | replacedBy: components.schemas 32 | see: Components Object 33 | - name: parameters 34 | replacedBy: components.parameters and components.requestBodies 35 | see: Components Object 36 | - name: securityDefinitions 37 | replacedBy: components.securitySchemas 38 | see: Components Object 39 | - name: consumes 40 | replacedBy: Content Object.{media type} 41 | see: Content Object 42 | - name: produces 43 | replacedBy: Content Object.{media type} 44 | see: Content Object 45 | fields: 46 | - 47 | name: openapi 48 | type: string 49 | required: true 50 | changelog: 51 | isNew: true 52 | details: Replace the `swagger` property 53 | description: | 54 | Specifies the OpenAPI Specification version being used. It can be used by tooling Specifications and clients to interpret the version. The structure SHALL be `major.minor.patch`, where `patch` versions MUST be compatible with the existing `major.minor` tooling. Typically `patch` versions will be introduced to address errors in the documentation, and tooling SHOULD typically be compatible with the corresponding `major.minor` (3.0.*). Patch versions will correspond to patches of this document. 55 | - 56 | name: info 57 | type: Info Object 58 | required: true 59 | description: Provides metadata about the API. The metadata can be used by the clients if needed. 60 | - 61 | name: servers 62 | type: "[Server Object]" 63 | description: An optional array of Server Objects which provide connectivity information to a target server. 64 | changelog: 65 | isNew: true 66 | - 67 | name: paths 68 | type: Paths Object 69 | required: true 70 | description: Required. The available paths and operations for the API. 71 | - 72 | name: components 73 | type: Components Object 74 | description: An element to hold various schemas for the specification. 75 | changelog: 76 | isNew: true 77 | - 78 | name: security 79 | type: "[Security Requirement Object]" 80 | description: A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. 81 | - 82 | name: tags 83 | type: "[Tag Object]" 84 | description: A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. 85 | - 86 | name: externalDocs 87 | type: External Documentation Object 88 | description: Additional external documentation. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Operation_Object.yaml: -------------------------------------------------------------------------------- 1 | Operation Object: 2 | description: Describes a single API operation on a path. 3 | allowExtension: true 4 | changelog: 5 | isModified: true 6 | details: | 7 | - Better and consistent parameters description by using `Schema Object` even for atomic ones. 8 | - Request body is now define separetely (`requestBody`). 9 | - Async/event API design is possible thanks to `callbacks` (webhooks). 10 | - The `servers` property enhance documentation and test possibilities (also available on top and path levels). 11 | deletedProperties: 12 | - 13 | name: produces 14 | replacedBy: responses.{HTTP Status}.content.{media type} 15 | specificationAnchor: mediaTypeObject 16 | - 17 | name: consumes 18 | replacedBy: requestBody.content.{media type} 19 | specificationAnchor: mediaTypeObject 20 | - 21 | name: schemes 22 | replacedBy: servers 23 | specificationAnchor: Server Object 24 | fields: 25 | - 26 | name: tags 27 | type: "[string]" 28 | description: A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. 29 | - 30 | name: summary 31 | type: string 32 | description: A short summary of what the operation does. For maximum readability in editing or documentation generation tools, this field SHOULD be less than 120 characters. 33 | - 34 | name: description 35 | type: string 36 | md: CommonMark 37 | description: A verbose explanation of the operation behavior. CommonMark syntax can be used for rich text representation. 38 | - 39 | name: externalDocs 40 | type: External Documentation Object 41 | description: Additional external documentation for this operation. 42 | - 43 | name: operationId 44 | type: string 45 | description: Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions. 46 | - 47 | name: parameters 48 | type: "[Parameter Object]" 49 | allowReference: true 50 | changelog: 51 | isModified: true 52 | details: Does not describe body parameter anymore (see requestBody) 53 | description: A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's parameters. 54 | - 55 | name: requestBody 56 | type: Request Body Object 57 | allowReference: true 58 | required: true 59 | changelog: 60 | isNew: true 61 | details: Replace `parameters` with `in = body` 62 | description: The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers. 63 | - 64 | name: responses 65 | type: Responses Object 66 | required: true 67 | descriptions: The list of possible responses as they are returned from executing this operation. 68 | - 69 | name: callbacks 70 | type: Callbacks Object 71 | changelog: 72 | isNew: true 73 | description: The list of possible callbacks as they are returned from executing this operation. 74 | - 75 | name: deprecated 76 | type: boolean 77 | description: Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. 78 | - 79 | name: security 80 | type: Security Requirement Object 81 | changelog: 82 | isNew: true 83 | description: A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security. To remove a top-level `security` declaration, an empty array can be used. 84 | - 85 | name: servers 86 | type: Server Object 87 | changelog: 88 | isNew: true 89 | description: An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Parameter_Object_Content.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Content: 2 | description: For more complex scenarios a Content Object can be used to define the media type and schema of the parameter. This option is mutually exclusive with the simple scenario above. When example or examples are provided in conjunction with the schema object, the example must follow the prescribed serialization strategy for the parameter. 3 | fieldsGroup: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - name: content 8 | type: Content Object 9 | changelog: 10 | isNew: true 11 | description: The content of the parameter. 12 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Parameter_Object_Style_Schema.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Style Schema: 2 | description: The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a style and schema can be used to describe the structure and syntax of the parameter. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: style 7 | type: string 8 | changelog: 9 | isNew: true 10 | description: | 11 | Describes how the parameter value will be serialized depending on type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form." 12 | - 13 | name: explode 14 | type: boolean 15 | changelog: 16 | isNew: true 17 | description: When this is true, parameter values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. 18 | - 19 | name: allowReserved 20 | type: boolean 21 | changelog: 22 | isNew: true 23 | description: "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false." 24 | - 25 | name: schema 26 | type: Schema Object 27 | allowReference: true 28 | changelog: 29 | isNew: true 30 | description: The schema defining the type used for the parameter. 31 | - 32 | name: examples 33 | type: "[Example Object]" 34 | allowReference: true 35 | changelog: 36 | isNew: true 37 | description: Examples of the content type. Each example in the Examples array SHOULD be in the correct format as specified parameter encoding. The examples object is mutually exclusive to the example object. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema. 38 | - 39 | name: example 40 | type: Example Object 41 | allowReference: true 42 | changelog: 43 | isNew: true 44 | description: Example of the content type. The example object SHOULD be in the correct format as specified in the parameter encoding. The example object is mutually exclusive to the examples object. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the the schema. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Path_Item_Object.yaml: -------------------------------------------------------------------------------- 1 | Path Item Object: 2 | description: | 3 | Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available. 4 | allowExtension: true 5 | changelog: 6 | isModified: true 7 | details: | 8 | - Enhance resource point of view by adding `summary` and `description` on path level. 9 | - HTTP methode `trace` has been added (TRACE allows the client to see what is being received at the other end of the request chain and use that data for testing or diagnostic information. See [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.8).) 10 | - The `servers` property enhance documentation and test possibilities (also available on top and operation levels). 11 | fields: 12 | - 13 | name: summary 14 | type: string 15 | description: An optional, string summary, intended to apply to all operations in this path. 16 | changelog: 17 | isNew: true 18 | - 19 | name: description 20 | type: string 21 | description: An optional, string description, intended to apply to all operations in this path. 22 | changelog: 23 | isNew: true 24 | - 25 | name: get 26 | type: Operation Object 27 | description: A definition of a GET operation on this path. 28 | - 29 | name: put 30 | type: Operation Object 31 | description: A definition of a PUT operation on this path. 32 | - 33 | name: post 34 | type: Operation Object 35 | description: A definition of a POST operation on this path. 36 | - 37 | name: delete 38 | type: Operation Object 39 | description: A definition of a DELETE operation on this path. 40 | - 41 | name: options 42 | type: Operation Object 43 | description: A definition of a OPTIONS operation on this path. 44 | - 45 | name: head 46 | type: Operation Object 47 | description: A definition of a HEAD operation on this path. 48 | - 49 | name: patch 50 | type: Operation Object 51 | description: A definition of a PATCH operation on this path. 52 | - 53 | name: trace 54 | type: Operation Object 55 | description: A definition of a TRACE operation on this path. 56 | changelog: 57 | isNew: true 58 | - 59 | name: servers 60 | type: Server Object 61 | description: An alternative `server` array to service all operations in this path. 62 | changelog: 63 | isNew: true 64 | - 65 | name: parameters 66 | type: "[Parameter Object]" 67 | allowReference: true 68 | description: | 69 | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's parameters. 70 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Paths_Object.yaml: -------------------------------------------------------------------------------- 1 | Paths Object: 2 | description: | 3 | Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the `Server Object` in order to construct the full URL. The Paths MAY be empty, due to ACL constraints. 4 | allowExtension: true 5 | fields: 6 | - name: "/{path}" 7 | type: Path Item Object 8 | required: true 9 | allowReference: true 10 | description: | 11 | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended (no relative URL resolution) to the expanded URL from the `Server Object`'s url field in order to construct the full URL. Path templating is allowed. 12 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Reference_Object.yaml: -------------------------------------------------------------------------------- 1 | Reference Object: 2 | name: $ref 3 | type: string 4 | description: | 5 | A simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse. 6 | 7 | The Reference Object is a JSON Reference that uses a JSON Pointer as its value. For this specification, only canonical dereferencing is supported. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Request_Body_Object.yaml: -------------------------------------------------------------------------------- 1 | Request Body Object: 2 | description: Describes a single request body. 3 | changelog: 4 | isNew: true 5 | allowExtension: true 6 | fields: 7 | - 8 | name: description 9 | type: string 10 | md: CommonMark 11 | description: A brief description of the request body. This could contain examples of use. CommonMark syntax can be used for rich text representation. 12 | - 13 | name: content 14 | type: Content Object 15 | description: The content of the request body. 16 | - 17 | name: required 18 | type: boolean 19 | description: Determines if the request body is required in the request. Defaults to true. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Response_Object.yaml: -------------------------------------------------------------------------------- 1 | Response Object: 2 | description: Describes a single response from an API Operation, including design-time, static links to operations based on the response. 3 | allowExtension: true 4 | changelog: 5 | isModified: true 6 | details: | 7 | - Better control on media type, response handles returned media type with `content.{mediatype}`. It replaces `produces` definition on `Operation Object` or top level. 8 | - Enhanced hypermedia design with `links`. 9 | - Headers are easier to define because they can be defined in `components.headers` and used in `headers` 10 | deletedProperties: 11 | - 12 | name: schema 13 | replacedBy: content.{media type}.schema 14 | see: Media Type Object 15 | - 16 | name: example 17 | replacedBy: content.{media type}.example or content.{media type}.examples 18 | see: Media Type Object 19 | fields: 20 | - 21 | name: description 22 | type: string 23 | isRequired: true 24 | md: CommonMark 25 | description: A short description of the response. CommonMark syntax can be used for rich text representation. 26 | - 27 | name: headers 28 | type: Headers Object 29 | changelog: 30 | isModified: true 31 | details: Headers can now be defined in the root `components` 32 | description: A list of headers that are sent with the response. 33 | - 34 | name: content 35 | type: Content Object 36 | changelog: 37 | isNew: true 38 | details: Replace `schema` but also `Operation Object.produces` or `Open API Object.produces` 39 | description: An object containing descriptions of potential response payloads. 40 | - 41 | name: links 42 | type: Links Object 43 | changelog: 44 | isNew: true 45 | description: An object representing operations related to the response payload. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Responses_Object.yaml: -------------------------------------------------------------------------------- 1 | Responses Object: 2 | description: | 3 | A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors. 4 | 5 | The default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification. 6 | 7 | The Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful operation call. 8 | allowExtension: true 9 | changelog: 10 | isModified: true 11 | fields: 12 | - 13 | name: default 14 | allowReference: true 15 | type: Response Object 16 | description: The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. Reference Object can be used to link to a response that is defined at the Swagger Object's responses section. 17 | - 18 | name: "{HTTP status code}" 19 | allowReference: true 20 | type: Response Object 21 | changelog: 22 | isModified: true 23 | details: Wildcard are now allowed (2XX for example) 24 | description: Any HTTP status code can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. Reference Object can be used to link to a response that is defined at the OpenAPI Object's responses section. This field MUST be quoted for compatibility between JSON and YAML (i.e. "200"), and MAY contain the uppercase character, X to designate a wildcard, such as 2XX to represent all response codes between [200-299]. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Schema_Object.yaml: -------------------------------------------------------------------------------- 1 | Schema Object: 2 | description: | 3 | The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the [JSON Schema Specification Wright Draft 00](http://json-schema.org/). 4 | 5 | Further information about the properties can be found in [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00) and [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00). Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here. 6 | 7 | Alternatively, any time a Schema Object can be used, a Reference Object can be used in its place. This allows referencing definitions in place of defining them inline. 8 | 9 | Additional properties defined by the JSON Schema specification that are not mentioned here are strictly unsupported. 10 | allowExtension: true 11 | changelog: 12 | isModified: true 13 | details: | 14 | - Enhanced consistency and easier design with extensive use of Schema Object for all definitions (parameters, bodies, responses, headers) 15 | - Inheritance and polymorphism mecanism has been enhanced (`oneOf`, `anyOf` and `not` have been added) and clarified (see new `discriminator` behaviour). 16 | - Creating read/write models is easier with `readOnly` (behaviour modified) and `writeOnly` (new). 17 | - Enhance versioning thanks to `deprecated`. 18 | - Better documentation with the possibility to have multiple `examples`. 19 | fields: 20 | - 21 | name: 22 | type: Schema Object JSON 23 | changelog: 24 | isModified: true 25 | description: JSON Schema Properties 26 | - 27 | name: 28 | type: Schema Object OpenAPI 29 | changelog: 30 | isModified: true 31 | description: Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Schema_Object_Array.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Array: 2 | description:: Fields if type is array. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: items 7 | type: Items Object 8 | description: Describes the type of items in the array. 9 | - 10 | name: maxItems 11 | type: number 12 | description: Maximum count of items in array 13 | - 14 | name: minItems 15 | type: number 16 | description: Minimum count of items in array. 17 | - 18 | name: uniqueItems 19 | type: boolean 20 | description: Allow only unique items in array. 21 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Schema_Object_JSON.yaml: -------------------------------------------------------------------------------- 1 | Schema Object JSON: 2 | description: The following properties are taken directly from the JSON Schema definition and follow the same specifications 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: 7 | type: Schema Object Modified JSON 8 | changelog: 9 | isModified: true 10 | description: The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification. 11 | - 12 | name: 13 | type: Schema Object Array 14 | description: Properties when *type* is *array* 15 | - 16 | name: 17 | type: Schema Object String 18 | description: Properties when *type* is *string* 19 | - 20 | name: 21 | type: Schema Object Number Or Integer 22 | description: Properties when *type* is *number* or *integer* 23 | - 24 | name: 25 | type: Schema Object Object 26 | description: Properties when *type* is *object* -------------------------------------------------------------------------------- /data/3.0.0-rc0/Schema_Object_Number_Or_Integer.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Number Or Integer: 2 | description: A number or integer value 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: format 7 | type: string 8 | description: | 9 | The extending format for the previously mentioned type. 10 | See Data Type Formats for further details. 11 | 12 | Common Name | type | format| Comments 13 | ------------|------|-------|--------- 14 | integer | integer | int32 | signed 32 bits 15 | long | integer | int64 | signed 64 bits 16 | float | number | float | 17 | double | number | double| 18 | 19 | - 20 | name: maximum 21 | type: number 22 | description: | 23 | Maximum value. 24 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 25 | - 26 | name: exclusiveMaximum 27 | type: boolean 28 | description: | 29 | Indicate if the value must be < maximum. 30 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 31 | - 32 | name: minimum 33 | type: number 34 | description: | 35 | Minimum value. 36 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 37 | - 38 | name: exclusiveMinimum 39 | type: boolean 40 | description: | 41 | Indicate if the value must value > minimum. 42 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 43 | - 44 | name: multipleOf 45 | type: number 46 | description: | 47 | The value must be a multiple of *multiplOf*. 48 | See http://json-schema.org/latest/json-schema-validation.html#anchor14. 49 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Schema_Object_Object.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Object: 2 | fieldsGroup: true 3 | description: type value is object. 4 | fields: 5 | - 6 | name: properties 7 | description: List of properties. 8 | type: '[Schema Object | Reference Object]' 9 | noFollow: true 10 | - 11 | name: additionalProperties 12 | description: Additionnal properties to create a map. 13 | type: '[Schema Object | Reference Object]' 14 | noFollow: true 15 | - 16 | name: required 17 | type: "[string]" 18 | description: The list of required properties. 19 | - 20 | name: maxProperties 21 | type: integer 22 | description: An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. 23 | - 24 | name: minProperties 25 | type: integer 26 | description: An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Schema_Object_OpenAPI.yaml: -------------------------------------------------------------------------------- 1 | Schema Object OpenAPI: 2 | fieldsGroup: true 3 | description: Other than the JSON Schema subset fields, the following fields may be used for further schema documentation. 4 | fields: 5 | - 6 | name: nullable 7 | type: boolean 8 | changelog: 9 | isNew: true 10 | description: Allows sending a null value for the defined schema. Default value is false. 11 | - 12 | name: discriminator 13 | type: string 14 | changelog: 15 | isModified: true 16 | details: Composition and inheritance mecanism has been clarified. 17 | description: | 18 | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it. See [Composition and Inheritance](https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md#schemaComposition) for more details. 19 | - 20 | name: readOnly 21 | type: boolean 22 | changelog: 23 | isModified: true 24 | details: Light behavior modification concerning a required property (see description and also the new property `writeOnly`) 25 | description: | 26 | Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false. 27 | - 28 | name: writeOnly 29 | type: boolean 30 | changelog: 31 | isNew: true 32 | description: | 33 | Relevant only for Schema "properties" definitions. Declares the property as "write only". This means that it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false. 34 | - 35 | name: xml 36 | type: XML Object 37 | description: | 38 | This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property. 39 | - 40 | name: externalDocs 41 | type: External Documentation Object 42 | description: Additional external documentation for this schema. 43 | - 44 | name: example 45 | type: Any 46 | description: A free-form property to include an example of an instance for this schema. 47 | - 48 | name: examples 49 | type: Any 50 | changelog: 51 | isNew: true 52 | description: An array of free-formed properties to include examples for this schema. 53 | - 54 | name: deprecated 55 | type: boolean 56 | changelog: 57 | isNew: true 58 | description: Specifies that a schema is deprecated and SHOULD be transitioned out of usage. 59 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Schema_Object_String.yaml: -------------------------------------------------------------------------------- 1 | Schema Object String: 2 | description: type value is string 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: format 7 | type: String 8 | description: | 9 | The extending format for the previously mentioned type. 10 | See Data Type Formats for further details. 11 | 12 | Common Name | format | Comments 13 | ------------|-----------|--------- 14 | byte | byte | base64 encoded characters 15 | binary | binary | any sequence of octets 16 | date | date | As defined by full-date - RFC3339 17 | dateTime | date-time | As defined by date-time - RFC3339 18 | password | password | Used to hint UIs the input needs to be obscured. 19 | - 20 | name: pattern 21 | type: string 22 | description: | 23 | This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. 24 | See http://json-schema.org/latest/json-schema-validation.html#anchor33. 25 | See https://regex101.com/ 26 | - 27 | name: maxLength 28 | type: integer 29 | description: | 30 | Maximum string's length. 31 | See http://json-schema.org/latest/json-schema-validation.html#anchor26. 32 | - 33 | name: minLength 34 | type: integer 35 | description: | 36 | Minimum string's length. 37 | See http://json-schema.org/latest/json-schema-validation.html#anchor29. 38 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Scopes_Object.yaml: -------------------------------------------------------------------------------- 1 | Scopes Object: 2 | description: Lists the available scopes for an OAuth2 security scheme. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: "{name}" 7 | type: string 8 | description: Maps between a name of a scope to a short description of it (as the value of the property). 9 | patterned: true -------------------------------------------------------------------------------- /data/3.0.0-rc0/Security_Requirement_Object.yaml: -------------------------------------------------------------------------------- 1 | Security Requirement Object: 2 | allowExtension: true 3 | description: | 4 | Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object. 5 | 6 | Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where there multiple query parameters or HTTP headers are required to convey security information. 7 | 8 | When a list of Security Requirement Objects is defined on the Open API object or Operation Object, only one of Security Requirement Objects in the list needs to be satisfied to authorize. 9 | fields: 10 | - 11 | name: "{name}" 12 | type: "[string]" 13 | description: | 14 | Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. 15 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Security_Scheme_Object.yaml: -------------------------------------------------------------------------------- 1 | Security Scheme Object: 2 | description: Allows the definition of a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code). 3 | changelog: 4 | isModified: true 5 | details: | 6 | - Better overall security definitions with: 7 | - a more generic HTTP authentication (that goes beyond the previous `basic` type) 8 | - a more complete Oauth2 description (`OAuth Flows Object`) including some OpenId connect aspect (`openIdConnectUrl`) 9 | - APIKey support is unchanged 10 | deletedProperties: 11 | - 12 | name: apiKey 13 | replacedBy: name 14 | see: Security Scheme Object 15 | - 16 | name: authorizationUrl 17 | replacedBy: flow..authorizationUrl 18 | see: Oauth Flows Object 19 | - 20 | name: tokenUrl 21 | replacedBy: flow..tokenUrl 22 | see: Oauth Flows Object 23 | - 24 | name: scopes 25 | replacedBy: flow..scopes 26 | see: Oauth Flows Object 27 | 28 | allowExtension: true 29 | fields: 30 | - 31 | name: type 32 | type: string 33 | validity: Any 34 | required: true 35 | changelog: 36 | isUpdated: true 37 | details: "`basic` type is replaced by `http`, `openIdConnect` type has been added" 38 | description: The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect". 39 | - 40 | name: description 41 | type: string 42 | validity: Any 43 | description: A short description for security scheme. 44 | - 45 | name: name 46 | required: true 47 | type: string 48 | validity: apikey 49 | description: The name of the header or query parameter to be used. 50 | - 51 | name: in 52 | required: true 53 | type: string 54 | validity: apikey 55 | description: The location of the API key. Valid values are "query" or "header". 56 | - 57 | name: scheme 58 | type: string 59 | required: true 60 | validity: http 61 | changelog: 62 | isNew: true 63 | description: The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.2). 64 | - 65 | name: bearerFormat 66 | type: string 67 | validity: http("bearer") 68 | changelog: 69 | isNew: true 70 | description: A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. 71 | - 72 | name: flow 73 | type: OAuth Flows Object 74 | validity: oauth2 75 | required: true 76 | changelog: 77 | isModified: true 78 | details: | 79 | `flow` is now a OAuth Flows Object (was a string) and define all Oauth2 properties. The original flow value is replaced by using the matching property in Oauth Flows Object. 80 | description: An object containing configuration information for the flow types supported. 81 | - 82 | name: openIdConnectUrl 83 | type: string 84 | validity: openIdConnect 85 | required: true 86 | changelog: 87 | isNew: true 88 | description: OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. 89 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Server_Object.yaml: -------------------------------------------------------------------------------- 1 | Server Object: 2 | description: An object representing a Server. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | details: Replace `host`, `basePath` and `schemes` properties from root object. 7 | fields: 8 | - name: url 9 | type: string 10 | required: true 11 | description: A URL to the target host. This URL supports Server Variables and may be relative, to indicate that the host location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be made when a variable is named in {brackets}. 12 | - name: description 13 | type: string 14 | description: An optional string describing the host designated by the URL. 15 | - name: variables 16 | type: Server Variables Object 17 | description: An object holding variables for substitution in the URL template. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Server_Variable_Object.yaml: -------------------------------------------------------------------------------- 1 | Server Variable Object: 2 | description: An object representing a Server Variable for server URL template substitution. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - name: enum 8 | type: "[primitive]" 9 | description: An enumeration of primitive type values to be used if the substitution options are from a limited set. 10 | - name: default 11 | required: true 12 | type: primitive 13 | description: Required. The default value to use for substitution if an alternate value is not specified, and will be sent if an alternative value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer. 14 | - name: description 15 | type: string 16 | description: An optional description for the server variable. -------------------------------------------------------------------------------- /data/3.0.0-rc0/Server_Variables_Object.yaml: -------------------------------------------------------------------------------- 1 | Server Variables Object: 2 | description: An object holding variables for substitution in the URL template. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - name: "{name}" 8 | type: Server Variable Object 9 | description: A single definition, mapping a *name* to the schema it defines. 10 | patterned: true -------------------------------------------------------------------------------- /data/3.0.0-rc0/Specification_Extensions.yaml: -------------------------------------------------------------------------------- 1 | Specification Extensions: 2 | name: ^x- 3 | type: Any 4 | patterned: true 5 | openapiType: true 6 | specificationAnchor: specificationExtensions 7 | description: | 8 | While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points. 9 | 10 | The extensions properties are implemented as patterned fields that are always prefixed by "x-". 11 | 12 | | Field Pattern | Type | Description 13 | |---------------|-------|-------------- 14 | |^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with x-, for example, x-internal-id. The value can be null, a primitive, an array or an object. Can have any valid JSON format value. The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). -------------------------------------------------------------------------------- /data/3.0.0-rc0/Tag_Object.yaml: -------------------------------------------------------------------------------- 1 | Tag Object: 2 | description: Allows adding meta data to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag used there. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: name 7 | type: string 8 | description: The name of the tag. 9 | required: true 10 | - 11 | name: description 12 | type: string 13 | description: A short description for the tag. CommonMark syntax can be used for rich text representation. 14 | md: CommonMark 15 | - 16 | name: externalDocs 17 | type: ExternalDocumentation 18 | description: Additional external documentation for this tag. 19 | -------------------------------------------------------------------------------- /data/3.0.0-rc0/Z_Object.yaml: -------------------------------------------------------------------------------- 1 | Z Object: 2 | description: tmp 3 | fields: 4 | - name: tmp 5 | type: string 6 | description: tmp -------------------------------------------------------------------------------- /data/3.0.1/Callback_Object.yaml: -------------------------------------------------------------------------------- 1 | Callback Object: 2 | changelog: 3 | isNew: true 4 | allowExtension: true 5 | description: A map of possible out-of band callbacks related to the parent operation. Each value in the map is a [Path Item Object](#pathItemObject) that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. 6 | fields: 7 | - name: "{expression}" 8 | type: Path Item Object 9 | noFollow: true 10 | description: | 11 | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. 12 | -------------------------------------------------------------------------------- /data/3.0.1/Components_Object.yaml: -------------------------------------------------------------------------------- 1 | Components Object: 2 | description: Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | details: Contains former root `responses`, `parameters` (split into `parameters` and `requestBodies`) and `definitions` (as `schemas`). 7 | fields: 8 | - 9 | name: schemas 10 | type: "{Schema Object}" 11 | changelog: 12 | isInfo: true 13 | details: Replace root `definitions` 14 | description: An object to hold reusable [Schema Objects](#schemaObject). 15 | - 16 | name: responses 17 | type: "{Response Object}" 18 | changelog: 19 | isInfo: true 20 | details: Replace root `responses` 21 | description: An object to hold reusable [Response Objects](#responseObject). 22 | - 23 | name: parameters 24 | type: "{Parameter Object}" 25 | changelog: 26 | isInfo: true 27 | details: Replace root `parameters` (Only non body parameters, body ones are in `requestBodies`). 28 | description: An object to hold reusable [Parameter Objects](#parameterObject). 29 | - 30 | name: examples 31 | type: "{Example Object}" 32 | description: An object to hold reusable [Example Objects](#exampleObject). 33 | - 34 | name: requestBodies 35 | type: "{Request Body Object}" 36 | changelog: 37 | isInfo: true 38 | details: Partially replace root `parameters` (Body parameters only, others are in `parameters`). 39 | description: An object to hold reusable [Request Body Objects](#requestBodyObject). 40 | - 41 | name: headers 42 | type: "{Header Object}" 43 | description: An object to hold reusable [Header Objects](#headerObject). 44 | - 45 | name: securitySchemes 46 | type: "{Security Scheme Object}" 47 | changelog: 48 | isInfo: true 49 | details: Replace root `securityDefinitions`. 50 | description: An object to hold reusable [Security Scheme Objects](#securitySchemeObject). 51 | - 52 | name: links 53 | type: "{Link Object}" 54 | description: An object to hold reusable [Link Objects](#linkObject). 55 | - 56 | name: callbacks 57 | type: "{Callback Object}" 58 | description: An object to hold reusable [Callback Objects](#callbackObject). 59 | -------------------------------------------------------------------------------- /data/3.0.1/Contact_Object.yaml: -------------------------------------------------------------------------------- 1 | Contact Object: 2 | description: Contact information for the exposed API. 3 | allowExtension: true 4 | fields: 5 | - name: name 6 | type: string 7 | description: The identifying name of the contact person/organization. 8 | - name: url 9 | type: string 10 | description: | 11 | The URL pointing to the contact information. MUST be in the format of a URL. 12 | - name: email 13 | type: string 14 | description: | 15 | The email address of the contact person/organization. MUST be in the format of an email address. 16 | -------------------------------------------------------------------------------- /data/3.0.1/Discriminator_Object.yaml: -------------------------------------------------------------------------------- 1 | Discriminator Object: 2 | description: | 3 | When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. 4 | 5 | When using the discriminator, _inline_ schemas will not be considered. 6 | 7 | The discriminator attribute is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`. 8 | 9 | See [Discrimitor Object](#discriminatorObject) for complete examples. 10 | allowExtension: true 11 | changelog: 12 | isNew: true 13 | fields: 14 | - 15 | name: propertyName 16 | type: string 17 | required: true 18 | description: The name of the property in the payload that will hold the discriminator value. 19 | - 20 | name: mapping 21 | type: "{propertyName value, string}" 22 | description: | 23 | An object to hold mappings between payload values and schema names or references. 24 | 25 | In scenarios where the value of the discriminator field does not match the schema name or implicit mapping is not possible, an optional `mapping` definition MAY be used. 26 | 27 | See [Discrimitor Object](#discriminatorObject) for complete examples. -------------------------------------------------------------------------------- /data/3.0.1/Encoding_Object.yaml: -------------------------------------------------------------------------------- 1 | Encoding Object: 2 | description: A single encoding definition applied to a single schema property. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - 8 | name: contentType 9 | type: string 10 | description: | 11 | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. 12 | - 13 | name: headers 14 | type: Header Object 15 | allowReference: true 16 | noFollow: true 17 | description: A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. 18 | - 19 | name: style 20 | type: string 21 | description: Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameterObject) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. 22 | - 23 | name: explode 24 | type: boolean 25 | description: When this is true, property values of type `array` or `object` generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. 26 | - 27 | name: allowReserved 28 | type: boolean 29 | description: Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -------------------------------------------------------------------------------- /data/3.0.1/Example_Object.yaml: -------------------------------------------------------------------------------- 1 | Example Object: 2 | description: In all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible. 3 | changelog: 4 | isNew: true 5 | allowExtension: true 6 | fields: 7 | - 8 | name: summary 9 | type: string 10 | description: Short description for the example. 11 | - 12 | name: description 13 | type: string 14 | description: Long description for the example. 15 | md: CommonMark 16 | - 17 | name: value 18 | type: Any 19 | description: Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. -------------------------------------------------------------------------------- /data/3.0.1/External_Documentation_Object.yaml: -------------------------------------------------------------------------------- 1 | External Documentation Object: 2 | description: Allows referencing an external resource for extended documentation. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: description 7 | type: string 8 | description: A short description of the target documentation. 9 | md: CommonMark 10 | - 11 | name: url 12 | type: string 13 | description: The URL for the target documentation. Value MUST be in the format of a URL. 14 | required: true 15 | -------------------------------------------------------------------------------- /data/3.0.1/Header_Object.yaml: -------------------------------------------------------------------------------- 1 | Header Object: 2 | description: | 3 | The Header Object follows the structure of the [Parameter Object](#parameterObject) with the following changes: 4 | 5 | 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map. 6 | 1. `in` MUST NOT be specified, it is implicitly in `header`. 7 | 1. All traits that are affected by the location MUST be applicable to a location of `header` (for example, [`style`](#parameterStyle)). 8 | 9 | Note: allowEmptyValue shouldn't be used too (only for query parameters) 10 | allowExtension: true 11 | changelog: 12 | isModified: true 13 | details: Response headers are defined almost like parameters and can now be defined in `OpenAPI Object.components.headers` and reused with a `$ref`. 14 | deletedProperties: 15 | - 16 | name: default 17 | replacedBy: schema.default or content.{media type}.schema.default 18 | see: Schema Object 19 | - 20 | name: items 21 | replacedBy: schema.items or content.{media type}.schema.items 22 | see: Schema Object 23 | - 24 | name: collectionFormat 25 | replacedBy: schema.collectionFormat or content.{media type}.schema.collectionFormat 26 | see: Schema Object 27 | - 28 | name: maxItems 29 | replacedBy: schema.maxItems or content.{media type}.schema.maxItems 30 | see: Schema Object 31 | - 32 | name: minItems 33 | replacedBy: schema.minItems or content.{media type}.schema.minItems 34 | see: Schema Object 35 | - 36 | name: uniqueItems 37 | replacedBy: schema.uniqueItems or content.{media type}.schema.uniqueItems 38 | see: Schema Object 39 | - 40 | name: format 41 | replacedBy: schema.format or content.{media type}.schema.format 42 | see: Schema Object 43 | - 44 | name: enum 45 | replacedBy: schema.enum or content.{media type}.schema.enum 46 | see: Schema Object 47 | - 48 | name: pattern 49 | replacedBy: schema.pattern or content.{media type}.schema.pattern 50 | see: Schema Object 51 | - 52 | name: maxLength 53 | replacedBy: schema.maxLength or content.{media type}.schema.maxLength 54 | see: Schema Object 55 | - 56 | name: minLength 57 | replacedBy: schema.minLength or content.{media type}.schema.minLength 58 | see: Schema Object 59 | - 60 | name: maximum 61 | replacedBy: schema.maximum or content.{media type}.schema.maximum 62 | see: Schema Object 63 | - 64 | name: exclusiveMaximum 65 | replacedBy: schema.exclusiveMaximum or content.{media type}.schema.exclusiveMaximum 66 | see: Schema Object 67 | - 68 | name: minimum 69 | replacedBy: schema.minimum or content.{media type}.schema.minimum 70 | see: Schema Object 71 | - 72 | name: exclusiveMinimum 73 | replacedBy: schema.exclusiveMinimum or content.{media type}.schema.exclusiveMinimum 74 | see: Schema Object 75 | - 76 | name: multipleOf 77 | replacedBy: schema.multipleOf or content.{media type}.schema.multipleOf 78 | see: Schema Object 79 | 80 | fields: 81 | - 82 | name: description 83 | type: string 84 | md: CommonMark 85 | description: | 86 | A brief description of the header. This could contain examples of use. CommonMark syntax can be used for rich text representation. 87 | - 88 | name: required 89 | type: boolean 90 | description: | 91 | Determines whether this header is mandatory (always returnd). Its default value is false. 92 | - 93 | name: deprecated 94 | type: boolean 95 | description: Specifies that a header is deprecated and SHOULD be transitioned out of usage. 96 | changelog: 97 | isNew: true 98 | - 99 | name: 100 | type: Header Object Style Schema 101 | description: The rules for serialization of the header are specified in one of two ways. For simpler scenarios, a [`style`](#parameterSchema) and [`schema`](#parameterStyle) can be used to describe the structure and syntax of the parameter. 102 | - 103 | name: 104 | type: Header Object Content 105 | description: For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the header. A header MUST contain either a `schema` property, or a `content` property, but not both. When example or examples are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the header. -------------------------------------------------------------------------------- /data/3.0.1/Header_Object_Content.yaml: -------------------------------------------------------------------------------- 1 | Header Object Content: 2 | description: For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. A parameter MUST contain either a `schema` property, or a `content` property, but not both. When example or examples are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. 3 | fieldsGroup: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - name: content 8 | type: "{media type, Media Type Object}" 9 | changelog: 10 | isNew: true 11 | details: Replace operation's `consumes`. 12 | description: A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry. 13 | -------------------------------------------------------------------------------- /data/3.0.1/Header_Object_Style_Schema.yaml: -------------------------------------------------------------------------------- 1 | Header Object Style Schema: 2 | description: | 3 | _Reminder: The Header Object follows the structure of the [Parameter Object](#parameterObject) with some adaptations. See [Header Object](#headerObject)._ 4 | 5 | The rules for serialization of the header are specified in one of two ways. For simpler scenarios, a [`style`](#parameterSchema) and [`schema`](#parameterStyle) can be used to describe the structure and syntax of the parameter. 6 | fieldsGroup: true 7 | changelog: 8 | isNew: true 9 | fields: 10 | - 11 | name: style 12 | type: string 13 | changelog: 14 | isNew: true 15 | description: | 16 | Describes how the header value will be serialized depending on the type of the parameter value. Default value is `simple` (because it's a Header Object). 17 | - 18 | name: explode 19 | type: boolean 20 | changelog: 21 | isNew: true 22 | description: When this is true, headers values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. 23 | # Need to check if allowReserved make sense for a header 24 | - 25 | name: allowReserved 26 | type: boolean 27 | changelog: 28 | isNew: true 29 | description: Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. 30 | - 31 | name: schema 32 | type: Schema Object 33 | allowReference: true 34 | changelog: 35 | isNew: true 36 | description: The schema defining the type used for the header. 37 | - 38 | name: example 39 | type: Any 40 | allowReference: true 41 | changelog: 42 | isNew: true 43 | description: Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. 44 | - 45 | name: examples 46 | type: "{Example Object}" 47 | allowReference: true 48 | changelog: 49 | isNew: true 50 | description: Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. -------------------------------------------------------------------------------- /data/3.0.1/Info_Object.yaml: -------------------------------------------------------------------------------- 1 | Info Object: 2 | description: Provides metadata about the API. The metadata can be used by the clients if needed. 3 | allowExtension: true 4 | fields: 5 | - name: title 6 | type: string 7 | required: true 8 | description: The title of the application. 9 | - name: description 10 | type: string 11 | md: CommonMark 12 | description: A short description of the application. 13 | - name: termsOfService 14 | type: string 15 | description: A URL to the Terms of Service for the API. MUST be in the format of a URL. 16 | - name: contact 17 | type: Contact Object 18 | description: The contact information for the exposed API. 19 | - name: licence 20 | type: Licence Object 21 | description: The license information for the exposed API. 22 | - name: version 23 | type: string 24 | required: true 25 | description: The version of the API definition (which is distinct from the OpenAPI specification version or the API implementation version). 26 | -------------------------------------------------------------------------------- /data/3.0.1/Licence_Object.yaml: -------------------------------------------------------------------------------- 1 | Licence Object: 2 | description: License information for the exposed API. 3 | allowExtension: true 4 | fields: 5 | - name: name 6 | type: string 7 | required: true 8 | description: The license name used for the API. 9 | - name: url 10 | type: string 11 | description: | 12 | A URL to the license used for the API. MUST be in the format of a URL. -------------------------------------------------------------------------------- /data/3.0.1/Link_Object.yaml: -------------------------------------------------------------------------------- 1 | Link Object: 2 | description: The Link Object is responsible for defining a possible operation based on a single response. 3 | specificationAnchor: link-object 4 | allowExtension: true 5 | changelog: 6 | isNew: true 7 | fields: 8 | - 9 | name: href 10 | type: string 11 | description: a relative or absolute URL to a linked resource. This field is mutually exclusive with the operationId field. 12 | - 13 | name: operationId 14 | type: string 15 | description: the name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive with the href field. Relative href values MAY be used to locate an existing Operation Object in the OAS. 16 | - 17 | name: parameters 18 | type: Link Parameters Object 19 | description: an object representing parameters to pass to an operation as specified with operationId or identified via href. 20 | - 21 | name: headers 22 | type: Headers Object 23 | description: an object representing headers to pass to the linked resource. Where conflicts occur between these headers, and those defined in the related operation, these headers override. 24 | - 25 | name: description 26 | type: string 27 | md: CommonMark 28 | description: a description of the link, supports CommonMark syntax. 29 | -------------------------------------------------------------------------------- /data/3.0.1/Media_Type_Object.yaml: -------------------------------------------------------------------------------- 1 | Media Type Object: 2 | description: Each Media Type Object provides schema and examples for the media type identified by its key. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | details: Replace operation's `consumes` and `produces` 7 | fields: 8 | - name: schema 9 | type: Schema Object 10 | description: The schema defining the type used for the request body. 11 | - 12 | name: examples 13 | type: "{Example Object}" 14 | allowReference: true 15 | description: Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. 16 | - 17 | name: example 18 | type: Example Object 19 | allowReference: true 20 | description: Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. 21 | - 22 | name: encoding 23 | type: "{property name, Encoding Object}" 24 | description: A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to `requestBody` objects when the media type is `multipart` or `application/x-www-form-urlencoded`. -------------------------------------------------------------------------------- /data/3.0.1/OpenAPI_Object.yaml: -------------------------------------------------------------------------------- 1 | OpenAPI Object: 2 | name: OpenAPI 3.0 3 | specificationAnchor: oasObject 4 | description: | 5 | OpenAPI 3.0 top level object. 6 | This is the root document object for the OpenAPI Specification document. 7 | allowExtension: true 8 | changelog: 9 | isModified: true 10 | details: | 11 | The new OpenAPI Specification version 3.0 offers many welcomed improvements and new features (see OpenAPI [blog post series about this](https://www.openapis.org/news/blogs/2016/10/tdc-structural-improvements-explaining-30-spec-part-2)). 12 | 13 | Here are the noticeable changes on top level (*navigate through the tree to see what happened on other levels*): 14 | - Bye bye `swagger` and hello `openapi`. 15 | - Reusable definitions are centralized in `components` making the document more consistent (the previous version mixed reusable and global definitions on the same level). 16 | 17 | deletedProperties: 18 | - name: swagger 19 | replacedBy: openapi 20 | see: OpenAPI Object 21 | - name: host 22 | replacedBy: servers[].url 23 | see: Server Object 24 | - name: basePath 25 | replacedBy: servers[].url 26 | see: Server Object 27 | - name: schemes 28 | replacedBy: servers[].url 29 | see: Server Object 30 | - name: definitions 31 | replacedBy: components.schemas 32 | see: Components Object 33 | - name: parameters 34 | replacedBy: components.parameters and components.requestBodies 35 | see: Components Object 36 | - name: securityDefinitions 37 | replacedBy: components.securitySchemas 38 | see: Components Object 39 | - name: consumes 40 | replacedBy: Content Object.{media type} 41 | see: Content Object 42 | - name: produces 43 | replacedBy: Content Object.{media type} 44 | see: Content Object 45 | fields: 46 | - 47 | name: openapi 48 | type: string 49 | required: true 50 | changelog: 51 | isNew: true 52 | details: Replace the `swagger` property 53 | description: | 54 | This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string. 55 | - 56 | name: info 57 | type: Info Object 58 | required: true 59 | description: Provides metadata about the API. The metadata MAY be used by tooling as required. 60 | - 61 | name: servers 62 | type: "[Server Object]" 63 | description: An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a `Server Object` with a `url` value of `/`. 64 | changelog: 65 | isNew: true 66 | - 67 | name: paths 68 | type: Paths Object 69 | required: true 70 | description: The available paths and operations for the API. 71 | - 72 | name: components 73 | type: Components Object 74 | description: An element to hold various schemas for the specification. 75 | changelog: 76 | isNew: true 77 | details: Replace `definitions`, `parameters` and `securityDefinitions` 78 | - 79 | name: security 80 | type: "[Security Requirement Object]" 81 | description: A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. 82 | - 83 | name: tags 84 | type: "[Tag Object]" 85 | description: A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. 86 | - 87 | name: externalDocs 88 | type: External Documentation Object 89 | description: Additional external documentation. -------------------------------------------------------------------------------- /data/3.0.1/Operation_Object.yaml: -------------------------------------------------------------------------------- 1 | Operation Object: 2 | description: Describes a single API operation on a path. 3 | allowExtension: true 4 | changelog: 5 | isModified: true 6 | details: | 7 | - Better and consistent parameters description by using `Schema Object` even for atomic ones. 8 | - Request body is now defined separetely (`requestBody`). 9 | - Async/event API design is possible thanks to `callbacks` (webhooks). 10 | - The `servers` property enhance documentation and test possibilities (also available on top and path levels). 11 | deletedProperties: 12 | - 13 | name: produces 14 | replacedBy: responses.{HTTP Status}.content.{media type} 15 | specificationAnchor: mediaTypeObject 16 | - 17 | name: consumes 18 | replacedBy: requestBody.content.{media type} 19 | specificationAnchor: mediaTypeObject 20 | - 21 | name: schemes 22 | replacedBy: servers 23 | specificationAnchor: Server Object 24 | fields: 25 | - 26 | name: tags 27 | type: "[string]" 28 | description: A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. 29 | - 30 | name: summary 31 | type: string 32 | description: A short summary of what the operation does. For maximum readability in editing or documentation generation tools, this field SHOULD be less than 120 characters. 33 | - 34 | name: description 35 | type: string 36 | md: CommonMark 37 | description: A verbose explanation of the operation behavior. CommonMark syntax can be used for rich text representation. 38 | - 39 | name: externalDocs 40 | type: External Documentation Object 41 | description: Additional external documentation for this operation. 42 | - 43 | name: operationId 44 | type: string 45 | description: Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions. 46 | - 47 | name: parameters 48 | type: "[Parameter Object]" 49 | allowReference: true 50 | changelog: 51 | isModified: true 52 | details: Does not describe body parameter anymore (see requestBody) 53 | description: A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). 54 | - 55 | name: requestBody 56 | type: Request Body Object 57 | allowReference: true 58 | required: true 59 | changelog: 60 | isNew: true 61 | details: Replace `parameters` with `in = body` 62 | description: The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. 63 | - 64 | name: responses 65 | type: Responses Object 66 | required: true 67 | descriptions: The list of possible responses as they are returned from executing this operation. 68 | - 69 | name: callbacks 70 | type: "{expression idenfiying URL, Callback Object}" 71 | changelog: 72 | isNew: true 73 | description: A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. 74 | - 75 | name: deprecated 76 | type: boolean 77 | description: Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. 78 | - 79 | name: security 80 | type: Security Requirement Object 81 | changelog: 82 | isNew: true 83 | description: A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. 84 | - 85 | name: servers 86 | type: Server Object 87 | changelog: 88 | isNew: true 89 | description: An alternative `server` array to service this operation. If an alternative `server` object is specified at the Path Item Object or Root level, it will be overridden by this value. -------------------------------------------------------------------------------- /data/3.0.1/Parameter_Object_Content.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Content: 2 | description: For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. A parameter MUST contain either a `schema` property, or a `content` property, but not both. When example or examples are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. 3 | fieldsGroup: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - name: content 8 | type: "{media type,Media Type Object}" 9 | changelog: 10 | isNew: true 11 | details: Replace operation's `consumes`. 12 | description: A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry. 13 | -------------------------------------------------------------------------------- /data/3.0.1/Parameter_Object_Style_Schema.yaml: -------------------------------------------------------------------------------- 1 | Parameter Object Style Schema: 2 | description: The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a [`style`](#parameterSchema) and [`schema`](#parameterStyle) can be used to describe the structure and syntax of the parameter. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: style 7 | type: string 8 | changelog: 9 | isNew: true 10 | description: | 11 | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. 12 | - 13 | name: explode 14 | type: boolean 15 | changelog: 16 | isNew: true 17 | description: When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. 18 | - 19 | name: allowReserved 20 | type: boolean 21 | changelog: 22 | isNew: true 23 | description: Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. 24 | - 25 | name: schema 26 | type: Schema Object 27 | allowReference: true 28 | changelog: 29 | isNew: true 30 | description: The schema defining the type used for the parameter. 31 | - 32 | name: example 33 | type: Any 34 | allowReference: true 35 | changelog: 36 | isNew: true 37 | description: Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. 38 | - 39 | name: examples 40 | type: "{Example Object}" 41 | allowReference: true 42 | changelog: 43 | isNew: true 44 | description: Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. -------------------------------------------------------------------------------- /data/3.0.1/Path_Item_Object.yaml: -------------------------------------------------------------------------------- 1 | Path Item Object: 2 | description: | 3 | Describes the operations available on a single path. A Path Item MAY be empty, due to [ACL constraints](#securityFiltering). The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available. 4 | allowExtension: true 5 | changelog: 6 | isModified: true 7 | details: | 8 | - Enhance resource point of view by adding `summary` and `description` on path level. 9 | - HTTP methode `trace` has been added (TRACE allows the client to see what is being received at the other end of the request chain and use that data for testing or diagnostic information. See [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.8).) 10 | - The `servers` property enhance documentation and test possibilities (also available on top and operation levels). 11 | fields: 12 | - 13 | name: summary 14 | type: string 15 | description: An optional, string summary, intended to apply to all operations in this path. 16 | changelog: 17 | isNew: true 18 | - 19 | name: description 20 | type: string 21 | description: An optional, string description, intended to apply to all operations in this path. 22 | md: CommonMark 23 | changelog: 24 | isNew: true 25 | - 26 | name: get 27 | type: Operation Object 28 | description: A definition of a GET operation on this path. 29 | - 30 | name: put 31 | type: Operation Object 32 | description: A definition of a PUT operation on this path. 33 | - 34 | name: post 35 | type: Operation Object 36 | description: A definition of a POST operation on this path. 37 | - 38 | name: delete 39 | type: Operation Object 40 | description: A definition of a DELETE operation on this path. 41 | - 42 | name: options 43 | type: Operation Object 44 | description: A definition of a OPTIONS operation on this path. 45 | - 46 | name: head 47 | type: Operation Object 48 | description: A definition of a HEAD operation on this path. 49 | - 50 | name: patch 51 | type: Operation Object 52 | description: A definition of a PATCH operation on this path. 53 | - 54 | name: trace 55 | type: Operation Object 56 | description: A definition of a TRACE operation on this path. 57 | changelog: 58 | isNew: true 59 | - 60 | name: servers 61 | type: Server Object 62 | description: An alternative `server` array to service all operations in this path. 63 | changelog: 64 | isNew: true 65 | - 66 | name: parameters 67 | type: "[Parameter Object]" 68 | allowReference: true 69 | description: | 70 | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). 71 | -------------------------------------------------------------------------------- /data/3.0.1/Paths_Object.yaml: -------------------------------------------------------------------------------- 1 | Paths Object: 2 | description: | 3 | Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the `Server Object` in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#securityFiltering). 4 | allowExtension: true 5 | fields: 6 | - name: "/{path}" 7 | type: Path Item Object 8 | required: true 9 | allowReference: true 10 | description: | 11 | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is *appended* (no relative URL resolution) to the expanded URL from the `Server Object`'s url field in order to construct the full URL. [Path templating](#pathTemplating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. 12 | -------------------------------------------------------------------------------- /data/3.0.1/Reference_Object.yaml: -------------------------------------------------------------------------------- 1 | Reference Object: 2 | name: $ref 3 | type: string 4 | description: | 5 | A simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse. 6 | 7 | The Reference Object is a JSON Reference that uses a JSON Pointer as its value. For this specification, only canonical dereferencing is supported. 8 | 9 | A simple object to allow referencing other components in the specification, internally and externally. 10 | 11 | The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) and follows the same structure, behavior and rules. 12 | 13 | For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification. 14 | 15 | This object cannot be extended with additional properties and any properties added SHALL be ignored. -------------------------------------------------------------------------------- /data/3.0.1/Request_Body_Object.yaml: -------------------------------------------------------------------------------- 1 | Request Body Object: 2 | description: Describes a single request body. 3 | changelog: 4 | isNew: true 5 | details: Replace `Parameter Object` with `in = body`. 6 | allowExtension: true 7 | fields: 8 | - 9 | name: description 10 | type: string 11 | md: CommonMark 12 | description: A brief description of the request body. This could contain examples of use. 13 | - 14 | name: content 15 | type: "{media type,Media Type Object}" 16 | required: true 17 | description: The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* 18 | - 19 | name: required 20 | type: boolean 21 | description: Determines if the request body is required in the request. Defaults to `false`. -------------------------------------------------------------------------------- /data/3.0.1/Response_Object.yaml: -------------------------------------------------------------------------------- 1 | Response Object: 2 | description: Describes a single response from an API Operation, including design-time, static links to operations based on the response. 3 | allowExtension: true 4 | changelog: 5 | isModified: true 6 | details: | 7 | - Better control on media type, response handles returned media type with `content.{mediatype}`. It replaces `produces` definition on `Operation Object` or top level. 8 | - Enhanced hypermedia design with `links`. 9 | - Headers are easier to define because they can be defined in `components.headers` and used in `headers` 10 | deletedProperties: 11 | - 12 | name: schema 13 | replacedBy: content.{media type}.schema 14 | see: Media Type Object 15 | - 16 | name: example 17 | replacedBy: content.{media type}.example or content.{media type}.examples 18 | see: Media Type Object 19 | fields: 20 | - 21 | name: description 22 | type: string 23 | isRequired: true 24 | md: CommonMark 25 | description: A short description of the response. CommonMark syntax can be used for rich text representation. 26 | - 27 | name: headers 28 | type: "{header name, Header Object}" 29 | changelog: 30 | isModified: true 31 | details: Headers can now be defined in the root `components` 32 | description: Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. 33 | - 34 | name: content 35 | type: "{media type,Media Type Object}" 36 | changelog: 37 | isNew: true 38 | details: Replace `schema` but also `Operation Object.produces` or `Open API Object.produces` 39 | description: A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* 40 | - 41 | name: links 42 | type: "{Link Object}" 43 | changelog: 44 | isNew: true 45 | description: A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject). -------------------------------------------------------------------------------- /data/3.0.1/Responses_Object.yaml: -------------------------------------------------------------------------------- 1 | Responses Object: 2 | description: | 3 | A container for the expected responses of an operation. 4 | The container maps a HTTP response code to the expected response. 5 | 6 | The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. 7 | However, documentation is expected to cover a successful operation response and any known errors. 8 | 9 | The `default` MAY be used as a default response object for all HTTP codes 10 | that are not covered individually by the specification. 11 | 12 | The `Responses Object` MUST contain at least one response code, and it 13 | SHOULD be the response for a successful operation call. 14 | 15 | allowExtension: true 16 | changelog: 17 | isModified: true 18 | fields: 19 | - 20 | name: default 21 | allowReference: true 22 | type: Response Object 23 | description: The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#referenceObject) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. 24 | - 25 | name: "{HTTP status code}" 26 | allowReference: true 27 | type: Response Object 28 | changelog: 29 | isModified: true 30 | details: Wildcard are now allowed (2XX for example) 31 | description: | 32 | Any [HTTP status code](#httpCodes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#referenceObject) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. The following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response range is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. -------------------------------------------------------------------------------- /data/3.0.1/Schema_Object.yaml: -------------------------------------------------------------------------------- 1 | Schema Object: 2 | description: | 3 | The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the [JSON Schema Specification Wright Draft 00](http://json-schema.org/). 4 | 5 | For more information about the properties, see [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00) and [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00). Unless stated otherwise, the property definitions follow the JSON Schema. 6 | 7 | Alternatively, any time a Schema Object can be used, a [Reference Object](#referenceObject) can be used in its place. This allows referencing definitions instead of defining them inline. 8 | 9 | Additional properties defined by the JSON Schema specification that are not mentioned here are strictly unsupported. 10 | 11 | allowExtension: true 12 | changelog: 13 | isModified: true 14 | details: | 15 | - Enhanced consistency and easier design with extensive use of Schema Object for all definitions (parameters, bodies, responses, headers) 16 | - [Inheritance and polymorphism](#schemaComposition) mecanism has been enhanced (`oneOf`, `anyOf` and `not` have been added) and clarified (see new `discriminator` behaviour). 17 | - Creating read/write models is easier with `readOnly` (behaviour modified) and `writeOnly` (new). 18 | - Enhance versioning thanks to `deprecated`. 19 | fields: 20 | - 21 | name: 22 | type: Schema Object JSON 23 | changelog: 24 | isModified: true 25 | description: JSON Schema Properties 26 | - 27 | name: 28 | type: Schema Object OpenAPI 29 | changelog: 30 | isModified: true 31 | description: Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation. -------------------------------------------------------------------------------- /data/3.0.1/Schema_Object_Array.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Array: 2 | description: Fields if type is array. 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: items 7 | type: Schema Object 8 | origin: JSON Schema 9 | modOrigin: true 10 | allowReference: true 11 | noFollow: true 12 | description: Value MUST be an object and not an array. Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. `items` MUST be present if the `type` is `array`. 13 | - 14 | name: maxItems 15 | type: number 16 | origin: JSON Schema 17 | description: Maximum count of items in array 18 | - 19 | name: minItems 20 | type: number 21 | origin: JSON Schema 22 | description: Minimum count of items in array. 23 | - 24 | name: uniqueItems 25 | type: boolean 26 | origin: JSON Schema 27 | description: Allow only unique items in array. 28 | -------------------------------------------------------------------------------- /data/3.0.1/Schema_Object_Composition_Inheritance.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Composition Inheritance: 2 | description: See [Discrimitor Object](#discriminatorObject) for complete examples of polymorpism. 3 | fieldsGroup: true 4 | changelog: 5 | isModified: true 6 | fields: 7 | - 8 | name: allOf 9 | type: "[Schema Object]" 10 | noFollow: true 11 | allowReference: true 12 | modifiedJSONSchema: true 13 | description: Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. 14 | - 15 | name: oneOf 16 | type: "[Schema Object]" 17 | noFollow: true 18 | allowReference: true 19 | modifiedJSONSchema: true 20 | changelog: 21 | isNew: true 22 | description: Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. 23 | - 24 | name: anyOf 25 | type: "[Schema Object]" 26 | noFollow: true 27 | allowReference: true 28 | modifiedJSONSchema: true 29 | changelog: 30 | isNew: true 31 | description: Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. 32 | - 33 | name: not 34 | type: Schema Object 35 | noFollow: true 36 | allowReference: true 37 | modifiedJSONSchema: true 38 | changelog: 39 | isNew: true 40 | description: Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. 41 | -------------------------------------------------------------------------------- /data/3.0.1/Schema_Object_Number_Or_Integer.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Number Or Integer: 2 | description: A number or integer value 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: maximum 7 | type: number 8 | origin: JSON Schema 9 | description: | 10 | Maximum value. 11 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 12 | - 13 | name: exclusiveMaximum 14 | type: boolean 15 | origin: JSON Schema 16 | description: | 17 | Indicate if the value must be < maximum. 18 | See http://json-schema.org/latest/json-schema-validation.html#anchor17. 19 | - 20 | name: minimum 21 | type: number 22 | origin: JSON Schema 23 | description: | 24 | Minimum value. 25 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 26 | - 27 | name: exclusiveMinimum 28 | type: boolean 29 | origin: JSON Schema 30 | description: | 31 | Indicate if the value must value > minimum. 32 | See http://json-schema.org/latest/json-schema-validation.html#anchor21. 33 | - 34 | name: multipleOf 35 | type: number 36 | origin: JSON Schema 37 | description: | 38 | The value must be a multiple of *multiplOf*. 39 | See http://json-schema.org/latest/json-schema-validation.html#anchor14. 40 | -------------------------------------------------------------------------------- /data/3.0.1/Schema_Object_Object.yaml: -------------------------------------------------------------------------------- 1 | Schema Object Object: 2 | fieldsGroup: true 3 | description: type value is object. 4 | fields: 5 | - 6 | name: required 7 | type: "[string]" 8 | origin: JSON Schema 9 | description: | 10 | The value of this keyword MUST be an array. Elements of this array, if any, MUST be strings, and MUST be unique. 11 | 12 | An object instance is valid against this keyword if every item in the array is the name of a property in the instance. 13 | 14 | Omitting this keyword has the same behavior as an empty array. 15 | 16 | See http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.5.3 17 | - 18 | name: properties 19 | type: "[Schema Object]" 20 | origin: JSON Schema 21 | modOrigin: true 22 | allowReference: true 23 | noFollow: true 24 | description: Property definitions MUST be a [Schema Object](#schemaObject) and not a standard JSON Schema (inline or referenced). 25 | - 26 | name: additionalProperties 27 | type: Schema Object 28 | origin: JSON Schema 29 | modOrigin: true 30 | allowReference: true 31 | noFollow: true 32 | description: Value can be boolean or object. Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. 33 | - 34 | name: maxProperties 35 | type: integer 36 | origin: JSON Schema 37 | description: An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. 38 | - 39 | name: minProperties 40 | type: integer 41 | origin: JSON Schema 42 | description: An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. -------------------------------------------------------------------------------- /data/3.0.1/Schema_Object_OpenAPI.yaml: -------------------------------------------------------------------------------- 1 | Schema Object OpenAPI: 2 | fieldsGroup: true 3 | description: Other than the JSON Schema subset fields, the following fields may be used for further schema documentation. 4 | fields: 5 | - 6 | name: nullable 7 | type: boolean 8 | changelog: 9 | isNew: true 10 | description: Allows sending a `null` value for the defined schema. Default value is `false`. 11 | - 12 | name: discriminator 13 | type: Discriminator Object 14 | changelog: 15 | isModified: true 16 | details: Composition and inheritance mecanism has been clarified. 17 | description: | 18 | Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See [Composition and Inheritance](#schemaComposition) for more details. 19 | - 20 | name: readOnly 21 | type: boolean 22 | changelog: 23 | isModified: true 24 | details: Light behavior modification concerning a required property (see description and also the new property `writeOnly`) 25 | description: | 26 | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as `readOnly` being `true` and is in the `required` list, the `required` will take effect on the response only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. 27 | - 28 | name: writeOnly 29 | type: boolean 30 | changelog: 31 | isNew: true 32 | description: | 33 | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as `writeOnly` being `true` and is in the `required` list, the `required` will take effect on the request only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. 34 | - 35 | name: xml 36 | type: XML Object 37 | changelog: 38 | isNew: true 39 | description: | 40 | This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. 41 | - 42 | name: externalDocs 43 | type: External Documentation Object 44 | description: Additional external documentation for this schema. 45 | - 46 | name: example 47 | type: Any 48 | description: A free-form property to include an example of an instance for this schema. 49 | - 50 | name: deprecated 51 | type: boolean 52 | changelog: 53 | isNew: true 54 | description: Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. 55 | -------------------------------------------------------------------------------- /data/3.0.1/Schema_Object_String.yaml: -------------------------------------------------------------------------------- 1 | Schema Object String: 2 | description: type value is string 3 | fieldsGroup: true 4 | fields: 5 | - 6 | name: pattern 7 | type: string 8 | origin: JSON Schema 9 | description: | 10 | This string SHOULD be a valid regular expression, according to the [ECMA 262 regular expression dialect](https://www.ecma-international.org/ecma-262/5.1/#sec-7.8.5). 11 | See http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.3.3. 12 | See also [Regex 101](https://regex101.com/) to debug regex. 13 | - 14 | name: maxLength 15 | origin: JSON Schema 16 | type: integer 17 | description: | 18 | Maximum string's length. 19 | See http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.3.1 20 | - 21 | name: minLength 22 | origin: JSON Schema 23 | type: integer 24 | description: | 25 | Minimum string's length. 26 | See http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.3.2 27 | -------------------------------------------------------------------------------- /data/3.0.1/Security_Requirement_Object.yaml: -------------------------------------------------------------------------------- 1 | Security Requirement Object: 2 | allowExtension: true 3 | description: | 4 | Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object. 5 | 6 | Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information. 7 | 8 | When a list of Security Requirement Objects is defined on the Open API object or Operation Object, only one of Security Requirement Objects in the list needs to be satisfied to authorize the request. 9 | fields: 10 | - 11 | name: "{name}" 12 | type: "[string]" 13 | description: | 14 | Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. 15 | -------------------------------------------------------------------------------- /data/3.0.1/Server_Object.yaml: -------------------------------------------------------------------------------- 1 | Server Object: 2 | description: An object representing a Server. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | details: Replace `host`, `basePath` and `schemes` properties from root object. 7 | fields: 8 | - name: url 9 | type: string 10 | required: true 11 | description: A URL to the target host. This URL supports Server Variables and may be relative, to indicate that the host location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be made when a variable is named in {brackets}. 12 | - name: description 13 | type: string 14 | md: CommonMark 15 | description: An optional string describing the host designated by the URL. 16 | - name: variables 17 | type: "{Variable Name, Server Variable Object}" 18 | description: A map between a variable name and its value. The value is used for substitution in the server's URL template. -------------------------------------------------------------------------------- /data/3.0.1/Server_Variable_Object.yaml: -------------------------------------------------------------------------------- 1 | Server Variable Object: 2 | description: An object representing a Server Variable for server URL template substitution. 3 | allowExtension: true 4 | changelog: 5 | isNew: true 6 | fields: 7 | - name: enum 8 | type: "[primitive]" 9 | description: An enumeration of primitive type values to be used if the substitution options are from a limited set. 10 | - name: default 11 | required: true 12 | type: primitive 13 | description: Required. The default value to use for substitution if an alternate value is not specified, and will be sent if an alternative value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer. 14 | - name: description 15 | type: string 16 | md: CommonMark 17 | description: An optional description for the server variable. -------------------------------------------------------------------------------- /data/3.0.1/Specification_Extensions.yaml: -------------------------------------------------------------------------------- 1 | Specification Extensions: 2 | name: ^x- 3 | type: Any 4 | patterned: true 5 | openapiType: true 6 | specificationAnchor: specificationExtensions 7 | description: | 8 | While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points. 9 | 10 | The extensions properties are implemented as patterned fields that are always prefixed by "x-", for example, x-internal-id. The value can be null, a primitive, an array or an object. Can have any valid JSON format value. 11 | 12 | The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). -------------------------------------------------------------------------------- /data/3.0.1/Tag_Object.yaml: -------------------------------------------------------------------------------- 1 | Tag Object: 2 | description: Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. 3 | allowExtension: true 4 | fields: 5 | - 6 | name: name 7 | type: string 8 | description: The name of the tag. 9 | required: true 10 | - 11 | name: description 12 | type: string 13 | description: A short description for the tag. 14 | md: CommonMark 15 | - 16 | name: externalDocs 17 | type: External Documentation Object 18 | description: Additional external documentation for this tag. 19 | -------------------------------------------------------------------------------- /data/3.0.1/XML_Object.yaml: -------------------------------------------------------------------------------- 1 | XML Object: 2 | description: | 3 | A metadata object that allows for more fine-tuned XML model definitions. 4 | 5 | When using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior. 6 | allowExtension: true 7 | changelog: 8 | isNew: true 9 | fields: 10 | - 11 | name: name 12 | type: string 13 | description: Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. 14 | - 15 | name: namespace 16 | type: string 17 | description: The URI of the namespace definition. Value MUST be in the form of an absolute URI. 18 | - 19 | name: prefix 20 | type: string 21 | description: The prefix to be used for the [name](#xmlName). 22 | - 23 | name: attribute 24 | type: boolean 25 | description: Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. 26 | - 27 | name: wrapped 28 | type: boolean 29 | description: MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). -------------------------------------------------------------------------------- /data/3.0.1/Z_Object.yaml: -------------------------------------------------------------------------------- 1 | Z Object: 2 | name: Test 3 | description: | 4 | Test description with a [link](http://apihandyman.io) and another [one](#openapi/). 5 | fields: 6 | - name: required 7 | type: string 8 | required: true 9 | description: | 10 | Test properties with a [link](http://apihandyman.io) and another [one](#openapi/) 11 | - name: notRequired 12 | type: string 13 | description: Non required property -------------------------------------------------------------------------------- /data/spec-versions.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "name": "Version 3.0", 4 | "id": "3.0", 5 | "url": "3.0.1.json", 6 | "root": "OpenAPI Object", 7 | "specificationurl": "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md" 8 | }, 9 | { 10 | "name": "Version 2.0", 11 | "id": "2.0", 12 | "url": "2.0.json", 13 | "root": "Swagger Object", 14 | "specificationurl": "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md" 15 | } 16 | ] -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | const gulp = require('gulp'); 2 | const concat = require('gulp-concat'); 3 | const yamltojson = require('gulp-yaml'); 4 | const prettify = require('gulp-jsbeautifier'); 5 | const handlebars = require('gulp-handlebars'); 6 | const wrap = require('gulp-wrap'); 7 | const declare = require('gulp-declare'); 8 | const del = require('del'); 9 | const webserver = require('gulp-webserver'); 10 | 11 | // https://github.com/gulpjs/gulp/blob/master/docs/recipes/running-task-steps-per-folder.md 12 | const fs = require('fs'); 13 | const path = require('path'); 14 | const merge = require('merge-stream'); 15 | const gulpSequence = require('gulp-sequence'); 16 | // 17 | const filelist = require('gulp-filelist'); 18 | //test 19 | var mocha = require('gulp-mocha'); 20 | var gutil = require('gulp-util'); 21 | 22 | /** 23 | * @description List directories in a directory 24 | * @param {string} dir The directory 25 | * @return {string[]} The directories 26 | */ 27 | function getFolders(dir) { 28 | return fs.readdirSync(dir) 29 | .filter(function(file) { 30 | return fs.statSync(path.join(dir, file)).isDirectory(); 31 | }); 32 | } 33 | 34 | // Concat data//**/*.yaml in .json 35 | gulp.task('build-data-files', function() { 36 | const dataPath = 'data'; 37 | const folders = getFolders(dataPath); 38 | var tasks = folders.map(function(folder) { 39 | return gulp.src(path.join(dataPath, folder, '/**/*.yaml')) 40 | .pipe(concat(folder + '.yaml')) 41 | .pipe(yamltojson(folder + '.json')) 42 | .pipe(prettify(folder + '.json')) 43 | .pipe(gulp.dest('dist')); 44 | }); 45 | return merge(tasks); 46 | }); 47 | 48 | // Copy versions.json file to dist 49 | gulp.task('build-version-file', function() { 50 | return gulp.src('data/*.json') 51 | .pipe(gulp.dest('dist')); 52 | }); 53 | 54 | // Build versions.json and .json files 55 | gulp.task('build-data', function(callback) { 56 | gulpSequence('build-data-files', 'build-version-file')(callback); 57 | }); 58 | 59 | // Generate js code for the tooltip panel's templating and copy to dist 60 | gulp.task('templates', () => { 61 | gulp.src('web/templates/*.hbs') 62 | .pipe(handlebars({ 63 | handlebars: require('handlebars') 64 | })) 65 | .pipe(wrap('Handlebars.template(<%= contents %>)')) 66 | .pipe(declare({ 67 | namespace: 'OpenAPISpecificationVisualDocumentation', 68 | noRedeclare: true // Avoid duplicate declarations 69 | })) 70 | .pipe(concat('templates.js')) 71 | .pipe(gulp.dest('dist/js')); 72 | }); 73 | 74 | // Copy html, css dans js files to dist 75 | gulp.task('static', () => { 76 | return gulp.src('web/static/**/*') 77 | .pipe(gulp.dest('dist/')); 78 | }); 79 | 80 | // Copy static and templated files to dist 81 | gulp.task('build-web', ['static', 'templates']); 82 | 83 | // Copy web and data files to dist 84 | gulp.task('build', function(callback) { 85 | gulpSequence('clean', 'build-web', 'build-data')(callback); 86 | }); 87 | 88 | // Deletes dist 89 | gulp.task('clean', del.bind(null, ['dist'])); 90 | 91 | // Watch for modifications on web and data files, relaunch tests and build if files are modified 92 | gulp.task('watch', ['default'], function() { 93 | return gulp.watch(['data/**/*', 'web/**/*'], ['default']); 94 | }); 95 | 96 | // Launch web server on dist directory with live-reload 97 | gulp.task('webserver', function() { 98 | return gulp.src(['dist']) 99 | .pipe(webserver({ 100 | port: 8080, 101 | livereload: true, 102 | directoryListing: false, 103 | open: true, 104 | fallback: 'index.html' 105 | })); 106 | }); 107 | 108 | // Launch dev mode 109 | gulp.task('serve', function(callback) { 110 | gulpSequence('watch', 'webserver')(callback); 111 | }); 112 | 113 | // Test with mocha (prerequisites: npm install -g mocha) 114 | gulp.task('test', function() { 115 | return gulp.src(['test/*.js'], { read: false }) 116 | .pipe(mocha()) 117 | .on('error', gutil.log); 118 | }); 119 | 120 | // Default task: test then build 121 | gulp.task('default', function(callback){ 122 | gulpSequence('test', 'build')(callback); 123 | }); 124 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "openapi-map", 3 | "version": "1.0.0", 4 | "description": "Find your way in the OpenAPI Specification", 5 | "main": "index.js", 6 | "scripts": { 7 | "serve": "gulp serve", 8 | "build": "gulp" 9 | }, 10 | "author": "Arnaud Lauret", 11 | "license": "Apache 2.0", 12 | "devDependencies": { 13 | "chai": "^4.1.2", 14 | "del": "^3.0.0", 15 | "gulp": "^3.9.1", 16 | "gulp-concat": "^2.6.1", 17 | "gulp-declare": "^0.3.0", 18 | "gulp-filelist": "^1.0.0", 19 | "gulp-handlebars": "^5.0.2", 20 | "gulp-jsbeautifier": "^2.1.2", 21 | "gulp-mocha": "^5.0.0", 22 | "gulp-sequence": "^1.0.0", 23 | "gulp-util": "^3.0.8", 24 | "gulp-webserver": "^0.9.1", 25 | "gulp-wrap": "^0.13.0", 26 | "gulp-yaml": "^1.0.1", 27 | "handlebars": "^4.0.11", 28 | "marked": "^0.3.17", 29 | "merge-stream": "^1.0.1", 30 | "mocha": "^5.0.1" 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /scripts/deploy.sh: -------------------------------------------------------------------------------- 1 | #! /bin/bash 2 | 3 | set -e 4 | 5 | if [ -z ${DEPLOY_REPO+x} ] 6 | then 7 | DEPLOY_REPO=`git config --get remote.origin.url` 8 | echo "DEPLOY_REPO is not set, using available remote url $DEPLOY_REPO" 9 | else 10 | echo "DEPLOY_REPO is set to $DEPLOY_REPO" 11 | fi 12 | 13 | if [ -z ${DEPLOY_BRANCH+x} ] 14 | then 15 | echo "DEPLOY_BRANCH is not set" 16 | exit 1 17 | else 18 | echo "DEPLOY_BRANCH is set to $DEPLOY_BRANCH" 19 | fi 20 | 21 | if [ -z ${BUILD_TARGET+x} ] 22 | then 23 | BUILD_TARGET="_site" 24 | echo "BUILD_TARGET is not set, using default $BUILD_TARGET" 25 | else 26 | echo "BUILD_TARGET is set to $BUILD_TARGET" 27 | fi 28 | 29 | if [ -z ${DEPLOY_TARGET+x} ] 30 | then 31 | DEPLOY_TARGET=".deploy" 32 | echo "DEPLOY_TARGET is not set, using default $DEPLOY_TARGET" 33 | else 34 | echo "DEPLOY_TARGET is set to $DEPLOY_TARGET" 35 | fi 36 | 37 | if [ -z ${GH_TOKEN+x} ] 38 | then 39 | echo "GH_TOKEN is not set, using default credentials" 40 | DEPLOY_REPO_CREDENTIALS=$DEPLOY_REPO 41 | else 42 | echo "GH_TOKEN is set updating REPO_URL" 43 | TMP_URL=`echo $DEPLOY_REPO | sed "s/https:\/\///"` 44 | DEPLOY_REPO_CREDENTIALS="https://${GH_TOKEN}@${TMP_URL}" 45 | fi 46 | 47 | if [ -z ${PUBLISH_MESSAGE+x} ] 48 | then 49 | PUBLISH_MESSAGE="publish" 50 | echo "PUBLISH_MESSAGE is not set, using default value $PUBLISH_MESSAGE" 51 | else 52 | echo "PUBLISH_MESSAGE is set to $PUBLISH_MESSAGE" 53 | fi 54 | 55 | function update { 56 | echo "updating deploy branch $DEPLOY_BRANCH from $DEPLOY_REPO in $DEPLOY_TARGET" 57 | cd $DEPLOY_TARGET;git pull;cd ..; 58 | } 59 | 60 | function install { 61 | echo "cloning deploy branch $DEPLOY_BRANCH from $DEPLOY_REPO in $DEPLOY_TARGET" 62 | git clone --depth 1 $DEPLOY_REPO --branch $DEPLOY_BRANCH --single-branch $DEPLOY_TARGET 63 | } 64 | 65 | function prepare { 66 | echo "cleaning $DEPLOY_TARGET folder" 67 | if [ -d "$DEPLOY_TARGET/.git" ] 68 | then 69 | update 70 | else 71 | install 72 | fi 73 | rm -rf $DEPLOY_TARGET/* 74 | if [ -d $BUILD_TARGET ] 75 | then 76 | echo "copying build result from $BUILD_TARGET to $DEPLOY_TARGET" 77 | cp -r $BUILD_TARGET/* $DEPLOY_TARGET/ 78 | else 79 | echo "no build available" 80 | exit 1 81 | fi 82 | } 83 | 84 | function publish { 85 | echo "publishing" 86 | cd $DEPLOY_TARGET 87 | if [ `git status -s | wc -l` -gt 0 ] 88 | then 89 | if [ ${GH_USER+x} ] 90 | then 91 | echo "setting git user.name with GH_USER env variable" 92 | git config --global user.name "$GH_USER" 93 | fi 94 | if [ ${GH_EMAIL+x} ] 95 | then 96 | echo "setting git user.email with GH_EMAIL env variable" 97 | git config --global user.email "$GH_EMAIL" 98 | fi 99 | git add . 100 | git commit -m "$PUBLISH_MESSAGE" 101 | git push $DEPLOY_REPO_CREDENTIALS 102 | else 103 | echo "WARN: no change to add to commit" 104 | fi 105 | } 106 | 107 | function main { 108 | prepare 109 | publish 110 | } 111 | 112 | main -------------------------------------------------------------------------------- /web/static/CNAME: -------------------------------------------------------------------------------- 1 | openapi-map.apihandyman.io 2 | -------------------------------------------------------------------------------- /web/static/css/main.css: -------------------------------------------------------------------------------- 1 | /* Space out content a bit */ 2 | /*body { 3 | padding-bottom: 20px; 4 | }*/ 5 | 6 | #navbar ul li.active { 7 | background-color: #eee; 8 | } 9 | 10 | .navbar { 11 | margin-bottom: 0px; 12 | border-bottom: 0px; 13 | } 14 | 15 | #navbar a, .navbar-header a{ 16 | color: black 17 | } 18 | 19 | .container-fluid { 20 | padding-right: 0px; 21 | } 22 | 23 | #header-container { 24 | padding-bottom: 10px; 25 | } 26 | 27 | .navbar-brand>img { 28 | display: inline 29 | } 30 | 31 | .navbar-brand { 32 | padding-top: 8px; 33 | } 34 | 35 | #versions { 36 | padding-left: 15px; 37 | } 38 | 39 | #tooltip-container { 40 | border-top: 1px solid #e5e5e5; 41 | overflow: scroll; 42 | } 43 | 44 | #tree-container { 45 | border-top: 1px solid #e5e5e5; 46 | border-right: 1px solid #e5e5e5; 47 | } 48 | 49 | .row-doc { 50 | border-top: 1px solid #e5e5e5; 51 | } 52 | 53 | .documentation, #help { 54 | padding-left: 10px; 55 | padding-right: 25px; 56 | } 57 | 58 | .navbar-brand { 59 | margin-bottom: 0px; 60 | } 61 | 62 | .title { 63 | padding-left: 0px; 64 | color: #777; 65 | } 66 | 67 | .github-ribbon { 68 | position: absolute; 69 | top: 0; 70 | right: 0; 71 | border: 0; 72 | z-index: 999; 73 | } 74 | 75 | 76 | /* Everything but the jumbotron gets side spacing for mobile first views */ 77 | .header, 78 | .marketing, 79 | .footer { 80 | padding-left: 15px; 81 | padding-right: 15px; 82 | } 83 | 84 | /* Custom page header */ 85 | .header { 86 | border-bottom: 1px solid #e5e5e5; 87 | } 88 | 89 | /* Make the masthead heading the same height as the navigation */ 90 | .header h3 { 91 | margin-top: 0; 92 | margin-bottom: 0; 93 | line-height: 40px; 94 | padding-bottom: 19px; 95 | } 96 | 97 | /* Custom page footer */ 98 | .footer { 99 | padding-top: 10px; 100 | color: #777; 101 | border-top: 1px solid #e5e5e5; 102 | } 103 | 104 | .container-narrow > hr { 105 | margin: 30px 0; 106 | } 107 | 108 | /* Main marketing message and sign up button */ 109 | .jumbotron { 110 | text-align: center; 111 | border-bottom: 1px solid #e5e5e5; 112 | } 113 | 114 | .jumbotron .btn { 115 | font-size: 21px; 116 | padding: 14px 24px; 117 | } 118 | 119 | /* Supporting marketing content */ 120 | .marketing { 121 | margin: 40px 0; 122 | } 123 | 124 | .marketing p + h4 { 125 | margin-top: 28px; 126 | } 127 | 128 | /* Responsive: Portrait tablets and up */ 129 | @media screen and (min-width: 768px) { 130 | .container { 131 | max-width: 730px; 132 | } 133 | 134 | /* Remove the padding we set earlier */ 135 | .header, 136 | .marketing, 137 | .footer { 138 | padding-left: 0; 139 | padding-right: 0; 140 | } 141 | 142 | /* Space out the masthead */ 143 | .header { 144 | margin-bottom: 30px; 145 | } 146 | 147 | /* Remove the bottom border on the jumbotron for visual effect */ 148 | .jumbotron { 149 | border-bottom: 0; 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /web/static/css/tree.css: -------------------------------------------------------------------------------- 1 | .node { 2 | cursor: pointer; 3 | } 4 | 5 | .overlay{ 6 | background-color:white; 7 | } 8 | 9 | .node circle { 10 | fill: #fff; 11 | stroke: steelblue; 12 | stroke-width: 1.5px; 13 | } 14 | 15 | .node circleRequired { 16 | fill: #fff; 17 | stroke: red; 18 | stroke-width: 1.5px; 19 | } 20 | 21 | .node text { 22 | font-size:10px; 23 | font-family:sans-serif; 24 | } 25 | 26 | .link { 27 | fill: none; 28 | stroke: #ccc; 29 | stroke-width: 1.5px; 30 | } 31 | 32 | .templink { 33 | fill: none; 34 | stroke: red; 35 | stroke-width: 3px; 36 | } 37 | 38 | .ghostCircle.show{ 39 | display:block; 40 | } 41 | 42 | .ghostCircle, .activeDrag .ghostCircle{ 43 | display: none; 44 | } 45 | 46 | div.tooltip-ols { 47 | position: fixed; 48 | text-align: justify; 49 | padding: 10px; 50 | overflow: hidden; 51 | overflow-y: auto; 52 | max-width: 600px; 53 | max-height: 200px; 54 | font: 12px sans-serif; 55 | background: lightsteelblue; 56 | border: 0px; 57 | border-radius: 8px; 58 | pointer-events: none; 59 | z-index: 9000; 60 | } 61 | 62 | div.tooltip { 63 | 64 | } 65 | 66 | 67 | .list-group-item { 68 | border-top-right-radius: 4px; 69 | border-top-left-radius: 4px; 70 | } 71 | 72 | .list-group { 73 | margin-bottom: 20px; 74 | padding-left: 0px; 75 | } 76 | 77 | .node .nodeRequired { 78 | fill:red; 79 | } -------------------------------------------------------------------------------- /web/static/fonts/fontawesome-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/fonts/fontawesome-webfont.eot -------------------------------------------------------------------------------- /web/static/fonts/fontawesome-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/fonts/fontawesome-webfont.ttf -------------------------------------------------------------------------------- /web/static/fonts/fontawesome-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/fonts/fontawesome-webfont.woff -------------------------------------------------------------------------------- /web/static/fonts/fontawesome-webfont.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/fonts/fontawesome-webfont.woff2 -------------------------------------------------------------------------------- /web/static/images/forkme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/forkme.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-114x114.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-114x114.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-120x120.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-120x120.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-144x144.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-144x144.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-152x152.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-152x152.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-57x57.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-57x57.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-60x60.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-60x60.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-72x72.png -------------------------------------------------------------------------------- /web/static/images/icons/apple-touch-icon-76x76.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/apple-touch-icon-76x76.png -------------------------------------------------------------------------------- /web/static/images/icons/favicon-128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/favicon-128.png -------------------------------------------------------------------------------- /web/static/images/icons/favicon-16x16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/favicon-16x16.png -------------------------------------------------------------------------------- /web/static/images/icons/favicon-196x196.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/favicon-196x196.png -------------------------------------------------------------------------------- /web/static/images/icons/favicon-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/favicon-32x32.png -------------------------------------------------------------------------------- /web/static/images/icons/favicon-96x96.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/favicon-96x96.png -------------------------------------------------------------------------------- /web/static/images/icons/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/favicon.ico -------------------------------------------------------------------------------- /web/static/images/icons/mstile-144x144.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/mstile-144x144.png -------------------------------------------------------------------------------- /web/static/images/icons/mstile-150x150.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/mstile-150x150.png -------------------------------------------------------------------------------- /web/static/images/icons/mstile-310x150.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/mstile-310x150.png -------------------------------------------------------------------------------- /web/static/images/icons/mstile-310x310.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/mstile-310x310.png -------------------------------------------------------------------------------- /web/static/images/icons/mstile-70x70.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/icons/mstile-70x70.png -------------------------------------------------------------------------------- /web/static/images/markdown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arno-di-loreto/openapi-map/94b2719a6a48ecb677655f0d390efb3ec86232b3/web/static/images/markdown.png -------------------------------------------------------------------------------- /web/static/js/main.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | function getParameterByName(name, url) { 4 | if (!url) url = window.location.href; 5 | name = name.replace(/[\[\]]/g, "\\$&"); 6 | var regex = new RegExp("[?&]" + name + "(=([^&#]*)|&|#|$)"), 7 | results = regex.exec(url); 8 | if (!results) return null; 9 | if (!results[2]) return ''; 10 | return decodeURIComponent(results[2].replace(/\+/g, " ")); 11 | } 12 | 13 | function loadVersionFile(complete) { 14 | $.getJSON('spec-versions.json') 15 | .then(complete) 16 | .fail(function(error) { 17 | console.log('Failed to load spec-versions.json file', error); 18 | }); 19 | } 20 | 21 | function populateVersionList(callback) { 22 | loadVersionFile(function(versions) { 23 | for (var i = 0; i < versions.length; i++) { 24 | var name = versions[i].name; 25 | var url = versions[i].url; 26 | var root = versions[i].root; 27 | var specificationurl = versions[i].specificationurl; 28 | $('#versions').append('
  • ' + 36 | name + 37 | '
    • '); 38 | } 39 | callback(versions); 40 | }); 41 | } 42 | 43 | function loadData(url, root, specificationurl, callback) { 44 | $.getJSON(url) 45 | .then(function(data) { 46 | var tree = buildTree(data, root, specificationurl); 47 | drawTree(tree); 48 | callback(); 49 | }) 50 | .fail(function(error) { 51 | console.log('Failed to load ' + url + ' file', error); 52 | }); 53 | } 54 | 55 | function showVersion(name, url, root, specificationurl) { 56 | loadData(url, root, specificationurl, function() { 57 | $('#versions li').each(function() { 58 | $(this).blur(); 59 | $(this).removeClass('active'); 60 | if ($(this).attr('id').localeCompare(name) === 0) { 61 | $(this).addClass('active'); 62 | } 63 | }); 64 | }); 65 | } 66 | 67 | function showHome() { 68 | $('#tooltip').empty(); 69 | $('#help').show(); 70 | } 71 | 72 | function getVersionById(id, versions){ 73 | var result; 74 | for (var i = 0; i < versions.length; i++) { 75 | if(versions[i].id === id) { 76 | result = versions[i]; 77 | break; 78 | } 79 | } 80 | return result; 81 | } 82 | 83 | function getVersion(versions, url) { 84 | var id = getParameterByName('version', url); 85 | var version; 86 | if(id !== undefined && id !== null && id.length > 0) { 87 | version = getVersionById(id, versions); 88 | } 89 | if(!version){ 90 | version = versions[0]; 91 | } 92 | return version; 93 | } 94 | 95 | populateVersionList(function(versions) { 96 | var version = getVersion(versions); 97 | showVersion(version.name, version.url, version.root, version.specificationurl); 98 | }); 99 | --------------------------------------------------------------------------------