Skip to content

Update rm-options.md #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crandmck merged 2 commits into from
Oct 26, 2017
Merged

Update rm-options.md #500

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
753d1c8
Update rm-options.md
STRML Oct 26, 2017
34bbc78
Note OpenAPI/Swagger
STRML Oct 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions _includes/content/rm-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ accepts: [
<tr>
<td>description</td>
<td>
Text description of the method, used by API documentation generators such as Swagger.
Text description of the method, used by API documentation generators such as OpenAPI (formerly Swagger).
You can put long strings in an array if needed (see note below).
</td>
<td> </td>
Expand All @@ -62,11 +62,18 @@ accepts: [
<tr>
<td>notes</td>
<td>
Additional notes, used by API documentation generators like Swagger.
Additional notes, used by OpenAPI (formerly Swagger).
You can put long strings in an array if needed (see note below).
</td>
<td> </td>
</tr>
<tr>
<td>documented</td>
<td>
If set to <code>false</code>, this method will not be present in generated OpenAPI (formerly Swagger) documentation.
</td>
<td> </td>
</tr>
<tr>
<td>returns</td>
<td>
Expand Down Expand Up @@ -173,7 +180,7 @@ The following table describes the properties of each individual argument.
<td>description</td>
<td>String or Array</td>
<td>
A text description of the argument. This is used by API documentation generators like Swagger.
A text description of the argument. This is used by API documentation generators like OpenAPI (formerly Swagger).
You can put long strings in an array if needed (see note above).
</td>
</tr>
Expand Down Expand Up @@ -218,6 +225,11 @@ The following table describes the properties of each individual argument.
<strong>Note</strong>: This value will not be passed into remote methods function if argument is not present.
</td>
</tr>
<tr>
<td>documented</td>
<td>Boolean</td>
<td>If set to <code>false</code>, this parameter will not be present in generated OpenAPI (formerly Swagger) documentation.</td>
</tr>
</tbody>
</table>

Expand Down