@loopback/docs
Version:
Documentation for LoopBack 4
1,976 lines (1,384 loc) • 76.3 kB
HTML
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<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="#ContentObject">Interface: ContentObject</a>
</li>
<li class="depth-3">
<a href="#DiscriminatorObject">Interface: DiscriminatorObject</a>
</li>
<li class="depth-3">
<a href="#EncodingObject">Interface: EncodingObject</a>
</li>
<li class="depth-3">
<a href="#EncodingPropertyObject">Interface: EncodingPropertyObject</a>
</li>
<li class="depth-3">
<a href="#ExampleObject">Interface: ExampleObject</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="#ISpecificationExtension">Interface: ISpecificationExtension</a>
</li>
<li class="depth-3">
<a href="#MapObject">Interface: MapObject</a>
</li>
<li class="depth-3">
<a href="#MediaTypeObject">Interface: MediaTypeObject</a>
</li>
<li class="depth-3">
<a href="#OAS3SchemaObject">Interface: OAS3SchemaObject</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="#PathsObject">Interface: PathsObject</a>
</li>
<li class="depth-3">
<a href="#ReferenceObject">Interface: ReferenceObject</a>
</li>
<li class="depth-3">
<a href="#RequestBodyObject">Interface: RequestBodyObject</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="#SchemasObject">Interface: SchemasObject</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="#XMLObject">Interface: XMLObject</a>
</li>
<li class="depth-3">
<a href="#ExtensionValue">Type alias: ExtensionValue</a>
</li>
<li class="depth-3">
<a href="#JSONType">Type alias: JSONType</a>
</li>
<li class="depth-3">
<a href="#OpenApiSpec">Type alias: OpenApiSpec</a>
</li>
<li class="depth-3">
<a href="#ParameterLocation">Type alias: ParameterLocation</a>
</li>
<li class="depth-3">
<a href="#ParameterStyle">Type alias: ParameterStyle</a>
</li>
<li class="depth-3">
<a href="#254">Function: createEmptyApiSpec</a>
</li>
<li class="depth-3">
<a href="#260">Function: isReferenceObject</a>
</li>
<li class="depth-3">
<a href="#257">Function: isSchemaObject</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="ContentObject"></a>
<h3 class="code-ref">Interface: ContentObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an object of multiple content types.
For example:</p>
<pre><code class="lang-js">{
<span class="hljs-string">'application/json'</span>: {
<span class="hljs-attr">schema</span>: {...schemaObjectSpec}
},
<span class="hljs-string">'application/text'</span>: {
<span class="hljs-attr">schema</span>: {...schemaObjectSpec}
}
}
</code></pre>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="DiscriminatorObject"></a>
<h3 class="code-ref">Interface: DiscriminatorObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a discriminator object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<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=""></a>
<strong class="code-arg-name">mapping</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a discriminator object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">propertyName</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a discriminator object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="EncodingObject"></a>
<h3 class="code-ref">Interface: EncodingObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an encoding object, used in ParameterObject</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="EncodingPropertyObject"></a>
<h3 class="code-ref">Interface: EncodingPropertyObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an encoding object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<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=""></a>
<strong class="code-arg-name">allowReserved</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an encoding object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">contentType</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an encoding object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">explode</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an encoding object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">headers</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an encoding object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">style</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an encoding object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="ExampleObject"></a>
<h3 class="code-ref">Interface: ExampleObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an example object, used in <code>ParameterObject</code></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<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=""></a>
<strong class="code-arg-name">description</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an example object, used in <code>ParameterObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">externalValue</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an example object, used in <code>ParameterObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">summary</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an example object, used in <code>ParameterObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">value</strong>
</td>
<td class="code-arg-types">
<code><a href="#ExtensionValue">ExtensionValue</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an example object, used in <code>ParameterObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="ExternalDocumentationObject"></a>
<h3 class="code-ref">Interface: ExternalDocumentationObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an external document object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<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=""></a>
<strong class="code-arg-name">description</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an external document object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">url</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes an external document object, used in <code>SchemaObject</code></p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="HeaderObject"></a>
<h3 class="code-ref">Interface: HeaderObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a header object, used in <code>EncodingPropertyObject</code></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="HeadersObject"></a>
<h3 class="code-ref">Interface: HeadersObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<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="ISpecificationExtension"></a>
<h3 class="code-ref">Interface: ISpecificationExtension</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Allow key(string) value extension specifications.
These value extensions cannot be used as constraints, but can be filtered for retrieval.</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="MapObject"></a>
<h3 class="code-ref">Interface: MapObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<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="MediaTypeObject"></a>
<h3 class="code-ref">Interface: MediaTypeObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Each Media Type Object provides schema and examples for the media type
identified by its key.
Specification:
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object</a></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<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=""></a>
<strong class="code-arg-name">encoding</strong>
</td>
<td class="code-arg-types">
<code><a href="#EncodingObject">EncodingObject</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Each Media Type Object provides schema and examples for the media type
identified by its key.
Specification:
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">example</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Each Media Type Object provides schema and examples for the media type
identified by its key.
Specification:
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">examples</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Each Media Type Object provides schema and examples for the media type
identified by its key.
Specification:
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">schema</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Each Media Type Object provides schema and examples for the media type
identified by its key.
Specification:
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="OAS3SchemaObject"></a>
<h3 class="code-ref">Interface: OAS3SchemaObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<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=""></a>
<strong class="code-arg-name">additionalProperties</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">allOf</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">anyOf</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">default</strong>
</td>
<td class="code-arg-types">
<code><a href="#ExtensionValue">ExtensionValue</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">deprecated</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">description</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">discriminator</strong>
</td>
<td class="code-arg-types">
<code><a href="#DiscriminatorObject">DiscriminatorObject</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">example</strong>
</td>
<td class="code-arg-types">
<code><a href="#ExtensionValue">ExtensionValue</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">examples</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></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">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">format</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">items</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">not</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">nullable</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">oneOf</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">properties</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">readOnly</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">type</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">writeOnly</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">xml</strong>
</td>
<td class="code-arg-types">
<code><a href="#XMLObject">XMLObject</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Part of OpenAPI Schema Object, The following properties are taken from the
JSON Schema definition but their definitions were adjusted to the OpenAPI
Specification.</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="ParameterObject"></a>
<h3 class="code-ref">Interface: ParameterObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Specification
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object</a></p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<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=""></a>
<strong class="code-arg-name">allowEmptyValue</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Specification
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">allowReserved</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Specification
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">content</strong>
</td>
<td class="code-arg-types">
<code><a href="#ContentObject">ContentObject</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Specification
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">deprecated</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Specification
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">description</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Specification
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">example</strong>
</td>
<td class="code-arg-types">
<code><a href="#ExtensionValue">ExtensionValue</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location.
Specification
<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object">https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object</a></p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">examples</strong>
</td>
<td class="code-arg-types">
<code></code>
</td>
<td class="code-arg-desc">
<!--
Used for d