Skip to content

Commit

Permalink
Merge pull request #152 from rartych/tags-guidelines
Browse files Browse the repository at this point in the history
Update API Design Guidelines on usage and style of operation tags
  • Loading branch information
rartych authored Mar 26, 2024
2 parents 31c311c + 61a30d1 commit 5354bce
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions documentation/API-design-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -1054,7 +1054,8 @@ This part must include the following information:
- Schemes supported (HTTP, HTTPS…)
- Allowed response formats (“application/json”, “text/xml”…)
- Response format (“application/jwt”…)
- Global `tags` object if tags are used for API operations
<p align="center">
<img src="./images/guidelines-fig-14.png" width="400"/>
</p>
Expand All @@ -1066,7 +1067,7 @@ This part must contain the list of published functions, with the following descr
- HTTP Methods. For each one, the following shall be included:
- Functionality summary.
- Functionality method description.
- Tag list to classify methods.
- Optionally `tags` object for each API operation - Title Case is the recommended style for tag names.
- Request param list, making reference to "Request params" part.
- Supported responses list, describing success and errors cases.
Expand Down

0 comments on commit 5354bce

Please sign in to comment.