Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Feature: sub-tags grouping #1367
I don't know it is good place to introduce new Feature into swagger specification - if not please give me information where i can put this proposition.
My proposition is to use following convention in tags names (using dots to nesting subtags):
And in output generated documentation web-page we will get:
This feature is especially practical for large APIs.
Or may be better way is not change 'tags' but rather add new filed 'groups' which will contain such dot-separated nested groups?
This was referenced
Mar 15, 2018
I support the request for sub-tags. Right now my tags are my collections. But with some collections exposing several different resources that can each support GET, PUT, and PATCH, the tags can become very cluttered. I want to be able have sub-tags for each resource within the collection tag.
This is one area where apib is better... there is a hierarchy like "Resource Group > Resource > Transition" where a Transition is roughly an OAS
For large APIs it would be useful to be able to group the endpoints at a level above single tags.
OAS is flexible enough I can represent this in the data with some combination of tags and extension properties, but for it to really be useful you would want a standardised representation that the tools such as Swagger UI then also support.
I have a very large API to document, large with a very basic structure: