Skip to content
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

Update API Design Guidelines on usage and style of operation tags #152

Merged
merged 1 commit into from
Mar 26, 2024
Merged

Update API Design Guidelines on usage and style of operation tags #152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions documentation/API-design-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1034,7 +1034,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 @@ -1046,7 +1047,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