Skip to content

Commit

Permalink
Use Annotation property docblocks to document Attribute constructor p…
Browse files Browse the repository at this point in the history
…arameters
  • Loading branch information
DerManoMann committed Apr 6, 2023
1 parent 4a1d127 commit c2fc010
Show file tree
Hide file tree
Showing 4 changed files with 1,700 additions and 621 deletions.
24 changes: 13 additions & 11 deletions docs/reference/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ On top of this subset, there are extensions provided by this specification to al
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>example</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The key into `#/components/examples`.</p></dd>
Expand Down Expand Up @@ -312,7 +312,7 @@ A map between the scope name and a short description for it.</p></dd>
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>header</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>No details available.</p></dd>
Expand Down Expand Up @@ -468,7 +468,7 @@ accessing values in an operation and using them as parameters while invoking the
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>link</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The key into MediaType->links array.</p></dd>
Expand Down Expand Up @@ -608,7 +608,7 @@ A unique parameter is defined by a combination of a name and location.
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>parameter</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd>
Expand Down Expand Up @@ -738,12 +738,14 @@ The path itself is still exposed to the documentation viewer, but they will not
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>path</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>Key for the Path Object (OpenApi->paths array).</p></dd>
<dt><strong>summary</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>An optional, string summary, intended to apply to all operations in this path.</p></dd>
<dt><strong>description</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>An optional, string description, intended to apply to all operations in this path.</p></dd>
<dt><strong>path</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>Key for the Path Object (OpenApi->paths array).</p></dd>
</dl>

#### Reference
Expand Down Expand Up @@ -862,7 +864,7 @@ Describes a single request body.
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>request</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>Request body model name.</p></dd>
Expand Down Expand Up @@ -899,7 +901,7 @@ static links to operations based on the response.
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>response</strong> : <span style="font-family: monospace;">string|int</span></dt>
<dd><p>The key into Operations->responses array.<br />
Expand Down Expand Up @@ -935,7 +937,7 @@ On top of this subset, there are extensions provided by this specification to al
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>schema</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The key into Components->schemas array.</p></dd>
Expand Down Expand Up @@ -1069,7 +1071,7 @@ defined by this property's value.</p></dd>
#### Properties
---
<dl>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|object</span></dt>
<dt><strong>ref</strong> : <span style="font-family: monospace;">string|class-string|object</span></dt>
<dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>securityScheme</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The key into OpenApi->security array.</p></dd>
Expand Down
Loading

0 comments on commit c2fc010

Please sign in to comment.