@loopback/openapi-spec

<!DOCTYPE html>     <html class="no-js">  <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <title></title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="stylesheet" href="css/bootstrap.min.css"> <link rel="stylesheet" href="css/code-themes/sl-theme.css"> <link rel="stylesheet" href="css/main.css"> </head> <body> <div class="navbar navbar-inverse navbar-static-top" role="navigation"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="/">docs.strongloop.com</a> </div> <div id="modules"></div> </div> <div class="row"> <div class="col-lg-3 column scroll-spy-target"> <ul class="nav nav-pills nav-stacked"> <div id="versions"></div> <li class="depth-3"> <a href="#ContactObject">Interface: ContactObject</a> </li> <li class="depth-3"> <a href="#DefinitionsObject">Interface: DefinitionsObject</a> </li> <li class="depth-3"> <a href="#ExampleObject">Interface: ExampleObject</a> </li> <li class="depth-3"> <a href="#Extensible">Interface: Extensible</a> </li> <li class="depth-3"> <a href="#ExternalDocumentationObject">Interface: ExternalDocumentationObject</a> </li> <li class="depth-3"> <a href="#HeaderObject">Interface: HeaderObject</a> </li> <li class="depth-3"> <a href="#HeadersObject">Interface: HeadersObject</a> </li> <li class="depth-3"> <a href="#InfoObject">Interface: InfoObject</a> </li> <li class="depth-3"> <a href="#ItemsObject">Interface: ItemsObject</a> </li> <li class="depth-3"> <a href="#LicenseObject">Interface: LicenseObject</a> </li> <li class="depth-3"> <a href="#MapObject">Interface: MapObject</a> </li> <li class="depth-3"> <a href="#OpenApiSpec">Interface: OpenApiSpec</a> </li> <li class="depth-3"> <a href="#OperationObject">Interface: OperationObject</a> </li> <li class="depth-3"> <a href="#ParameterObject">Interface: ParameterObject</a> </li> <li class="depth-3"> <a href="#ParametersDefinitionsObject">Interface: ParametersDefinitionsObject</a> </li> <li class="depth-3"> <a href="#PathItemObject">Interface: PathItemObject</a> </li> <li class="depth-3"> <a href="#PathsObject">Interface: PathsObject</a> </li> <li class="depth-3"> <a href="#ReferenceObject">Interface: ReferenceObject</a> </li> <li class="depth-3"> <a href="#ResponseObject">Interface: ResponseObject</a> </li> <li class="depth-3"> <a href="#ResponsesDefinitionsObject">Interface: ResponsesDefinitionsObject</a> </li> <li class="depth-3"> <a href="#ResponsesObject">Interface: ResponsesObject</a> </li> <li class="depth-3"> <a href="#SchemaObject">Interface: SchemaObject</a> </li> <li class="depth-3"> <a href="#ScopesObject">Interface: ScopesObject</a> </li> <li class="depth-3"> <a href="#SecurityDefinitionsObject">Interface: SecurityDefinitionsObject</a> </li> <li class="depth-3"> <a href="#SecurityRequirementObject">Interface: SecurityRequirementObject</a> </li> <li class="depth-3"> <a href="#SecuritySchemeObject">Interface: SecuritySchemeObject</a> </li> <li class="depth-3"> <a href="#SimpleType">Interface: SimpleType</a> </li> <li class="depth-3"> <a href="#TagObject">Interface: TagObject</a> </li> <li class="depth-3"> <a href="#XMLObject">Interface: XMLObject</a> </li> <li class="depth-3"> <a href="#ExtensionValue">Type alias: ExtensionValue</a> </li> <li class="depth-3"> <a href="#ItemType">Type alias: ItemType</a> </li> <li class="depth-3"> <a href="#ParameterLocation">Type alias: ParameterLocation</a> </li> <li class="depth-3"> <a href="#ParameterType">Type alias: ParameterType</a> </li> <li class="depth-3"> <a href="#290">Function: createEmptyApiSpec</a> </li> </ul> </div> <div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0"> <div class="readability"> <section class="code-doc "> <a name="ContactObject"></a> <h3 class="code-ref">Interface: ContactObject</h3>  <div class="code-desc"> <p><p>Contact information for the exposed API.</p> </p> <p></p> </div> </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="ContactObject"></a> <strong class="code-arg-name">email</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The email address of the contact person/organization. MUST be in the format of an email address.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="ContactObject"></a> <strong class="code-arg-name">name</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The identifying name of the contact person/organization.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="ContactObject"></a> <strong class="code-arg-name">url</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The URL pointing to the contact information. MUST be in the format of a URL.</p> </p> <p></p> </div> </td> </tr> </table> </section> <section class="code-doc "> <a name="DefinitionsObject"></a> <h3 class="code-ref">Interface: DefinitionsObject</h3>  <div class="code-desc"> <p><p>An object to hold data types that can be consumed and produced by operations. These data types can be primitives, arrays or models.</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="ExampleObject"></a> <h3 class="code-ref">Interface: ExampleObject</h3>  <div class="code-desc"> <p><p>Allows sharing examples for operation responses.</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="Extensible"></a> <h3 class="code-ref">Interface: Extensible</h3>  <div class="code-desc"> <p><p>While the Swagger Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.</p> </p> <p><p>The extensions properties are always prefixed by "x-" and can have any valid JSON format value.</p> <p>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).</p> </p> </div> </section> <section class="code-doc "> <a name="ExternalDocumentationObject"></a> <h3 class="code-ref">Interface: ExternalDocumentationObject</h3>  <div class="code-desc"> <p><p>Allows referencing an external resource for extended documentation.</p> </p> <p></p> </div> </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="ExternalDocumentationObject"></a> <strong class="code-arg-name">description</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A short description of the target documentation. GFM syntax can be used for rich text representation.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="ExternalDocumentationObject"></a> <strong class="code-arg-name">url</strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The URL for the target documentation. Value MUST be in the format of a URL.</p> </p> <p></p> </div> </td> </tr> </table> </section> <section class="code-doc "> <a name="HeaderObject"></a> <h3 class="code-ref">Interface: HeaderObject</h3>  </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="HeaderObject"></a> <strong class="code-arg-name">description</strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A short description of the header.</p> </p> <p></p> </div> </td> </tr> </table> </section> <section class="code-doc "> <a name="HeadersObject"></a> <h3 class="code-ref">Interface: HeadersObject</h3>  <div class="code-desc"> <p><p>Lists the headers that can be sent as part of a response.</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="InfoObject"></a> <h3 class="code-ref">Interface: InfoObject</h3>  <div class="code-desc"> <p><p>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.</p> <p><p>Specification: <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject</a></p> </p> <p></p> </div> </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="InfoObject"></a> <strong class="code-arg-name">contact</strong> </td> <td class="code-arg-types"> <code><a href="#ContactObject">ContactObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The contact information for the exposed API.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="InfoObject"></a> <strong class="code-arg-name">description</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A short description of the application. <a href="https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown">GFM syntax</a> can be used for rich text representation.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="InfoObject"></a> <strong class="code-arg-name">license</strong> </td> <td class="code-arg-types"> <code><a href="#LicenseObject">LicenseObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The license information for the exposed API.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="InfoObject"></a> <strong class="code-arg-name">termsOfService</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The Terms of Service for the API.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="InfoObject"></a> <strong class="code-arg-name">title</strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The title of the application.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="InfoObject"></a> <strong class="code-arg-name">version</strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Provides the version of the application API (not to be confused with the specification version).</p> </p> <p></p> </div> </td> </tr> </table> </section> <section class="code-doc "> <a name="ItemsObject"></a> <h3 class="code-ref">Interface: ItemsObject</h3>  <div class="code-desc"> <p><p>A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body". Please note it only differs from SimpleType with parameter types excluding <code>file</code>.</p> </p> <p></p> </div> </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="ItemsObject"></a> <strong class="code-arg-name">type</strong> </td> <td class="code-arg-types"> <code><a href="#ItemType">ItemType</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body". Please note it only differs from SimpleType with parameter types excluding <code>file</code>.</p> </p> <p></p> </div> </td> </tr> </table> </section> <section class="code-doc "> <a name="LicenseObject"></a> <h3 class="code-ref">Interface: LicenseObject</h3>  <div class="code-desc"> <p><p>License information for the exposed API.</p> </p> <p></p> </div> </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="LicenseObject"></a> <strong class="code-arg-name">name</strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The license name used for the API.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="LicenseObject"></a> <strong class="code-arg-name">url</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A URL to the license used for the API. MUST be in the format of a URL.</p> </p> <p></p> </div> </td> </tr> </table> </section> <section class="code-doc "> <a name="MapObject"></a> <h3 class="code-ref">Interface: MapObject</h3>  <div class="code-desc"> <p><p>Maps names to a given type of values</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="OpenApiSpec"></a> <h3 class="code-ref">Interface: OpenApiSpec</h3>  <div class="code-desc"> <p><p>This is the root document object for the API specification.</p> <p><p>Specification: <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-object</a></p> </p> <p></p> </div> </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">basePath</strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The base path on which the API is served, which is relative to the host. 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 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathTemplating">path templating</a>.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">consumes</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">definitions</strong> </td> <td class="code-arg-types"> <code><a href="#DefinitionsObject">DefinitionsObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>An object to hold data types produced and consumed by operations.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">externalDocs</strong> </td> <td class="code-arg-types"> <code><a href="#ExternalDocumentationObject">ExternalDocumentationObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Additional external documentation.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">host</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathTemplating">path templating</a>.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">info</strong> </td> <td class="code-arg-types"> <code><a href="#InfoObject">InfoObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Provides metadata about the API. The metadata can be used by the clients if needed.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">parameters</strong> </td> <td class="code-arg-types"> <code><a href="#ParametersDefinitionsObject">ParametersDefinitionsObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>An object to hold parameters that can be used across operations. This property does not define global parameters for all operations.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">paths</strong> </td> <td class="code-arg-types"> <code><a href="#PathsObject">PathsObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The available paths and operations for the API.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">produces</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">responses</strong> </td> <td class="code-arg-types"> <code><a href="#ResponsesDefinitionsObject">ResponsesDefinitionsObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>An object to hold responses that can be used across operations. This property does not define global responses for all operations.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">schemes</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">security</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">securityDefinitions</strong> </td> <td class="code-arg-types"> <code><a href="#SecurityDefinitionsObject">SecurityDefinitionsObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Security scheme definitions that can be used across the specification.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">swagger</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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".</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OpenApiSpec"></a> <strong class="code-arg-name">tags</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared may be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.</p> </p> <p></p> </div> </td> </tr> </table> </section> <section class="code-doc "> <a name="OperationObject"></a> <h3 class="code-ref">Interface: OperationObject</h3>  <div class="code-desc"> <p><p>Describes a single API operation on a path.</p> <p><p>Specification: <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operationObject">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operationObject</a></p> </p> <p></p> </div> </section> <section class="code-doc"> <a name="TODO"></a> <div class="code-arguments-hdr">Properties</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">consumes</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">deprecated</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">description</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">externalDocs</strong> </td> <td class="code-arg-types"> <code><a href="#ExternalDocumentationObject">ExternalDocumentationObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Additional external documentation for this operation.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">operationId</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">parameters</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the Swagger Object's parameters. There can be one "body" parameter at most.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">produces</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">responses</strong> </td> <td class="code-arg-types"> <code><a href="#ResponsesObject">ResponsesObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>The list of possible responses as they are returned from executing this operation.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">schemes</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">security</strong> </td> <td class="code-arg-types"> <code><a href="#SecurityRequirementObject">SecurityRequirementObject</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>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. To remove a top-level security declaration, an empty array can be used.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">summary</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">tags</strong> </td> <td class="code-arg-types"> <code><a href="#Array">Array</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <a name="OperationObject"></a> <strong class="code-arg-name">x-operation-name</stro