-
Notifications
You must be signed in to change notification settings - Fork 32
Guidelines for operation tags #80
Copy link
Copy link
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
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
tagselement - Adding a tag to each operation
Additional context
tags element is not required by OAS:
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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation