Skip to content

Commit

Permalink
Update reference for new parameter sub-types (#1384)
Browse files Browse the repository at this point in the history
  • Loading branch information
@DerManoMann
DerManoMann authored Jan 5, 2023
1 parent 971812f commit af672d3
Show file tree
Hide file tree
Showing 2 changed files with 222 additions and 0 deletions.
57 changes: 57 additions & 0 deletions docs/reference/annotations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,25 @@ Contact information for the exposed API.
---
- [OAI Contact Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object)

## [CookieParameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/CookieParameter.php)

A `@OA\Request` cookie parameter.

#### Allowed in
---
<a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>

#### Nested elements
---
<a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

#### Properties
---
<dl>
<dt><strong>in</strong></dt>
<dd><p>No details available.</p></dd>
</dl>

## [Delete](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Delete.php)


Expand Down Expand Up @@ -320,6 +339,25 @@ If style is used, and if behavior is n/a (cannot be serialized), the value of al
---
- [OAI Header Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject).

## [HeaderParameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/HeaderParameter.php)

A `@OA\Request` header parameter.

#### Allowed in
---
<a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>

#### Nested elements
---
<a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

#### Properties
---
<dl>
<dt><strong>in</strong></dt>
<dd><p>No details available.</p></dd>
</dl>

## [Info](https://github.com/zircote/swagger-php/tree/master/src/Annotations/Info.php)

The object provides metadata about the API.
Expand Down Expand Up @@ -790,6 +828,25 @@ A `@OA\Request` path parameter.
<dd><p>No details available.</p></dd>
</dl>

## [QueryParameter](https://github.com/zircote/swagger-php/tree/master/src/Annotations/QueryParameter.php)

A `@OA\Request` query parameter.

#### Allowed in
---
<a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>

#### Nested elements
---
<a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

#### Properties
---
<dl>
<dt><strong>in</strong></dt>
<dd><p>No details available.</p></dd>
</dl>

## [RequestBody](https://github.com/zircote/swagger-php/tree/master/src/Annotations/RequestBody.php)

Describes a single request body.
Expand Down
165 changes: 165 additions & 0 deletions docs/reference/attributes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,61 @@ In addition to this page, there are also a number of [examples](https://github.c
<dd><p>No details available.</p></dd>
</dl>

## [CookieParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/CookieParameter.php)



#### Allowed in
---
<a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>

#### Nested elements
---
<a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
<dt><strong>parameter</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>name</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>in</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>required</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>allowEmptyValue</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>ref</strong> : <span style="font-family: monospace;">object|string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>schema</strong> : <span style="font-family: monospace;">OpenApi\Attributes\Schema|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>example</strong> : <span style="font-family: monospace;">mixed|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>examples</strong> : <span style="font-family: monospace;">array&lt;string,Examples&gt;</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>content</strong> : <span style="font-family: monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>style</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>explode</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>allowReserved</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>spaceDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>pipeDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>x</strong> : <span style="font-family: monospace;">array&lt;string,mixed&gt;|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt>
<dd><p>No details available.</p></dd>
</dl>

## [Delete](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Delete.php)


Expand Down Expand Up @@ -468,6 +523,61 @@ In addition to this page, there are also a number of [examples](https://github.c
<dd><p>No details available.</p></dd>
</dl>

## [HeaderParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/HeaderParameter.php)



#### Allowed in
---
<a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>

#### Nested elements
---
<a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
<dt><strong>parameter</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>name</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>in</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>required</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>allowEmptyValue</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>ref</strong> : <span style="font-family: monospace;">object|string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>schema</strong> : <span style="font-family: monospace;">OpenApi\Attributes\Schema|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>example</strong> : <span style="font-family: monospace;">mixed|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>examples</strong> : <span style="font-family: monospace;">array&lt;string,Examples&gt;</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>content</strong> : <span style="font-family: monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>style</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>explode</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>allowReserved</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>spaceDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>pipeDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>x</strong> : <span style="font-family: monospace;">array&lt;string,mixed&gt;|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt>
<dd><p>No details available.</p></dd>
</dl>

## [Info](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Info.php)


Expand Down Expand Up @@ -1235,6 +1345,61 @@ In addition to this page, there are also a number of [examples](https://github.c
<dd><p>No details available.</p></dd>
</dl>

## [QueryParameter](https://github.com/zircote/swagger-php/tree/master/src/Attributes/QueryParameter.php)



#### Allowed in
---
<a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>

#### Nested elements
---
<a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a>

#### Parameters
---
<dl>
<dt><strong>parameter</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>name</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>description</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>in</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>required</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>allowEmptyValue</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>ref</strong> : <span style="font-family: monospace;">object|string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>schema</strong> : <span style="font-family: monospace;">OpenApi\Attributes\Schema|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>example</strong> : <span style="font-family: monospace;">mixed|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>examples</strong> : <span style="font-family: monospace;">array&lt;string,Examples&gt;</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>content</strong> : <span style="font-family: monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>style</strong> : <span style="font-family: monospace;">string|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>explode</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>allowReserved</strong> : <span style="font-family: monospace;">bool|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>spaceDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>pipeDelimited</strong> : <span style="font-family: monospace;">array|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>x</strong> : <span style="font-family: monospace;">array&lt;string,mixed&gt;|null</span></dt>
<dd><p>No details available.</p></dd>
<dt><strong>attachables</strong> : <span style="font-family: monospace;">Attachable[]|null</span></dt>
<dd><p>No details available.</p></dd>
</dl>

## [RequestBody](https://github.com/zircote/swagger-php/tree/master/src/Attributes/RequestBody.php)


Expand Down

0 comments on commit af672d3

Please sign in to comment.