Skip to content

Introduce tags hierarchy #1507

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

Closed
dtsaryov opened this issue Mar 12, 2018 · 12 comments
Closed

Introduce tags hierarchy #1507

dtsaryov opened this issue Mar 12, 2018 · 12 comments

Comments

@dtsaryov
Copy link

dtsaryov commented Mar 12, 2018

Hello.

My proposal is to add an ability to create tags hierarchy, for example:

tags:
  - name: Entites
    description: CRUD entities operations
      - User
      - Group
  - name: Services
    description: Predefined queries execution
      - FooService:
        - name: ...
          description: ...
      - BarService:
        - name: ...
          description:

It'll help to group operations in case of generic REST API.

@MikeRalphson
Copy link
Member

See also #1367

@ymohdriz
Copy link

Hi @prozac631,

If I understood correctly, open api provides a way to tag in operation level. Hope we can group operations by using operation level tagging.
Let me know if your requirement is completely different.

Thanks,
Mohammed

@dtsaryov
Copy link
Author

dtsaryov commented Mar 16, 2018

Hi @ymohdriz

Yes, we can use grouping for operations, but it would be nice if we could group operations inside of group of operations. Let me make it more clear.

For example, you have operations and their paths have the following template: /entities/* (entities/User, entities/Group, etc).

And in the same time you have a set operations that can be performed with these entities, for example: entities/User/create, entities/User/get, entities/User/delete, etc.

And in this case we can create a tag Entities and sub tags User, Group, etc.

@maaland
Copy link

maaland commented Jul 30, 2018

I support the request for sub-tags. I want to be able to group (or at least sort) the methods under each of my endpoints, and as far as I can tell, that's not possible right now.

@silkentrance
Copy link

silkentrance commented Aug 3, 2018

See also #1642. The path is already a physical group, why do you need an indirection for it? And as far as I understand it, you can add multiple tags to a given operation.

@jukeblimp32
Copy link

jukeblimp32 commented Sep 18, 2018

I really need subtags. My current tags are getting far too cluttered.

@ShangyanLi
Copy link

@jukeblimp32 not sure if this is helpful but have you looked into the x-tagGroups option in ReDoc vendor extensions?

@farmbotgianpaolo
Copy link

I support the request for sub-tags or tag hyerarchy. The reason is simple: if I have a single endpoint where I built public and private APIs I would like to group them into these 2 categories.

@storm367
Copy link

Tag Hierarchy doesn't seem to be supported yet? I support this request to add sub-tags.

@dschmide
Copy link

dschmide commented Feb 6, 2020

Adding sub-tags is ab obvious advantage. Remember, there is no search and filter option for the apidocs, so this tagging system is all we can provide to devs.
At this point, my co-workers are telling me to add subgroups, and not believing me when I tell them that "its not possible", but sadly, this is a reality.
I started embedding "tags" right in the paths so the structure within tags is at least somewhat preserved by abusing the alphabetical ordering - but this is clearly a symptom of a lack of feature.

@kael-shipman
Copy link

I support this, and furthermore support closing this issue as a duplicate of #1367 so that we can keep the conversation in one place. Adding my comments over there.

@handrews
Copy link
Member

Closing as recommended as a duplicate of #1367 - please continue the conversation there!

@handrews handrews removed the review label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests