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.

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

Guidelines for operation tags #80

Closed
rartych opened this issue Oct 27, 2023 · 1 comment · Fixed by #152
Closed

Guidelines for operation tags #80

rartych opened this issue Oct 27, 2023 · 1 comment · Fixed by #152
Labels
documentation Improvements or additions to documentation

Comments

@rartych
Copy link
Collaborator

rartych commented Oct 27, 2023

Problem description
Current API DG says that for each HTTP method (i.e operation) definition should include:

Tag list to classify methods.

Expected action
More detailed guidelines on usage and style of operation tags:

  • Definition of tags in a top-level tags element
  • Adding a tag to each operation

Additional context

tags element is not required by OAS:

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#fixed-fields

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.

The need for guidelines was indicated in the discussion in camaraproject/QualityOnDemand#227

Explanation of tags in blog post.

@rartych rartych added the documentation Improvements or additions to documentation label Oct 27, 2023
@eric-murray
Copy link
Collaborator

My view is that tags should be optional for a given API, but if they are used then they should follow a common style.

My preference for the tag style is Title Case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants