flask-restx icon indicating copy to clipboard operation
flask-restx copied to clipboard

Swagger UI: add using the "tag" functionality to group resources

Open SlimBeji opened this issue 4 years ago • 9 comments

Is your feature request related to a problem? Please describe. I am using flask-restx and I have a lot of Resources per namespace. I would like to be able to tag myself the resources and regroup them by my liking. This way I would be able to split Resources to several groups.

Describe the solution you'd like After some googling, I discovered this Swagger functionality: https://swagger.io/docs/specification/grouping-operations-with-tags/. Is it possible to add something like: @namespace.doc(tags=['category1', 'category2'])

In the documentation https://flask-restx.readthedocs.io/en/latest/swagger.html, it is specified Each operation will automatically receive the namespace tag. If the resource is attached to the root API, it will receive the default namespace tag. I want to be able to customize this behaviour by just adding a tag.

Describe alternatives you've considered I considered splitting my namespace into several namespaces but this solution does not suit me

SlimBeji avatar Aug 26 '20 11:08 SlimBeji

Any update on the issue?

Abdur-rahmaanJ avatar Mar 01 '22 12:03 Abdur-rahmaanJ

Following this thread

Issue : To group flast restx swagger api by adding a tag decorator to resources.

nicksonthc avatar Sep 27 '22 07:09 nicksonthc

This would be super helpful.

brian-ketos avatar May 22 '23 17:05 brian-ketos

Any Update about this?

Zaker237 avatar Nov 08 '23 23:11 Zaker237

Seems as if there is still no update

martin-thoma avatar Jan 26 '24 13:01 martin-thoma

This would be really helpful feature because currently the endpoints are grouped by namespace but if a namespace have many endpoints, the endpoints docs looks messy. Having control over the endpoint level grouping will make endpoints docs very clean.

kartikeyporwal avatar Feb 08 '24 16:02 kartikeyporwal

Please can we get this feature it's crucial for any form of production documentation @nicksonthc

GoldenWind8 avatar Apr 13 '24 07:04 GoldenWind8

I could really use this feature right now

brian-ketos avatar Apr 13 '24 17:04 brian-ketos