From 1ae2df83f1be16fb1d3f4b33850efcfd517b8e80 Mon Sep 17 00:00:00 2001 From: sdelamater Date: Thu, 17 Sep 2015 12:23:34 -0700 Subject: [PATCH] Generate TOCs for specification docs --- docs/1.2.md | 1195 ++++++++++++++++++++++++++ docs/2.0.md | 2330 ++++++++++++++++++++++++++++++++++++++++++++++++++ gulpfile.js | 6 + package.json | 1 + 4 files changed, 3532 insertions(+) create mode 100644 docs/1.2.md create mode 100755 docs/2.0.md diff --git a/docs/1.2.md b/docs/1.2.md new file mode 100644 index 0000000000..1086ef70e0 --- /dev/null +++ b/docs/1.2.md @@ -0,0 +1,1195 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Swagger RESTful API Documentation Specification](#swagger-restful-api-documentation-specification) + - [Version 1.2](#version-12) + - [1. Introduction](#1-introduction) + - [2. Revision History](#2-revision-history) + - [3. Definitions](#3-definitions) + - [4. Specification](#4-specification) + - [4.1 Format](#41-format) + - [4.2 File Structure](#42-file-structure) + - [4.3 Data Types](#43-data-types) + - [4.3.1 Primitives](#431-primitives) + - [4.3.2 `void`](#432-void) + - [4.3.3 Data Type Fields](#433-data-type-fields) + - [4.3.4 Items Object](#434-items-object) + - [4.3.5 `File`](#435-file) + - [5. Schema](#5-schema) + - [5.1 Resource Listing](#51-resource-listing) + - [5.1.1 Object Example](#511-object-example) + - [5.1.2 Resource Object](#512-resource-object) + - [5.1.3 Info Object](#513-info-object) + - [5.1.4 Authorizations Object](#514-authorizations-object) + - [5.1.5 Authorization Object](#515-authorization-object) + - [5.1.6 Scope Object](#516-scope-object) + - [5.1.7 Grant Types Object](#517-grant-types-object) + - [5.1.8 Implicit Object](#518-implicit-object) + - [5.1.9 Authorization Code Object](#519-authorization-code-object) + - [5.1.10 Login Endpoint Object](#5110-login-endpoint-object) + - [5.1.11 Token Request Endpoint Object](#5111-token-request-endpoint-object) + - [5.1.12 Token Endpoint Object](#5112-token-endpoint-object) + - [5.2 API Declaration](#52-api-declaration) + - [5.2.1 Object Example](#521-object-example) + - [5.2.2 API Object](#522-api-object) + - [5.2.3 Operation Object](#523-operation-object) + - [5.2.4 Parameter Object](#524-parameter-object) + - [5.2.5 Response Message Object](#525-response-message-object) + - [5.2.6 Models Object](#526-models-object) + - [5.2.7 Model Object](#527-model-object) + - [5.2.8 Properties Object](#528-properties-object) + - [5.2.9 Property Object](#529-property-object) + - [5.2.10 Authorizations Object](#5210-authorizations-object) + - [5.2.11 Scope Object](#5211-scope-object) + + + +# Swagger RESTful API Documentation Specification + +#### Version 1.2 + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt). + +The Swagger specification is licensed under [The Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). + +## 1. Introduction + +Swagger™ is a project used to describe and document RESTful APIs. + +The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools. + +## 2. Revision History + +Version | Date | Notes +--- | --- | --- +1.2 | 2014-03-14 | Initial release of the formal document. +1.1 | 2012-08-22 | Release of Swagger 1.1 +1.0 | 2011-08-10 | First release of the Swagger Specification + +## 3. Definitions + +- Resource: A `resource` in Swagger is an entity that has a set of exposed operations. The entity can represent an actual object (pets, users..) or a set of logical operations collated together. It is up to the specification user to decide whether sub-resources should be referred to as part of their main resource or as a resource of their own. +For example, assume the following URL set: + ``` + - /users - GET + POST + - /users/{id} - GET + PATCH + DELETE + ``` +In this case, there's either one "/users" resource that contains operations on the "/users/{id}" sub-resource, or two separate resources. + +- URL: A fully qualified URL. + +## 4. Specification + +### 4.1 Format + +The files describing the RESTful API in accordance with the Swagger specification are represented as JSON objects and conform to the JSON standards. + +For example, if a field is said to have an array value, the JSON array representation will be used: + +```js +{ + "field" : [...] +} +``` + +Please note that while the API is described using JSON, the input and/or output can be in XML, YAML, plain text, or whichever format you chose to use with your API. + +Unless noted otherwise, all field names in the specification are **case sensitive**. + +### 4.2 File Structure + +The Swagger representation of the API is comprised of two file types: + +1. [**The Resource Listing**](#51-resource-listing) - This is the root document that contains general API information and lists the resources. Each resource has its own URL that defines the API operations on it. + +1. [**The API Declaration**](#52-api-declaration) - This document describes a resource, including its API calls and models. There is one file per resource. + + +### 4.3 Data Types + +In the Swagger specification, the data types are used in several locations - [Operations](#523-operation-object), [Operation Parameters](#524-parameter-object), [Models](#527-model-object), and within the data types themselves (arrays). + +The fields used to describe a given data type are added flatly to the relevant object. For example, if an object Foo has the field `name`, and is also a data type, then it MUST also include the field `type` (or its variance, as explained ahead). In this example, Foo would look like: +```js +"Foo" : { + "name" : "sample", + "type" : "string", + ... +} +``` + +This section describes the general fields that are available to describe such data types. Some data types allow additional fields to extend further limitations on the data type *value* (see [4.3.3 Data Type Fields](#433-data-type-fields) for further details). + +Special care should be taken when referencing a model (or a complex type). There are currently two variations, and the proper variation should be documented everywhere the model may be used. This behavior will be unified in future versions of the spec. + +The Swagger specification supports five data types: + +1. [`primitive`](#431-primitives) (input/output) +1. containers (as arrays/sets) (input/output) +1. [complex](#527-model-object) (as `models`) (input/output) +1. [`void`](#432-void) (output) +1. [`File`](#434-file) (input) + +#### 4.3.1 Primitives + +Different programming languages represent primitives differently. The Swagger specification supports by name only the primitive types supported by the [JSON-Schema Draft 4](http://json-schema.org/latest/json-schema-core.html#anchor8). However, in order to allow fine tuning a primitive definition, an additional [`format`](#dataTypeFormat) field MAY accompany the [`type`](#dataTypeType) primitive to give more information about the type used. If the [`format`](#dataTypeFormat) field is used, the respective client MUST conform to the elaborate type. + +Common Name | [`type`](#dataTypeType) | [`format`](#dataTypeFormat) | Comments +----------- | ------ | -------- | -------- +integer | `integer` | `int32` | signed 32 bits +long | `integer` | `int64` | signed 64 bits +float | `number` | `float` | +double | `number` | `double` | +string | `string` | | +byte | `string` | `byte` | +boolean | `boolean` | | +date | `string` | `date` | +dateTime | `string` | `date-time` | + +#### 4.3.2 `void` + +This value type is used to indicate that an [operation](#523-operation-object) returns no value. As such it MAY be used only for the return type of operations. + +#### 4.3.3 Data Type Fields + +As explained above, when an object is said to include a data type, there are a set of fields it may include (some are required and some are optional). + +Special care should be taken when referencing a model (or a complex type). There currently two variations, and the proper variation should be documented everywhere it may be used. This behavior will be unified in future versions of the spec. + +The table below shows the available fields to describe a data type. The `Validity` column may impose additional restrictions as to which data type is required in order to include this field. For example, [`enum`](#dataTypeEnum) may only be included if the [`type`](#dataTypeType) field is set to `string`. + +Field Name | Type | Validity |Description +---|:---:|---|--- +type | `string` | Any |**Required (if [`$ref`](#dataTypeRef) is not used).** The return type of the operation. The value MUST be one of the [Primitives](#431-primitives), `array` or a model's [`id`](#modelId). +$ref | `string` | Any | **Required (if [`type`](#dataTypeType) is not used).** The [Model](#527-model-object) to be used. The value MUST be a model's [`id`](#modelId). +format | `string` | primitive | Fine-tuned primitive type definition. See [Primitives](#431-primitives) for further information. The value MUST be one that is defined under [Primitives](#431-primitives), corresponding to the right primitive [`type`](#dataTypeType). +defaultValue | *special* | primitive | The default value to be used for the field. The value type MUST conform with the primitive's [`type`](#dataTypeType) value. +enum | [`string`] | `string` | A fixed list of possible values. If this field is used in conjunction with the [`defaultValue`](#dataTypeDefaultValue) field, then the default value MUST be one of the values defined in the `enum`. +minimum | `string` | `number`, `integer` | The minimum valid value for the type, inclusive. If this field is used in conjunction with the [`defaultValue`](#dataTypeDefaultValue) field, then the default value MUST be higher than or equal to this value. The value type is `string` and should represent the minimum numeric value. **Note**: This will change to a numeric value in the future. +maximum | `string` | `number`, `integer` | The maximum valid value for the type, inclusive. If this field is used in conjunction with the [`defaultValue`](#dataTypeDefaultValue) field, then the default value MUST be lower than or equal to this value. The value type is `string` and should represent the maximum numeric value. **Note**: This will change to a numeric value in the future. +items | [Items Object](#434-items-object) | `array` | **Required.** The type definition of the values in the container. A container MUST NOT be nested in another container. +uniqueItems | `boolean` | `array` | A flag to note whether the container allows duplicate values or not. If the value is set to `true`, then the `array` acts as a set. + +#### 4.3.4 Items Object + +This object is used to describe the value types used inside an array. Of the [Data Type Fields](#433-data-type-fields), it can include either the [`type`](#dataTypeType) and [`format`](#dataTypeFormat) fields *OR* the [`$ref`](#dataTypeRef) field (when referencing a model). The rest of the listed Data Type fields are not applicable. + +If the [`type`](#dataTypeType) field is included it MUST NOT have the value `array`. There's currently no support for containers within containers. + +##### 4.3.4.1 Object Examples + +For a primitive type: +```js +{ + "type": "string" +} +``` + +For a complex type (model): + +```js +{ + "$ref": "Pet" +} +``` + +#### 4.3.5 `File` + +The `File` (case sensitive) is a special type used to denote file upload. Note that declaring a model with the name `File` may lead to various conflicts with third party tools and SHOULD be avoided. + +When using `File`, the [`consumes`](#operationConsumes) field MUST be `"multipart/form-data"`, and the [`paramType`](#parameterParamType) MUST be `"form"`. + +## 5. Schema + +### 5.1 Resource Listing + +The Resource Listing serves as the root document for the API description. It contains general information about the API and an inventory of the available resources. + +By default, this document SHOULD be served at the `/api-docs` path. + +Field Name | Type | Description +---|:---:|--- +swaggerVersion | `string` | **Required.** Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be an existing Swagger specification version.
Currently, `"1.0"`, `"1.1"`, `"1.2"` are valid values. The field is a `string` type for possible non-numeric versions in the future (for example, "1.2a"). +apis | [ [Resource Object](#512-resource-object) ] | **Required.** Lists the resources to be described by this specification implementation. The array can have 0 or more elements. +apiVersion| `string` | Provides the version of the application API (not to be confused by the [specification version](#rlSwaggerVersion)). +info | [Info Object](#513-info-object) | Provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience. +authorizations | [Authorizations Object](#514-authorizations-object) | Provides information about the authorization schemes allowed on this API. + +#### 5.1.1 Object Example + +```js +{ + "apiVersion": "1.0.0", + "swaggerVersion": "1.2", + "apis": [ + { + "path": "/pet", + "description": "Operations about pets" + }, + { + "path": "/user", + "description": "Operations about user" + }, + { + "path": "/store", + "description": "Operations about store" + } + ], + "authorizations": { + "oauth2": { + "type": "oauth2", + "scopes": [ + { + "scope": "email", + "description": "Access to your email address" + }, + { + "scope": "pets", + "description": "Access to your pets" + } + ], + "grantTypes": { + "implicit": { + "loginEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/dialog" + }, + "tokenName": "access_token" + }, + "authorization_code": { + "tokenRequestEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/requestToken", + "clientIdName": "client_id", + "clientSecretName": "client_secret" + }, + "tokenEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/token", + "tokenName": "access_code" + } + } + } + } + }, + "info": { + "title": "Swagger Sample App", + "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", + "termsOfServiceUrl": "http://swagger.io/terms/", + "contact": "apiteam@wordnik.com", + "license": "Apache 2.0", + "licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html" + } +} +``` + +#### 5.1.2 Resource Object +The Resource object describes a [resource](#definitionResource) API endpoint in the application. + +Field Name | Type | Description +---|:---:|--- +path | `string` | **Required.** A relative path to the [API declaration](#52-api-declaration) from the path used to retrieve this Resource Listing. This `path` does not necessarily have to correspond to the URL which actually serves this resource in the API but rather where the resource listing itself is served. The value SHOULD be in a relative (URL) path format. +description | `string` | *Recommended.* A short description of the resource. + +##### 5.1.2.1 Object Example: + +```js +{ + "path": "/pets", + "description": "Operations about pets." +} +``` + +#### 5.1.3 Info Object +The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience. + +Field Name | Type | Description +---|:---:|--- +title | `string` | **Required.** The title of the application. +description | `string` | **Required.** A short description of the application. +termsOfServiceUrl | `string` | A URL to the Terms of Service of the API. +contact | `string` | An email to be used for API-related correspondence. +license | `string` | The license name used for the API. +licenseUrl | `string` | A URL to the license used for the API. + +##### 5.1.3.1 Object Example: + +```js +{ + "title": "Swagger Sample App", + "description": "This is a sample server Petstore server.", + "termsOfServiceUrl": "http://swagger.io/terms/", + "contact": "apiteam@wordnik.com", + "license": "Apache 2.0", + "licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html" +} +``` + +#### 5.1.4 Authorizations Object +The object provides information about the authorization schemes provided on this API. +Currently, Swagger supports three authorization schemes - basic authentication, API key and OAuth2. +The Authorizations Object is used only to *declare* the available authorization schemes but not say which are required where. +The actual authorization restrictions are done at the [API declaration](#52-api-declaration) level. + +Please note that the Authorizations Object is an object containing other object definitions and as such is structured as follows: +```js +{ + "Authorization1" : {...}, + "Authorization2" : {...}, + ..., + "AuthorizationN" : {...} +} +``` + +Field Name | Type | Description +---|:---:|--- +{Authorization Name} | [Authorization Object](#515-authorization-object) | A new authorization definition. The name given to the {Authorization Name} is a friendly name that should be used when referring to the authorization scheme. In many cases, the {Authorization Name} used is the same as its type, but it can be anything. + +##### 5.1.4.1 Object Example: +```js +{ + "oauth2": { + "type": "oauth2", + "scopes": [ + { + "scope": "email", + "description": "Access to your email address" + }, + { + "scope": "pets", + "description": "Access to your pets" + } + ], + "grantTypes": { + "implicit": { + "loginEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/dialog" + }, + "tokenName": "access_token" + }, + "authorization_code": { + "tokenRequestEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/requestToken", + "clientIdName": "client_id", + "clientSecretName": "client_secret" + }, + "tokenEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/token", + "tokenName": "access_code" + } + } + } + } +} +``` + +#### 5.1.5 Authorization Object +The object provides information about a specific authorization scheme. Currently, the authorization schemes supported are basic authentication, API key and OAuth2. + +Within OAuth2, the Authorization Code Grant and Implicit Grant are supported. + +In the table below, the `Validity` column imposes additional limitations to the requirement of the [`type`](#authorizationType) in order to be able to use that field. + +Field Name | Type | Validity | Description +---|:---:|---|--- +type | `string` | Any | **Required.** The type of the authorization scheme. Values MUST be either `"basicAuth"`, `"apiKey"` or `"oauth2"`. +passAs | `string` | `apiKey` | **Required.** Denotes how the API key must be passed. Valid values are `"header"` or `"query"`. +keyname | `string` | `apiKey` | **Required.** The name of the `header` or `query` parameter to be used when passing the API key. +scopes | [[Scope Object](#516-scope-object)] | `oauth2` | A list of supported OAuth2 scopes. +grantTypes | [Grant Types Object](#517-grant-types-object) | `oauth2` | **Required.** Detailed information about the grant types supported by the OAuth2 authorization scheme. + +##### 5.1.5.1 Object Example: +```js + "oauth2": { + "type": "oauth2", + "scopes": [ + { + "scope": "email", + "description": "Access to your email address" + }, + { + "scope": "pets", + "description": "Access to your pets" + } + ], + "grantTypes": { + "implicit": { + "loginEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/dialog" + }, + "tokenName": "access_token" + }, + "authorization_code": { + "tokenRequestEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/requestToken", + "clientIdName": "client_id", + "clientSecretName": "client_secret" + }, + "tokenEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/token", + "tokenName": "access_code" + } + } + } + } +``` + +#### 5.1.6 Scope Object +Describes an OAuth2 authorization scope. + +Field Name | Type | Description +---|:---:|--- +scope | `string` | **Required.** The name of the scope. +description | `string` | *Recommended.* A short description of the scope. + +##### 5.1.6.1 Object Example: +```js +{ + "scope": "email", + "description": "Access to your email address" +} +``` + +#### 5.1.7 Grant Types Object +Provides details regarding the OAuth2 grant types that are supported by the API. Currently, the Authorization Code and Implicit grants are supported. + +At least one of the grant types MUST be included (otherwise there's no need for the OAuth2 declaration). + +Field Name | Type | Description +---|:---:|--- +implicit | [Implicit Object](#518-implicit-object) | The Implicit Grant flow definition. +authorization_code | [Authorization Code Object](#519-authorization-code-object) | The Authorization Code Grant flow definition. + +##### 5.1.7.1 Object Example: +```js +{ + "implicit": { + "loginEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/dialog" + }, + "tokenName": "access_token" + }, + "authorization_code": { + "tokenRequestEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/requestToken", + "clientIdName": "client_id", + "clientSecretName": "client_secret" + }, + "tokenEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/token", + "tokenName": "access_code" + } + } +} +``` + +#### 5.1.8 Implicit Object +Provides details regarding the OAuth2's Implicit Grant flow type. + +Field Name | Type | Description +---|:---:|--- +loginEndpoint | [Login Endpoint Object](#5110-login-endpoint-object) | **Required.** The login endpoint definition. +tokenName | `string` | An optional alternative name to standard "access_token" OAuth2 parameter. + +##### 5.1.8.1 Object Example: +```js +{ + "loginEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/dialog" + }, + "tokenName": "access_token" +} +``` + +#### 5.1.9 Authorization Code Object +Provides details regarding the OAuth2's Authorization Code Grant flow type. + +Field Name | Type | Description +---|:---:|--- +tokenRequestEndpoint | [Token Request Endpoint Object](#5111-token-request-endpoint-object) | **Required.** The token request endpoint definition. +tokenEndpoint | [Token Endpoint Object](#5112-token-endpoint-object) | **Required.** The token endpoint definition. + +##### 5.1.9.1 Object Example: +```js +{ + "tokenRequestEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/requestToken", + "clientIdName": "client_id", + "clientSecretName": "client_secret" + }, + "tokenEndpoint": { + "url": "http://petstore.swagger.wordnik.com/oauth/token", + "tokenName": "access_code" + } +} +``` + +#### 5.1.10 Login Endpoint Object +Provides details regarding the Implicit Grant's *authorization endpoint*. + +Field Name | Type | Description +---|:---:|--- +url | `string` | **Required.** The URL of the authorization endpoint for the implicit grant flow. The value SHOULD be in a URL format. + +##### 5.1.10.1 Object Example: +```js +{ + "url": "http://petstore.swagger.wordnik.com/oauth/dialog" +} +``` + +#### 5.1.11 Token Request Endpoint Object +Provides details regarding the OAuth2's *Authorization Endpoint*. + +Field Name | Type | Description +---|:---:|--- +url | `string` | **Required.** The URL of the authorization endpoint for the authentication code grant flow. The value SHOULD be in a URL format. +clientIdName | `string` | An optional alternative name to standard "client_id" OAuth2 parameter. +clientSecretName | `string` | An optional alternative name to the standard "client_secret" OAuth2 parameter. + +##### 5.1.11.1 Object Example: +```js +{ + "url": "http://petstore.swagger.wordnik.com/oauth/requestToken", + "clientIdName": "client_id", + "clientSecretName": "client_secret" +} +``` + +#### 5.1.12 Token Endpoint Object +Provides details regarding the OAuth2's *Token Endpoint*. + +Field Name | Type | Description +---|:---:|--- +url | `string` | **Required.** The URL of the token endpoint for the authentication code grant flow. The value SHOULD be in a URL format. +tokenName | `string` | An optional alternative name to standard "access_token" OAuth2 parameter. + +##### 5.1.12.1 Object Example: +```js +{ + "url": "http://petstore.swagger.wordnik.com/oauth/token", + "tokenName": "access_code" +} +``` + +### 5.2 API Declaration + +The API Declaration provides information about an API exposed on a resource. There should be one file per [Resource](#512-resource-object) described. The file MUST be served in the URL described by the [`path`](#aePath) field. + +Field Name | Type | Description +---|:---:|--- +swaggerVersion | `string` | **Required.** Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be an existing Swagger specification version.
Currently, `"1.0"`, `"1.1"`, `"1.2"` are valid values. +apiVersion | `string` | Provides the version of the application API (not to be confused by the [specification version](#adSwaggerVersion)). +basePath | `string` | **Required.** The root URL serving the API. This field is important because while it is common to have the Resource Listing and API Declarations on the server providing the APIs themselves, it is not a requirement. The API specifications can be served using static files and not generated by the API server itself, so the URL for serving the API cannot always be derived from the URL serving the API specification. The value SHOULD be in the format of a URL. +resourcePath | `string` | The *relative* path to the resource, from the [`basePath`](#adBasePath), which this API Specification describes. The value MUST precede with a forward slash (`"/"`). +apis | [[API Object](#522-api-object)] | **Required.** A list of the APIs exposed on this resource. There MUST NOT be more than one API Object per [`path`](#apiPath) in the array. +models | [Models Object](#526-models-object) | A list of the models available to this resource. Note that these need to be exposed separately for each API Declaration. +produces | [`string`] | A list of MIME types the APIs on this resource can produce. This is global to all APIs but can be overridden on specific API calls. +consumes | [`string`] | A list of MIME types the APIs on this resource can consume. This is global to all APIs but can be overridden on specific API calls. +authorizations | [Authorizations Object](#5210-authorizations-object) | A list of authorizations schemes *required* for the operations listed in this API declaration. Individual operations may override this setting. If there are multiple authorization schemes described here, it means they're **all** applied. + +#### 5.2.1 Object Example +```js +{ + "apiVersion": "1.0.0", + "swaggerVersion": "1.2", + "basePath": "http://petstore.swagger.wordnik.com/api", + "resourcePath": "/store", + "produces": [ + "application/json" + ], + "authorizations": {}, + "apis": [ + { + "path": "/store/order/{orderId}", + "operations": [ + { + "method": "GET", + "summary": "Find purchase order by ID", + "notes": "For valid response try integer IDs with value <= 5. Anything above 5 or nonintegers will generate API errors", + "type": "Order", + "nickname": "getOrderById", + "authorizations": {}, + "parameters": [ + { + "name": "orderId", + "description": "ID of pet that needs to be fetched", + "required": true, + "type": "string", + "paramType": "path" + } + ], + "responseMessages": [ + { + "code": 400, + "message": "Invalid ID supplied" + }, + { + "code": 404, + "message": "Order not found" + } + ] + }, + { + "method": "DELETE", + "summary": "Delete purchase order by ID", + "notes": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", + "type": "void", + "nickname": "deleteOrder", + "authorizations": { + "oauth2": [ + { + "scope": "test:anything", + "description": "anything" + } + ] + }, + "parameters": [ + { + "name": "orderId", + "description": "ID of the order that needs to be deleted", + "required": true, + "type": "string", + "paramType": "path" + } + ], + "responseMessages": [ + { + "code": 400, + "message": "Invalid ID supplied" + }, + { + "code": 404, + "message": "Order not found" + } + ] + } + ] + }, + { + "path": "/store/order", + "operations": [ + { + "method": "POST", + "summary": "Place an order for a pet", + "notes": "", + "type": "void", + "nickname": "placeOrder", + "authorizations": { + "oauth2": [ + { + "scope": "test:anything", + "description": "anything" + } + ] + }, + "parameters": [ + { + "name": "body", + "description": "order placed for purchasing the pet", + "required": true, + "type": "Order", + "paramType": "body" + } + ], + "responseMessages": [ + { + "code": 400, + "message": "Invalid order" + } + ] + } + ] + } + ], + "models": { + "Order": { + "id": "Order", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "petId": { + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int32" + }, + "status": { + "type": "string", + "description": "Order Status", + "enum": [ + "placed", + "approved", + "delivered" + ] + }, + "shipDate": { + "type": "string", + "format": "date-time" + } + } + } + } +} +``` + +#### 5.2.2 API Object +The API Object describes one or more operations on a single [`path`](#apiPath). In the [`apis`](#adApis) array, there MUST be only one [`API Object`](#522-api-object) per [`path`](#apiPath). + +Field Name | Type | Description +---|:---:|--- +path | `string` | **Required.** The relative path to the operation, from the [`basePath`](#adBasePath), which this operation describes. The value SHOULD be in a relative (URL) path format. +description | `string` | *Recommended.* A short description of the resource. +operations | [[Operation Object](#523-operation-object)] | **Required.** A list of the API operations available on this path. The array may include 0 or more operations. There MUST NOT be more than one Operation Object per [`method`](#operationMethod) in the array. + +##### 5.2.2.1 Object Example: + +```js + { + "path": "/pet", + "operations": [ + { + "method": "PUT", + "summary": "Update an existing pet", + "notes": "", + "type": "void", + "nickname": "updatePet", + "authorizations": {}, + "parameters": [ + { + "name": "body", + "description": "Pet object that needs to be updated in the store", + "required": true, + "type": "Pet", + "paramType": "body" + } + ], + "responseMessages": [ + { + "code": 400, + "message": "Invalid ID supplied" + }, + { + "code": 404, + "message": "Pet not found" + }, + { + "code": 405, + "message": "Validation exception" + } + ] + }, + { + "method": "POST", + "summary": "Add a new pet to the store", + "notes": "", + "type": "void", + "nickname": "addPet", + "consumes": [ + "application/json", + "application/xml" + ], + "authorizations": { + "oauth2": [ + { + "scope": "test:anything", + "description": "anything" + } + ] + }, + "parameters": [ + { + "name": "body", + "description": "Pet object that needs to be added to the store", + "required": true, + "type": "Pet", + "paramType": "body" + } + ], + "responseMessages": [ + { + "code": 405, + "message": "Invalid input" + } + ] + } + ] + } +``` + +#### 5.2.3 Operation Object +The Operation Object describes a single operation on a [`path`](#apiPath). + +In the [`operations`](#apiOperations) array, there MUST be only one [`Operation Object`](#523-operation-object) per [`method`](#operationMethod). + +This object includes the [Data Type Fields](#433-data-type-fields) in order to describe the return value of the operation. The [`type`](#dataTypeType) field MUST be used to link to other models. + +This is the only object where the [`type`](#dataTypeType) MAY have the value of [`void`](#432-void) to indicate that the operation returns no value. + +Field Name | Type | Description +---|:---:|--- +method | `string` | **Required.** The HTTP method required to invoke this operation. The value MUST be one of the following values: `"GET"`, `"HEAD"`, `"POST"`, `"PUT"`, `"PATCH"`, `"DELETE"`, `"OPTIONS"`. The values MUST be in uppercase. +summary | `string` | A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters. +notes | `string` | A verbose explanation of the operation behavior. +nickname |`string` | **Required.** A unique id for the operation that can be used by tools reading the output for further and easier manipulation. For example, Swagger-Codegen will use the nickname as the method name of the operation in the client it generates. The value MUST be alphanumeric and may include underscores. Whitespace characters are not allowed. +authorizations | [Authorizations Object](#5210-authorizations-object) | A list of authorizations required to execute this operation. While not mandatory, if used, it overrides the value given at the API Declaration's [authorizations](#adAuthorizations). In order to completely remove API Declaration's authorizations completely, an empty object (`{}`) may be applied. +parameters | [[Parameter Object](#524-parameter-object)] | **Required.** The inputs to the operation. If no parameters are needed, an empty array MUST be included. +responseMessages | [[Response Message Object](#525-response-message-object)] | Lists the possible response statuses that can return from the operation. +produces | [`string`] | A list of MIME types this operation can produce. This is overrides the global [`produces`](#adProduces) definition at the root of the API Declaration. Each `string` value SHOULD represent a MIME type. +consumes | [`string`] | A list of MIME types this operation can consume. This is overrides the global [`consumes`](#adConsumes) definition at the root of the API Declaration. Each `string` value SHOULD represent a MIME type. +deprecated | `string` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Valid value MUST be either `"true"` or `"false"`. *Note:* This field will change to type `boolean` in the future. + +##### 5.2.3.1 Object Example + +````js + { + "method": "GET", + "summary": "Find pet by ID", + "notes": "Returns a pet based on ID", + "type": "Pet", + "nickname": "getPetById", + "authorizations": {}, + "parameters": [ + { + "name": "petId", + "description": "ID of pet that needs to be fetched", + "required": true, + "type": "integer", + "format": "int64", + "paramType": "path", + "minimum": "1.0", + "maximum": "100000.0" + } + ], + "responseMessages": [ + { + "code": 400, + "message": "Invalid ID supplied" + }, + { + "code": 404, + "message": "Pet not found" + } + ] + } +```` + +#### 5.2.4 Parameter Object + +The Parameter Object describes a single parameter to be sent in an operation and maps to the [`parameters`](#operationParameters) field in the [Operation Object](#523-operation-object). + +This object includes the [Data Type Fields](#433-data-type-fields) in order to describe the type of this parameter. The [`type`](#dataTypeType) field MUST be used to link to other models. + +If [`type`](#dataTypeType) is [`File`](#434-file), the [`consumes`](#operationConsumes) field MUST be `"multipart/form-data"`, and the [`paramType`](#parameterParamType) MUST be `"form"`. + +Field Name | Type | Description +---|:---:|--- +paramType | `string` | **Required.** The type of the parameter (that is, the location of the parameter in the request). The value MUST be one of these values: `"path"`, `"query"`, `"body"`, `"header"`, `"form"`. Note that the values MUST be lower case. +name | `string` | **Required.** The unique name for the parameter. Each `name` MUST be unique, even if they are associated with different `paramType` values. Parameter names are *case sensitive*. See [here](#5241-name-examples) for some examples. +description | `string` | *Recommended.* A brief description of this parameter. +required | `boolean` | A flag to note whether this parameter is required. If this field is not included, it is equivalent to adding this field with the value `false`. If [`paramType`](#parameterParamType) is `"path"` then this field MUST be included and have the value `true`. +allowMultiple | `boolean` | Another way to allow multiple values for a "query" parameter. If used, the query parameter may accept comma-separated values. The field may be used only if [`paramType`](#parameterParamType) is `"query"`, `"header"` or `"path"`. + +##### 5.2.4.1 Name Examples +- If [`paramType`](#parameterParamType) is `"path"`, and assuming the `path` is `"/pet/{id}"`: + + ```js +"name": "id" + ``` + +- If [`paramType`](#parameterParamType) is `"query"`, and assuming the URL call is `"http://host/resource?limit=100"` (that is, there's a query parameter called `"limit"`): + + ```js +"name": "limit" + ``` + +- If [`paramType`](#parameterParamType) is `"body"`: + + ```js +"name": "body" + ``` + +##### 5.2.4.2 Object Example + +```js +{ + "name": "body", + "description": "Pet object that needs to be updated in the store", + "required": true, + "type": "Pet", + "paramType": "body" +} +``` + +#### 5.2.5 Response Message Object + +The Response Message Object describes a single possible response message that can be returned from the operation call, and maps to the [`responseMessages`](#operationResponseMessages) field in the [Operation Object](#523-operation-object). Each Response Message allows you to give further details as to why the HTTP status code may be received. + +Field Name | Type | Description | +---|:---:|--- +code | `integer` | **Required.** The HTTP status code returned. The value SHOULD be one of the status codes as described in [RFC 2616 - Section 10](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). +message | `string` | **Required.** The explanation for the status code. It SHOULD be the reason an error is received if an error status code is used. +responseModel | `string` | The return type for the given response. + +##### 5.2.5.1 Object Example + +```js + { + "code": 404, + "message": "no project found", + "responseModel": "ErrorModel" + } +``` + +#### 5.2.6 Models Object + +The Models Object holds a field per model definition, and this is different than the structure of the other objects in the spec. It follows a subset of the [JSON-Schema](http://json-schema.org/) specification. + +Please note that the Models Object is an object containing other object definitions and as such is structured as follows: +```js +{ + "Model1" : {...}, + "Model2" : {...}, + ..., + "ModelN" : {...} +} +``` + +Field Name | Type | Description +---|:---:|--- +{Model Name} | [Model Object](#527-model-object) | A new model definition. Note the actual name of the field is the name you're giving your model. For example, "Category", "Pet", "User". + +##### 5.2.6.1 Object Example + +```js +{ + "Category": { + "id": "Category", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + } + } +} +``` + +#### 5.2.7 Model Object + +A Model Object holds the definition of a new model for this API Declaration. + +Models in Swagger allow for inheritance. The inheritance is controlled by two fields - [`subTypes`](#modelSubTypes) to give the name of the models extending this definition, and [`discriminator`](#modelDiscriminator) to support polymorphism. + +Field Name | Type | Description +---|:---:|--- +id | `string` | **Required.** A unique identifier for the model. This MUST be the name given to [{Model Name}](#modelsModelname). +description | `string` | A brief description of this model. +required | [`string`] | A definition of which properties MUST exist when a model instance is produced. The values MUST be the [`{Property Name}`](#propertiesPropertyName) of one of the [`properties`](#528-properties-object). +properties | [Properties Object](#528-properties-object) | **Required.** A list of properties (fields) that are part of the model +subTypes | [`string`] | List of the [model `id`s](#modelId) that inherit from this model. Sub models inherit all the properties of the parent model. Since inheritance is transitive, if the parent of a model inherits from another model, its sub-model will include all properties. As such, if you have `Foo->Bar->Baz`, then Baz will inherit the properties of Bar and Foo. There MUST NOT be a cyclic definition of inheritance. For example, if `Foo -> ... -> Bar`, having `Bar -> ... -> Foo` is not allowed. There also MUST NOT be a case of multiple inheritance. For example, `Foo -> Baz <- Bar` is not allowed. A sub-model definition MUST NOT override the [`properties`](#modelProperties) of any of its ancestors. All sub-models MUST be defined in the same [API Declaration](#52-api-declaration). +discriminator | `string` | MUST be included only if [`subTypes`](#modelSubTypes) is included. This field allows for polymorphism within the described inherited models. This field MAY be included at any base model but MUST NOT be included in a sub-model. The value of this field MUST be a name of one of the [`properties`](#modelProperties) in this model, and that field MUST be in the [`required`](#modelRequired) list. When used, the value of the *discriminator property* MUST be the name of the parent model or any of its sub-models (to any depth of inheritance). + +##### 5.2.7.1 Object Example + +```js +{ + "id": "Order", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "petId": { + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int32" + }, + "status": { + "type": "string", + "description": "OrderStatus", + "enum": [ + "placed", + "approved", + "delivered" + ] + }, + "shipDate": { + "type": "string", + "format": "date-time" + } + } +} +``` + +##### 5.2.7.2 Inheritance Example + +Say we have a general Animal model, and a sub-model for Cat. + +```js +"Animal": { + "id": "Animal", + "required": [ + "id", + "type" + ], + "properties": { + "id": { + "type": "long" + }, + "type": { + "type": "string" + } + }, + "subTypes": ["Cat"], + "discriminator": "type" +}, +"Cat": { + "id": "Cat", + "required": [ + "likesMilk" + ], + "properties": { + "likesMilk": { + "type": "boolean" + } + }, +} +``` + +#### 5.2.8 Properties Object + +The Properties Object holds a field per property definition, and this is different than the structure of the other objects in the spec. It follows a subset of the [JSON-Schema](http://json-schema.org/) specification. + +Please note that the Properties Object is an object containing other object definitions and as such is structured as follows: +```js +{ + "Property1" : {...}, + "Property2" : {...}, + ..., + "PropertyN" : {...} +} +``` + +Field Name | Type | Description +---|:---:|--- +{Property Name} | [Property Object](#529-property-object) | A new model property definition. Note the actual name of the field is the name you're giving your property. For example, "id", "name", "age". + +##### 5.2.8.1 Object Example +```js + { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + } +``` + +#### 5.2.9 Property Object + +A Property Object holds the definition of a new property for a model. + +This object includes the [Data Type Fields](#433-data-type-fields) in order to describe the type of this property. The [`$ref`](#dataTypeRef) field MUST be used when linking to other models. + +Properties MUST NOT contain other properties. If there's a need for an internal object hierarchy, additional models MUST be created and linked to a flat structure. + +Field Name | Type | Description +---|:---:|--- +description | `string` | *Recommended.* A brief description of this property. + +##### 5.2.9.1 Object Examples + +A simple 64bit integer field called "id", with a description and min/max values: + +```js +"id": { + "type": "integer", + "format": "int64", + "description": "unique identifier for the pet", + "minimum": "0.0", + "maximum": "100.0" +} +``` + +A "category" field of a Category model. + +```js +"category": { + "$ref": "Category" +} +``` + +A "tags" field of type array containing Tag models. + +```js +"tags": { + "type": "array", + "items": { + "$ref": "Tag" + } +} +``` + +#### 5.2.10 Authorizations Object +The Authorizations Object provides information about the authorization schemes enforced on this API. If used in the API Declaration's [authorizations](#adAuthorizations), it applies to all operations listed. If used in the Operation's [authorizations](#operationAuthorizations), it applies to the operation itself and may override the API Declaration's authorizations. +If multiple authorization schemes are described, they are **all** required to perform the operations listed. + +Please note that the Authorizations Object is an object containing arrays of object definitions and as such is structured as follows: +```js +{ + "Authorization1" : [...], + "Authorization2" : [...], + ..., + "AuthorizationN" : [...] +} +``` + +Field Name | Type | Description +---|:---:|--- +{Authorization Name} | * | The authorization scheme to be used. The name given to the {Authorization Name} MUST be a friendly name that was given to an authorization scheme in the Resource Listing's [authorizations](#rlAuthorizations). If the friendly name describes an OAuth2 security scheme, the value should be of type \[[Scope Object](#5211-scope-object)\] (but may be an empty array to denote 'no scopes'). For all other authorization scheme types, the value MUST be an empty array. + +##### 5.2.10 Object Example: +```js +{ + "oauth2": [ + { + "scope": "write:pets", + "description": "modify pets in your account" + }, + { + "scope": "read:pets", + "description": "read your pets" + } + ] +} +``` + +#### 5.2.11 Scope Object +Describes an OAuth2 authorization scope. The scope described here MUST be described in the respective friendly name definition of the security scheme in the Resource Listing's [authorizations](#rlAuthorizations). + +Field Name | Type | Description +---|:---:|--- +scope | `string` | **Required.** The name of the scope. +description | `string` | *Recommended.* A short description of the scope. + +##### 5.2.11.1 Object Example: +```js +{ + "scope": "email", + "description": "Access to your email address" +} +``` diff --git a/docs/2.0.md b/docs/2.0.md new file mode 100755 index 0000000000..7c18e77660 --- /dev/null +++ b/docs/2.0.md @@ -0,0 +1,2330 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Swagger RESTful API Documentation Specification](#swagger-restful-api-documentation-specification) + - [Version 2.0](#version-20) + - [Introduction](#introduction) + - [Revision History](#revision-history) + - [Definitions](#definitions) + - [Specification](#specification) + - [Format](#format) + - [File Structure](#file-structure) + - [Data Types](#data-types) + - [Schema](#schema) + - [Swagger Object](#a-nameswaggerobjectaswagger-object) + - [Info Object](#a-nameinfoobjectainfo-object) + - [Contact Object](#a-namecontactobjectacontact-object) + - [License Object](#a-namelicenseobjectalicense-object) + - [Paths Object](#a-namepathsobjectapaths-object) + - [Path Item Object](#a-namepathitemobjectapath-item-object) + - [Operation Object](#a-nameoperationobjectaoperation-object) + - [External Documentation Object](#a-nameexternaldocumentationobjectaexternal-documentation-object) + - [Parameter Object](#a-nameparameterobjectaparameter-object) + - [Items Object](#a-nameitemsobjectaitems-object) + - [Responses Object](#a-nameresponsesobjectaresponses-object) + - [Response Object](#a-nameresponseobjectaresponse-object) + - [Headers Object](#a-nameheadersobjectaheaders-object) + - [Example Object](#a-nameexampleobjectaexample-object) + - [Header Object](#a-nameheaderobjectaheader-object) + - [Tag Object](#a-nametagobjectatag-object) + - [Reference Object](#a-namereferenceobjectareference-object) + - [Schema Object](#a-nameschemaobjectaschema-object) + - [XML Object](#a-namexmlobjectaxml-object) + - [Definitions Object](#a-namedefinitionsobjectadefinitions-object) + - [Parameters Definitions Object](#a-nameparametersdefinitionsobjectaparameters-definitions-object) + - [Responses Definitions Object](#a-nameresponsesdefinitionsobjectaresponses-definitions-object) + - [Security Definitions Object](#a-namesecuritydefinitionsobjectasecurity-definitions-object) + - [Security Scheme Object](#a-namesecurityschemeobjectasecurity-scheme-object) + - [Scopes Object](#a-namescopesobjectascopes-object) + - [Security Requirement Object](#a-namesecurityrequirementobjectasecurity-requirement-object) + - [Specification Extensions](#a-namevendorextensionsaspecification-extensions) + - [Security Filtering](#a-namesecurityfilteringasecurity-filtering) + + + +# Swagger RESTful API Documentation Specification + +#### Version 2.0 + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt). + +The Swagger specification is licensed under [The Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). + +## Introduction + +Swagger™ is a project used to describe and document RESTful APIs. + +The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools. + +## Revision History + +Version | Date | Notes +--- | --- | --- +2.0 | 2014-09-08 | Release of Swagger 2.0 +1.2 | 2014-03-14 | Initial release of the formal document. +1.1 | 2012-08-22 | Release of Swagger 1.1 +1.0 | 2011-08-10 | First release of the Swagger Specification + +## Definitions + +##### Path Templating +Path templating refers to the usage of curly braces ({}) to mark a section of a URL path as replaceable using path parameters. + +##### Mime Types +Mime type definitions are spread across several resources. The mime type definitions should be in compliance with [RFC 6838](http://tools.ietf.org/html/rfc6838). + +Some examples of possible mime type definitions: +``` + text/plain; charset=utf-8 + application/json + application/vnd.github+json + application/vnd.github.v3+json + application/vnd.github.v3.raw+json + application/vnd.github.v3.text+json + application/vnd.github.v3.html+json + application/vnd.github.v3.full+json + application/vnd.github.v3.diff + application/vnd.github.v3.patch +``` +##### HTTP Status Codes +The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are described by [RFC 7231](http://tools.ietf.org/html/rfc7231#section-6) and in the [IANA Status Code Registry](http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). + +## Specification + +### Format + +The files describing the RESTful API in accordance with the Swagger specification are represented as JSON objects and conform to the JSON standards. YAML, being a superset of JSON, can be used as well to +represent a Swagger specification file. + +For example, if a field is said to have an array value, the JSON array representation will be used: + +```js +{ + "field" : [...] +} +``` + +While the API is described using JSON it does not impose a JSON input/output to the API itself. + +All field names in the specification are **case sensitive**. + +The schema exposes two types of fields. Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name. Patterned fields can have multiple occurrences as long as each has a unique name. + +### File Structure + +The Swagger representation of the API is made of a single file. However, parts of the definitions can be split into separate files, at the discretion of the user. This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](http://json-schema.org) definitions. + +By convention, the Swagger specification file is named `swagger.json`. + +### Data Types + +Primitive data types in the Swagger Specification are based on the types supported by the [JSON-Schema Draft 4](http://json-schema.org/latest/json-schema-core.html#anchor8). Models are described using the [Schema Object](#schemaObject) which is a subset of JSON Schema Draft 4. + +An additional primitive data type `"file"` is used by the [Parameter Object](#parameterObject) and the [Response Object](#responseObject) to set the parameter type or the response as being a file. + +Primitives have an optional modifier property `format`. Swagger uses several known formats to more finely define the data type being used. However, the `format` property is an open `string`-valued property, and can have any value to support documentation needs. Formats such as `"email"`, `"uuid"`, etc., can be used even though they are not defined by this specification. Types that are not accompanied by a `format` property follow their definition from the JSON Schema (except for `file` type which is defined above). The formats defined by the Swagger Specification are: + + +Common Name | [`type`](#dataTypeType) | [`format`](#dataTypeFormat) | Comments +----------- | ------ | -------- | -------- +integer | `integer` | `int32` | signed 32 bits +long | `integer` | `int64` | signed 64 bits +float | `number` | `float` | | +double | `number` | `double` | | +string | `string` | | | +byte | `string` | `byte` | base64 encoded characters +binary | `string` | `binary` | any sequence of octets +boolean | `boolean` | | | +date | `string` | `date` | As defined by `full-date` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14) +dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14) +password | `string` | `password` | Used to hint UIs the input needs to be obscured. + +### Schema + +#### Swagger Object + +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. + +##### Fixed Fields + +Field Name | Type | Description +---|:---:|--- +swagger | `string` | **Required.** Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be `"2.0"`. +info | [Info Object](#infoObject) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed. +host | `string` | The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the `host` is not included, the host serving the documentation is to be used (including the port). The `host` does not support [path templating](#pathTemplating). +basePath | `string` | The base path on which the API is served, which is relative to the [`host`](#swaggerHost). If it is not included, the API is served directly under the `host`. The value MUST start with a leading slash (`/`). The `basePath` does not support [path templating](#pathTemplating). +schemes | [`string`] | The transfer protocol of the API. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. If the `schemes` is not included, the default scheme to be used is the one used to access the Swagger definition itself. +consumes | [`string`] | A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](#mimeTypes). +produces | [`string`] | A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](#mimeTypes). +paths | [Paths Object](#pathsObject) | **Required.** The available paths and operations for the API. +definitions | [Definitions Object](#definitionsObject) | An object to hold data types produced and consumed by operations. +parameters | [Parameters Definitions Object](#parametersDefinitionsObject) | An object to hold parameters that can be used across operations. This property *does not* define global parameters for all operations. +responses | [Responses Definitions Object](#responsesDefinitionsObject) | An object to hold responses that can be used across operations. This property *does not* define global responses for all operations. +securityDefinitions | [Security Definitions Object](#securityDefinitionsObject) | Security scheme definitions that can be used across the specification. +security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition. +tags | [[Tag Object](#tagObject)] | 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](#operationObject) 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. +externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +#### Info Object + +The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience. + +##### Fixed Fields + +Field Name | Type | Description +---|:---:|--- +title | `string` | **Required.** The title of the application. +description | `string` | A short description of the application. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation. +termsOfService | `string` | The Terms of Service for the API. +contact | [Contact Object](#contactObject) | The contact information for the exposed API. +license | [License Object](#licenseObject) | The license information for the exposed API. +version | `string` | **Required** Provides the version of the application API (not to be confused with the specification version). + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Info Object Example: + +```js +{ + "title": "Swagger Sample App", + "description": "This is a sample server Petstore server.", + "termsOfService": "http://swagger.io/terms/", + "contact": { + "name": "API Support", + "url": "http://www.swagger.io/support", + "email": "support@swagger.io" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.1" +} +``` + +```yaml +title: Swagger Sample App +description: This is a sample server Petstore server. +termsOfService: http://swagger.io/terms/ +contact: + name: API Support + url: http://www.swagger.io/support + email: support@swagger.io +license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html +version: 1.0.1 +``` + +#### Contact Object + +Contact information for the exposed API. + +##### Fixed Fields + +Field Name | Type | Description +---|:---:|--- +name | `string` | The identifying name of the contact person/organization. +url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. +email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Contact Object Example: + +```js +{ + "name": "API Support", + "url": "http://www.swagger.io/support", + "email": "support@swagger.io" +} +``` + +```yaml +name: API Support +url: http://www.swagger.io/support +email: support@swagger.io +``` + +#### License Object + +License information for the exposed API. + +##### Fixed Fields + +Field Name | Type | Description +---|:---:|--- +name | `string` | **Required.** The license name used for the API. +url | `string` | A URL to the license used for the API. MUST be in the format of a URL. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### License Object Example: + +```js +{ + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" +} +``` + +```yaml +name: Apache 2.0 +url: http://www.apache.org/licenses/LICENSE-2.0.html +``` + +#### Paths Object + +Holds the relative paths to the individual endpoints. The path is appended to the [`basePath`](#swaggerBasePath) in order to construct the full URL. +The Paths may be empty, due to [ACL constraints](#securityFiltering). + +##### Patterned Fields + +Field Pattern | Type | Description +---|:---:|--- +/{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the [`basePath`](#swaggerBasePath) in order to construct the full URL. [Path templating](#pathTemplating) is allowed. +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Paths Object Example + +```js +{ + "/pets": { + "get": { + "description": "Returns all pets from the system that the user has access to", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A list of pets.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/pet" + } + } + } + } + } + } +} +``` + +```yaml +/pets: + get: + description: Returns all pets from the system that the user has access to + produces: + - application/json + responses: + 200: + description: A list of pets. + schema: + type: array + items: + $ref: '#/definitions/pet' +``` + +#### Path Item Object + +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. + +##### Fixed Fields + +Field Name | Type | Description +---|:---:|--- +$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#pathItemObject). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is *undefined*. +get | [Operation Object](#operationObject) | A definition of a GET operation on this path. +put | [Operation Object](#operationObject) | A definition of a PUT operation on this path. +post | [Operation Object](#operationObject) | A definition of a POST operation on this path. +delete | [Operation Object](#operationObject) | A definition of a DELETE operation on this path. +options | [Operation Object](#operationObject) | A definition of a OPTIONS operation on this path. +head | [Operation Object](#operationObject) | A definition of a HEAD operation on this path. +patch | [Operation Object](#operationObject) | A definition of a PATCH operation on this path. +parameters | [[Parameter Object](#parameterObject) | [Reference Object](#referenceObject)] | 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 [Swagger Object's parameters](#swaggerParameters). There can be one "body" parameter at most. + +##### Patterned Fields + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Path Item Object Example + +```js +{ + "get": { + "description": "Returns pets based on ID", + "summary": "Find pets by ID", + "operationId": "getPetsById", + "produces": [ + "application/json", + "text/html" + ], + "responses": { + "200": { + "description": "pet response", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Pet" + } + } + }, + "default": { + "description": "error payload", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of pet to use", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ] +} +``` + +```yaml +get: + description: Returns pets based on ID + summary: Find pets by ID + operationId: getPetsById + produces: + - application/json + - text/html + responses: + 200: + description: pet response + schema: + type: array + items: + $ref: '#/definitions/Pet' + default: + description: error payload + schema: + $ref: '#/definitions/ErrorModel' +parameters: +- name: id + in: path + description: ID of pet to use + required: true + type: array + items: + type: string + collectionFormat: csv +``` + +#### Operation Object + +Describes a single API operation on a path. + +##### Fixed Fields + +Field Name | Type | Description +---|:---:|--- +tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. +summary | `string` | A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters. +description | `string` | A verbose explanation of the operation behavior. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation. +externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation. +operationId | `string` | 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. +consumes | [`string`] | A list of MIME types the operation can consume. This overrides the [`consumes`](#swaggerConsumes) definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](#mimeTypes). +produces | [`string`] | A list of MIME types the operation can produce. This overrides the [`produces`](#swaggerProduces) definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](#mimeTypes). +parameters | [[Parameter Object](#parameterObject) | [Reference Object](#referenceObject)] | 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 [Swagger Object's parameters](#swaggerParameters). There can be one "body" parameter at most. +responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation. +schemes | [`string`] | The transfer protocol for the operation. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. The value overrides the Swagger Object [`schemes`](#swaggerSchemes) definition. +deprecated | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is `false`. +security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level [`security`](#swaggerSecurity). To remove a top-level security declaration, an empty array can be used. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Operation Object Example + +```js +{ + "tags": [ + "pet" + ], + "summary": "Updates a pet in the store with form data", + "description": "", + "operationId": "updatePetWithForm", + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml" + ], + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet that needs to be updated", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "formData", + "description": "Updated name of the pet", + "required": false, + "type": "string" + }, + { + "name": "status", + "in": "formData", + "description": "Updated status of the pet", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Pet updated." + }, + "405": { + "description": "Invalid input" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] +} +``` + +```yaml +tags: +- pet +summary: Updates a pet in the store with form data +description: "" +operationId: updatePetWithForm +consumes: +- application/x-www-form-urlencoded +produces: +- application/json +- application/xml +parameters: +- name: petId + in: path + description: ID of pet that needs to be updated + required: true + type: string +- name: name + in: formData + description: Updated name of the pet + required: false + type: string +- name: status + in: formData + description: Updated status of the pet + required: false + type: string +responses: + 200: + description: Pet updated. + 405: + description: Invalid input +security: +- petstore_auth: + - write:pets + - read:pets +``` + + +#### External Documentation Object + +Allows referencing an external resource for extended documentation. + +##### Fixed Fields + +Field Name | Type | Description +---|:---:|--- +description | `string` | A short description of the target documentation. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation. +url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### External Documentation Object Example + +```js +{ + "description": "Find more info here", + "url": "https://swagger.io" +} +``` + +```yaml +description: Find more info here +url: https://swagger.io +``` + +#### Parameter Object + +Describes a single operation parameter. + +A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). + +There are five possible parameter types. +* Path - Used together with [Path Templating](#pathTemplating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +* Query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +* Header - Custom headers that are expected as part of the request. +* Body - The payload that's appended to the HTTP request. Since there can only be one payload, there can only be *one* body parameter. The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation. +* Form - 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 Swagger's definition, the [`consumes`](#operationConsumes) property of an operation). This is the only parameter type that can be used to send files, thus supporting the `file` type. Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. 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): + * `application/x-www-form-urlencoded` - Similar to the format of Query parameters but as a payload. For example, `foo=1&bar=swagger` - both `foo` and `bar` are form parameters. This is normally used for simple parameters that are being transferred. + * `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. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +name | `string` | **Required.** The name of the parameter. Parameter names are *case sensitive*. +in | `string` | **Required.** The location of the parameter. Possible values are "query", "header", "path", "formData" or "body". +description | `string` | A brief description of the parameter. This could contain examples of use. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation. +required | `boolean` | Determines whether this parameter is mandatory. If the parameter is [`in`](#parameterIn) "path", this property is **required** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. + +If [`in`](#parameterIn) is `"body"`: + +Field Name | Type | Description +---|:---:|--- +schema | [Schema Object](#schemaObject) | **Required.** The schema defining the type used for the body parameter. + +If [`in`](#parameterIn) is any value other than `"body"`: + +Field Name | Type | Description +---|:---:|--- +type | `string` | **Required.** The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, `"array"` or `"file"`. If `type` is `"file"`, the [`consumes`](#operationConsumes) MUST be either `"multipart/form-data"` or `" application/x-www-form-urlencoded"` and the parameter MUST be [`in`](#parameterIn) `"formData"`. +format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](#dataTypeFormat) for further details. +allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. 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. Default value is `false`. +items | [Items Object](#itemsObject) | **Required if [`type`](#parameterType) is "array".** Describes the type of items in the array. +collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. +default | * | Declares the value of the parameter that the server will use if none is provided, 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. (Note: "default" has no meaning for required parameters.) See http://json-schema.org/latest/json-schema-validation.html#anchor101. Unlike JSON Schema this value MUST conform to the defined [`type`](#parameterType) for this parameter. +maximum | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor17. +exclusiveMaximum | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor17. +minimum | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor21. +exclusiveMinimum | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor21. +maxLength | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor26. +minLength | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor29. +pattern | `string` | See http://json-schema.org/latest/json-schema-validation.html#anchor33. +maxItems | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor42. +minItems | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor45. +uniqueItems | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor49. +enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76. +multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14. + + +##### Patterned Fields +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + + +##### Parameter Object Examples + +###### Body Parameters + +A body parameter with a referenced schema definition (normally for a model definition): +```js +{ + "name": "user", + "in": "body", + "description": "user to add to the system", + "required": true, + "schema": { + "$ref": "#/definitions/User" + } +} +``` + +```yaml +name: user +in: body +description: user to add to the system +required: true +schema: + $ref: '#/definitions/User' +``` + +A body parameter that is an array of string values: +```js +{ + "name": "user", + "in": "body", + "description": "user to add to the system", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } +} +``` + +```yaml +name: user +in: body +description: user to add to the system +required: true +schema: + type: array + items: + type: string +``` + +###### Other Parameters + +A header parameter with an array of 64 bit integer numbers: + +```js +{ + "name": "token", + "in": "header", + "description": "token to be passed as a header", + "required": true, + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "collectionFormat": "csv" +} +``` + +```yaml +name: token +in: header +description: token to be passed as a header +required: true +type: array +items: + type: integer + format: int64 +collectionFormat: csv +``` + +A path parameter of a string value: +```js +{ + "name": "username", + "in": "path", + "description": "username to fetch", + "required": true, + "type": "string" +} +``` + +```yaml +name: username +in: path +description: username to fetch +required: true +type: string +``` + +An optional query parameter of a string value, allowing multiple values by repeating the query parameter: +```js +{ + "name": "id", + "in": "query", + "description": "ID of the object to fetch", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" +} +``` + +```yaml +name: id +in: query +description: ID of the object to fetch +required: false +type: array +items: + type: string +collectionFormat: multi +``` + +A form data with file type for a file upload: +```js +{ + "name": "avatar", + "in": "formData", + "description": "The avatar of the user", + "required": true, + "type": "file" +} +``` + +```yaml +name: avatar +in: formData +description: The avatar of the user +required: true +type: file +``` + +#### Items Object + +A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located [`in`](#parameterIn) `"body"`. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +type | `string` | **Required.** The internal type of the array. The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, or `"array"`. Files and models are not allowed. +format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](#dataTypeFormat) for further details. +items | [Items Object](#itemsObject) | **Required if [`type`](#itemsType) is "array".** Describes the type of items in the array. +collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. +default | * | Declares the value of the item that the server will use if none is provided. (Note: "default" has no meaning for required items.) See http://json-schema.org/latest/json-schema-validation.html#anchor101. Unlike JSON Schema this value MUST conform to the defined [`type`](#itemsType) for the data type. +maximum | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor17. +exclusiveMaximum | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor17. +minimum | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor21. +exclusiveMinimum | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor21. +maxLength | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor26. +minLength | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor29. +pattern | `string` | See http://json-schema.org/latest/json-schema-validation.html#anchor33. +maxItems | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor42. +minItems | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor45. +uniqueItems | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor49. +enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76. +multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Items Object Examples + +Items must be of type string and have the minimum length of 2 characters: + +```js +{ + "type": "string", + "minLength": 2 +} +``` + +```yaml +type: string +minLength: 2 +``` + +An array of arrays, the internal array being of type integer, numbers must be between 0 and 63 (inclusive): + +```js +{ + "type": "array", + "items": { + "type": "integer", + "minimum": 0, + "maximum": 63 + } +} +``` + +```yaml +type: array +items: + type: integer + minimum: 0 + maximum: 63 +``` + +#### Responses Object + +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. + +The `default` can be used a default response object for all HTTP codes that are not covered individually by the specification. + +The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +default | [Response Object](#responseObject) | [Reference Object](#referenceObject) | The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. [Reference Object](#referenceObject) can be used to link to a response that is defined at the [Swagger Object's responses](#swaggerResponses) section. + +##### Patterned Fields +Field Pattern | Type | Description +---|:---:|--- +{[HTTP Status Code](#httpCodes)} | [Response Object](#responseObject) | [Reference Object](#referenceObject) | Any [HTTP status code](#httpCodes) can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. [Reference Object](#referenceObject) can be used to link to a response that is defined at the [Swagger Object's responses](#swaggerResponses) section. +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + + +##### Responses Object Example + +A 200 response for successful operation and a default response for others (implying an error): + +```js +{ + "200": { + "description": "a pet to be returned", + "schema": { + "$ref": "#/definitions/Pet" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } +} +``` + +```yaml +200: + description: a pet to be returned + schema: + $ref: '#/definitions/Pet' +default: + description: Unexpected error + schema: + $ref: '#/definitions/ErrorModel' +``` + +#### Response Object +Describes a single response from an API Operation. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +description | `string` | **Required.** A short description of the response. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation. +schema | [Schema Object](#schemaObject) | A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the [Schema Object](#schemaObject), its root `type` value may also be `"file"`. This SHOULD be accompanied by a relevant `produces` mime-type. +headers | [Headers Object](#headersObject) | A list of headers that are sent with the response. +examples | [Example Object](#exampleObject) | An example of the response message. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Response Object Examples + +Response of an array of a complex type: + +```js +{ + "description": "A complex object array response", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VeryComplexType" + } + } +} +``` + +```yaml +description: A complex object array response +schema: + type: array + items: + $ref: '#/definitions/VeryComplexType' +``` + +Response with a string type: + +```js +{ + "description": "A simple string response", + "schema": { + "type": "string" + } +} +``` + +```yaml +description: A simple string response +schema: + type: string +``` + +Response with headers: + +```js +{ + "description": "A simple string response", + "schema": { + "type": "string" + }, + "headers": { + "X-Rate-Limit-Limit": { + "description": "The number of allowed requests in the current period", + "type": "integer" + }, + "X-Rate-Limit-Remaining": { + "description": "The number of remaining requests in the current period", + "type": "integer" + }, + "X-Rate-Limit-Reset": { + "description": "The number of seconds left in the current period", + "type": "integer" + } + } +} +``` + +```yaml +description: A simple string response +schema: + type: string +headers: + X-Rate-Limit-Limit: + description: The number of allowed requests in the current period + type: integer + X-Rate-Limit-Remaining: + description: The number of remaining requests in the current period + type: integer + X-Rate-Limit-Reset: + description: The number of seconds left in the current period + type: integer +``` + +Response with no return value: + +```js +{ + "description": "object created" +} +``` + +```yaml +description: object created +``` + +#### Headers Object +Lists the headers that can be sent as part of a response. + +##### Patterned Fields +Field Pattern | Type | Description +---|:---:|--- +{name} | [Header Object](#headerObject) | The name of the property corresponds to the name of the header. The value describes the type of the header. + +##### Headers Object Example + +Rate-limit headers: + +```js +{ + "X-Rate-Limit-Limit": { + "description": "The number of allowed requests in the current period", + "type": "integer" + }, + "X-Rate-Limit-Remaining": { + "description": "The number of remaining requests in the current period", + "type": "integer" + }, + "X-Rate-Limit-Reset": { + "description": "The number of seconds left in the current period", + "type": "integer" + } +} +``` + +```yaml +X-Rate-Limit-Limit: + description: The number of allowed requests in the current period + type: integer +X-Rate-Limit-Remaining: + description: The number of remaining requests in the current period + type: integer +X-Rate-Limit-Reset: + description: The number of seconds left in the current period + type: integer +``` + +#### Example Object + +Allows sharing examples for operation responses. + +##### Patterned Fields +Field Pattern | Type | Description +---|:---:|--- +{[mime type](#mimeTypes)} | Any | The name of the property MUST be one of the Operation `produces` values (either implicit or inherited). The value SHOULD be an example of what such a response would look like. + +##### Example Object Example + +Example response for application/json mimetype of a Pet data type: + +```js +{ + "application/json": { + "name": "Puma", + "type": "Dog", + "color": "Black", + "gender": "Female", + "breed": "Mixed" + } +} +``` + +```yaml +application/json: + name: Puma + type: Dog + color: Black + gender: Female + breed: Mixed +``` + +#### Header Object + +Field Name | Type | Description +---|:---:|--- +description | `string` | A short description of the header. +type | `string` | **Required.** The type of the object. The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, or `"array"`. +format | `string` | The extending format for the previously mentioned [`type`](#stType). See [Data Type Formats](#dataTypeFormat) for further details. +items | [Items Object](#itemsObject) | **Required if [`type`](#stType) is "array".** Describes the type of items in the array. +collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. +default | * | Declares the value of the header that the server will use if none is provided. (Note: "default" has no meaning for required headers.) See http://json-schema.org/latest/json-schema-validation.html#anchor101. Unlike JSON Schema this value MUST conform to the defined [`type`](#headerDefault) for the header. +maximum | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor17. +exclusiveMaximum | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor17. +minimum | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor21. +exclusiveMinimum | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor21. +maxLength | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor26. +minLength | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor29. +pattern | `string` | See http://json-schema.org/latest/json-schema-validation.html#anchor33. +maxItems | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor42. +minItems | `integer` | See http://json-schema.org/latest/json-schema-validation.html#anchor45. +uniqueItems | `boolean` | See http://json-schema.org/latest/json-schema-validation.html#anchor49. +enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76. +multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Header Object Example + +A simple header with of an integer type: + +```js +{ + "description": "The number of allowed requests in the current period", + "type": "integer" +} +``` + +```yaml +description: The number of allowed requests in the current period +type: integer +``` + +#### Tag Object + +Allows adding meta data to a single tag that is used by the [Operation Object](#operationObject). It is not mandatory to have a Tag Object per tag used there. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +name | `string` | **Required.** The name of the tag. +description | `string` | A short description for the tag. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation. +externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this tag. + +##### Patterned Fields +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Tag Object Example + +```js +{ + "name": "pet", + "description": "Pets operations" +} +``` + +```yaml +name: pet +description: Pets operations +``` + +#### Reference Object + +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. + +The Reference Object is a [JSON Reference](http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02) that uses a [JSON Pointer](http://tools.ietf.org/html/rfc6901) as its value. For this specification, only [canonical dereferencing](http://json-schema.org/latest/json-schema-core.html#anchor27) is supported. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +$ref | `string` | **Required.** The reference string. + +##### Reference Object Example + +```js +{ + "$ref": "#/definitions/Pet" +} +``` + +```yaml +$ref: '#/definitions/Pet' +``` + +##### Relative Schema File Example +```js +{ + "$ref": "Pet.json" +} +``` + +```yaml +$ref: 'Pet.yaml' +``` + +##### Relative Files With Embedded Schema Example +```js +{ + "$ref": "definitions.json#/Pet" +} +``` + +```yaml +$ref: 'definitions.yaml#/Pet' +``` + +#### Schema Object + +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 based on the [JSON Schema Specification Draft 4](http://json-schema.org/) and uses a predefined subset of it. On top of this subset, there are extensions provided by this specification to allow for more complete documentation. + +Further information about the properties can be found in [JSON Schema Core](http://json-schema.org/latest/json-schema-core.html) and [JSON Schema Validation](http://json-schema.org/latest/json-schema-validation.html). Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here. + +The following properties are taken directly from the JSON Schema definition and follow the same specifications: +- $ref - As a [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) +- format (See [Data Type Formats](#dataTypeFormat) for further details) +- title +- description ([GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation) +- default (Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object) +- multipleOf +- maximum +- exclusiveMaximum +- minimum +- exclusiveMinimum +- maxLength +- minLength +- pattern +- maxItems +- minItems +- uniqueItems +- maxProperties +- minProperties +- required +- enum +- type + +The following properties are taken from the JSON Schema definition but their definitions were adjusted to the Swagger Specification. Their definition is the same as the one from JSON Schema, only where the original definition references the JSON Schema definition, the [Schema Object](#schemaObject) definition is used instead. +- items +- allOf +- properties +- additionalProperties + +Other than the JSON Schema subset fields, the following fields may be used for further schema documentation. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +discriminator | `string` | 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. +readOnly | `boolean` | 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`. +xml | [XML Object](#xmlObject) | 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. +externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this schema. +example | Any | A free-form property to include a an example of an instance for this schema. + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +###### Composition and Inheritance (Polymorphism) + +Swagger 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. + +While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, Swagger 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. + +###### XML Modeling + +The [xml](#schemaXml) property allows extra definitions when translating the JSON definition to XML. The [XML Object](#xmlObject) contains additional information about the available options. + +##### Schema Object Examples + +###### Primitive Sample + +Unlike previous versions of Swagger, Schema definitions can be used to describe primitive and arrays as well. + +```js +{ + "type": "string", + "format": "email" +} +``` + +```yaml +type: string +format: email +``` + +###### Simple Model + +```js +{ + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "address": { + "$ref": "#/definitions/Address" + }, + "age": { + "type": "integer", + "format": "int32", + "minimum": 0 + } + } +} +``` + +```yaml +type: object +required: +- name +properties: + name: + type: string + address: + $ref: '#/definitions/Address' + age: + type: integer + format: int32 + minimum: 0 +``` + +###### Model with Map/Dictionary Properties + +For a simple string to string mapping: + +```js +{ + "type": "object", + "additionalProperties": { + "type": "string" + } +} +``` + +```yaml +type: object +additionalProperties: + type: string +``` + +For a string to model mapping: + +```js +{ + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ComplexModel" + } +} +``` + +```yaml +type: object +additionalProperties: + $ref: '#/definitions/ComplexModel' +``` + +###### Model with Example + +```js +{ + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + }, + "required": [ + "name" + ], + "example": { + "name": "Puma", + "id": 1 + } +} +``` + +```yaml +properties: + id: + type: integer + format: int64 + name: + type: string +required: +- name +example: + name: Puma + id: 1 +``` + +###### Models with Composition + +```js +{ + "definitions": { + "ErrorModel": { + "type": "object", + "required": [ + "message", + "code" + ], + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "integer", + "minimum": 100, + "maximum": 600 + } + } + }, + "ExtendedErrorModel": { + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + }, + { + "type": "object", + "required": [ + "rootCause" + ], + "properties": { + "rootCause": { + "type": "string" + } + } + } + ] + } + } +} +``` + +```yaml +definitions: + ErrorModel: + type: object + required: + - message + - code + properties: + message: + type: string + code: + type: integer + minimum: 100 + maximum: 600 + ExtendedErrorModel: + allOf: + - $ref: '#/definitions/ErrorModel' + - type: object + required: + - rootCause + properties: + rootCause: + type: string +``` + +###### Models with Polymorphism Support + +```js +{ + "definitions": { + "Pet": { + "discriminator": "petType", + "properties": { + "name": { + "type": "string" + }, + "petType": { + "type": "string" + } + }, + "required": [ + "name", + "petType" + ] + } + }, + "Cat": { + "description": "A representation of a cat", + "allOf": [ + { + "$ref": "#/definitions/Pet" + }, + { + "properties": { + "huntingSkill": { + "type": "string", + "description": "The measured skill for hunting", + "default": "lazy", + "enum": [ + "clueless", + "lazy", + "adventurous", + "aggressive" + ] + } + }, + "required": [ + "huntingSkill" + ] + } + ] + }, + "Dog": { + "description": "A representation of a dog", + "allOf": [ + { + "$ref": "#/definitions/Pet" + }, + { + "properties": { + "packSize": { + "type": "integer", + "format": "int32", + "description": "the size of the pack the dog is from", + "default": 0, + "minimum": 0 + } + }, + "required": [ + "packSize" + ] + } + ] + } +} +``` + +```yaml +definitions: + Pet: + discriminator: petType + properties: + name: + type: string + petType: + type: string + required: + - name + - petType +Cat: + description: A representation of a cat + allOf: + - $ref: '#/definitions/Pet' + - properties: + huntingSkill: + type: string + description: The measured skill for hunting + default: lazy + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill +Dog: + description: A representation of a dog + allOf: + - $ref: '#/definitions/Pet' + - properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize +``` + +#### XML Object + +A metadata object that allows for more fine-tuned XML model definitions. + +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. + +##### Fixed Fields +Field Name | Type | Description +---|:---:|--- +name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (`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. +namespace | `string` | The URL of the namespace definition. Value SHOULD be in the form of a URL. +prefix | `string` | The prefix to be used for the [name](#xmlName). +attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. +wrapped | `boolean` | 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`). + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### XML Object Examples + +The examples of the XML object definitions are included inside a property definition of a [Schema Object](#schemaObject) with a sample of the XML representation of it. + +###### No XML Element + +Basic string property: + +```js +{ + "animals": { + "type": "string" + } +} +``` + +```yaml +animals: + type: string +``` + +```xml +... +``` + +Basic string array property ([`wrapped`](#xmlWrapped) is `false` by default): + +```js +{ + "animals": { + "type": "array", + "items": { + "type": "string" + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string +``` + +```xml +... +... +... +``` + +###### XML Name Replacement + +```js +{ + "animals": { + "type": "string", + "xml": { + "name": "animal" + } + } +} +``` + +```yaml +animals: + type: string + xml: + name: animal +``` + +```xml +... +``` + + +###### XML Attribute, Prefix and Namespace + +In this example, a full model definition is shown. + +```js +{ + "Person": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "xml": { + "attribute": true + }, + "name": { + "type": "string", + "xml": { + "namespace": "http://swagger.io/schema/sample", + "prefix": "sample" + } + } + } + } + } +} +``` + +```yaml +Person: + type: object + properties: + id: + type: integer + format: int32 + xml: + attribute: true + name: + type: string + xml: + namespace: http://swagger.io/schema/sample + prefix: sample +``` + +```xml + + example + +``` + +###### XML Arrays + +Changing the element names: + +```js +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal +``` + +```xml +value +value +``` + +The external `name` property has no effect on the XML: + +```js +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + }, + "xml": { + "name": "aliens" + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal + xml: + name: aliens +``` + +```xml +value +value +``` + +Even when the array is wrapped, if no name is explicitly defined, the same name will be used both internally and externally: + +```js +{ + "animals": { + "type": "array", + "items": { + "type": "string" + }, + "xml": { + "wrapped": true + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + wrapped: true +``` + +```xml + + value + value + +``` + +To overcome the above example, the following definition can be used: + +```js +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + }, + "xml": { + "wrapped": true + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal + xml: + wrapped: true +``` + +```xml + + value + value + +``` + +Affecting both internal and external names: + +```js +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + }, + "xml": { + "name": "aliens", + "wrapped": false + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal + xml: + name: aliens + wrapped: false +``` + +```xml + + value + value + +``` + +If we change the external element but not the internal ones: + +```js +{ + "animals": { + "type": "array", + "items": { + "type": "string" + }, + "xml": { + "name": "aliens", + "wrapped": true + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: aliens + wrapped: true +``` + +```xml + + value + value + +``` + +#### Definitions Object + +An object to hold data types that can be consumed and produced by operations. These data types can be primitives, arrays or models. + +##### Patterned Fields + +Field Pattern | Type | Description +---|:---:|--- +{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines. + +##### Definitions Object Example + +```js +{ + "Category": { + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + } + }, + "Tag": { + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + } + } +} +``` + +```yaml +Category: + properties: + id: + type: integer + format: int64 + name: + type: string +Tag: + properties: + id: + type: integer + format: int64 + name: + type: string +``` + +#### Parameters Definitions Object + +An object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here. + +This does *not* define global operation parameters. + +##### Patterned Fields + +Field Pattern | Type | Description +---|:---:|--- +{name} | [Parameter Object](#parameterObject) | A single parameter definition, mapping a "name" to the parameter it defines. + +##### Parameters Definition Object Example + +```js +{ + "skipParam": { + "name": "skip", + "in": "query", + "description": "number of items to skip", + "required": true, + "type": "integer", + "format": "int32" + }, + "limitParam": { + "name": "limit", + "in": "query", + "description": "max records to return", + "required": true, + "type": "integer", + "format": "int32" + } +} +``` + +```yaml +skipParam: + name: skip + in: query + description: number of items to skip + required: true + type: integer + format: int32 +limitParam: + name: limit + in: query + description: max records to return + required: true + type: integer + format: int32 +``` + + +#### Responses Definitions Object + +An object to hold responses to be reused across operations. Response definitions can be referenced to the ones defined here. + +This does *not* define global operation responses. + +##### Patterned Fields + +Field Pattern | Type | Description +---|:---:|--- +{name} | [Response Object](#responseObject) | A single response definition, mapping a "name" to the response it defines. + +##### Responses Definitions Object Example + +```js +{ + "NotFound": { + "description": "Entity not found." + }, + "IllegalInput": { + "description": "Illegal input for operation." + }, + "GeneralError": { + "description": "General Error", + "schema": { + "$ref": "#/definitions/GeneralError" + } + } +} +``` + +```yaml +NotFound: + description: Entity not found. +IllegalInput: + description: Illegal input for operation. +GeneralError: + description: General Error + schema: + $ref: '#/definitions/GeneralError' +``` + +#### Security Definitions Object + +A declaration of the security schemes available to be used in the specification. This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme. + +##### Patterned Fields +Field Pattern | Type | Description +---|:---:|--- +{name} | [Security Scheme Object](#securitySchemeObject) | A single security scheme definition, mapping a "name" to the scheme it defines. + +##### Security Definitions Object Example + +```js +{ + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + }, + "petstore_auth": { + "type": "oauth2", + "authorizationUrl": "http://swagger.io/api/oauth/dialog", + "flow": "implicit", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } +} +``` + +```yaml +api_key: + type: apiKey + name: api_key + in: header +petstore_auth: + type: oauth2 + authorizationUrl: http://swagger.io/api/oauth/dialog + flow: implicit + scopes: + write:pets: modify pets in your account + read:pets: read your pets +``` + +#### Security Scheme Object + +Allows the definition of a security scheme that can be used by the operations. 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). + +##### Fixed Fields +Field Name | Type | Validity | Description +---|:---:|---|--- +type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"basic"`, `"apiKey"` or `"oauth2"`. +description | `string` | Any | A short description for security scheme. +name | `string` | `apiKey` | **Required.** The name of the header or query parameter to be used. +in | `string` | `apiKey` | **Required** The location of the API key. Valid values are `"query"` or `"header"`. +flow | `string` | `oauth2` | **Required.** The flow used by the OAuth2 security scheme. Valid values are `"implicit"`, `"password"`, `"application"` or `"accessCode"`. +authorizationUrl | `string` | `oauth2` (`"implicit"`, `"accessCode"`) | **Required.** The authorization URL to be used for this flow. This SHOULD be in the form of a URL. +tokenUrl | `string` | `oauth2` (`"password"`, `"application"`, `"accessCode"`) | **Required.** The token URL to be used for this flow. This SHOULD be in the form of a URL. +scopes | [Scopes Object](#scopesObject) | `oauth2` | **Required.** The available scopes for the OAuth2 security scheme. + +##### Patterned Fields + +Field Name | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Security Scheme Object Example + +###### Basic Authentication Sample + +```js +{ + "type": "basic" +} +``` + +```yaml +type: basic +``` + +###### API Key Sample + +```js +{ + "type": "apiKey", + "name": "api_key", + "in": "header" +} +``` + +```yaml +type: apiKey +name: api_key +in: header +``` + +###### Implicit OAuth2 Sample + +```js +{ + "type": "oauth2", + "authorizationUrl": "http://swagger.io/api/oauth/dialog", + "flow": "implicit", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } +} +``` + +```yaml +type: oauth2 +authorizationUrl: http://swagger.io/api/oauth/dialog +flow: implicit +scopes: + write:pets: modify pets in your account + read:pets: read your pets +``` + +#### Scopes Object + +Lists the available scopes for an OAuth2 security scheme. + +##### Patterned Fields + +Field Pattern | Type | Description +---|:---:|--- +{name} | `string` | Maps between a name of a scope to a short description of it (as the value of the property). + +##### Patterned Objects + +Field Pattern | Type | Description +---|:---:|--- +^x- | Any | Allows extensions to the Swagger 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. See [Vendor Extensions](#vendorExtensions) for further details. + +##### Scopes Object Example + +```js +{ + "write:pets": "modify pets in your account", + "read:pets": "read your pets" +} +``` + +```yaml +write:pets: modify pets in your account +read:pets: read your pets +``` + +#### Security Requirement Object + +Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required (that is, there is a logical AND between the schemes). + +The name used for each property MUST correspond to a security scheme declared in the [Security Definitions](#securityDefinitionsObject). + +##### Patterned Fields + +Field Pattern | Type | Description +---|:---:|--- +{name} | [`string`] | Each name must correspond to a security scheme which is declared in the [Security Definitions](#securityDefinitions). If the security scheme is of type `"oauth2"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. + +##### Security Requirement Object Examples + +###### Non-OAuth2 Security Requirement + +```js +{ + "api_key": [] +} +``` + +```yaml +api_key: [] +``` + +###### OAuth2 Security Requirement + +```js +{ + "petstore_auth": [ + "write:pets", + "read:pets" + ] +} +``` + +```yaml +petstore_auth: +- write:pets +- read:pets +``` + +### Specification Extensions + +While the Swagger Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points. + +The extensions properties are always prefixed by `"x-"` and 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). + +### Security Filtering + +Some objects in the Swagger specification may be declared and remain empty, or completely be removed, even though they are inherently the core of the API documentation. + +The reasoning behind it is to allow an additional layer of access control over the documentation itself. While not part of the specification itself, certain libraries may choose to allow access to parts of the documentation based on some form of authentication/authorization. + +Two examples for this: + +1. The [Paths Object](#pathsObject) may be empty. It may be counterintuitive, but this may tell the viewer that they got to the right place, but can't access any documentation. They'd still have access to the [Info Object](#infoObject) which may contain additional information regarding authentication. +2. The [Path Item Object](#pathItemObject) may be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different than hiding the path itself from the [Paths Object](#pathsObject) so the user will not be aware of its existence. This allows the documentation provider a finer control over what the viewer can see. diff --git a/gulpfile.js b/gulpfile.js index 261b0b6286..cafd5b1994 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -6,6 +6,7 @@ var ext_replace = require('gulp-ext-replace'); var map = require('map-stream'); var YAML = require('json2yaml'); var gutil = require('gulp-util'); +var toc = require('gulp-doctoc'); var exitCode = 0; @@ -46,3 +47,8 @@ gulp.task('json2yaml', function(){ .pipe(gulp.dest('fixtures/v2.0/yaml')); }); +gulp.task('markdown', function() { + gulp.src('./versions/**/*.md') + .pipe(toc()) + .pipe(gulp.dest('./docs')); +}); diff --git a/package.json b/package.json index 4fa476b77a..4fae49a370 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "devDependencies": { "glob": "^4.0.5", "gulp": "~3.8.x", + "gulp-doctoc": "^0.1.2", "gulp-ext-replace": "^0.1.0", "gulp-jsonlint": "0.0.3", "gulp-util": "^3.0.0",