Add tags to Swagger OpenAPI schemas

[phuongtai]

Description

My solution is find the first element of a specific path that proper with tags
Example:
PUT, PATCH, PUT, DELETE: /task/{id} -> tags=[task]
POST, GET: /task -> tags=[task]

Please read more at this issue #7103

[carltongibson]

Hi @phuongtai. This looks like a nice improvement.

Can you rebase on master and add a test case asserting that the tags are generated correctly?

[dhaval-mehta]

@phuongtai @carltongibson This will not work for nested resources.

Let's assume a restaurant management system. We have restaurants. Each restaurant has branches and each branch has inspections. To retrieve single inspection for a branch, following might be a URL:

/restaurants/{restaurant_id}/branches/{branch_id}/inspections/{inspection_id}

Ideally, tags for this path will be inspections but your code will generate restaurants

Realtime Example: Retrieve billing information for a sub-account by zoom.us
In case, the path is /accounts/{accountId}/billing and schema tag is billing not accounts

[phuongtai]

I understood your problem, I've just resolved the problem which is putting all of APIs by tags default. I removed it and get default tags is a top level of each APIs. So we have to find the better solutions which may be automatically or manually generated.

[dhaval-mehta]

My Idea is to extract the tags from the view-set. Spring Framework is doing the same.
@phuongtai Are you working on it? We also need this feature.

[bergran]

Hello to everyone! I was looking for this feature either. We can try next:

• Take from basename as reverse URL from Django function, basename is a required param on router register method.
• From path Django function I'm not sure about this, but if we could take param name it would be nice!
• other ways to register endpoints we can set default we discover other cases

** Edit:
can we maybe use docstrings to set it maybe

What do you think?

[phuongtai]

Hello to everyone! I was looking for this feature either. We can try next:

• Take from basename as reverse URL from Django function, basename is a required param on router register method.
• From path Django function I'm not sure about this, but if we could take param name it would be nice!
• other ways to register endpoints we can set default we discover other cases

** Edit:
can we maybe use docstrings to set it maybe

What do you think?

Thanks for your solution. That sound good but are you sure about working fine with ViewSet?

[carltongibson]

This is a good start but isn't quite right.

I've added an outline of how I think it should go on the issue: #7103 (comment)