Skip to content

OpenAPI v3.2 Hierarhical tags #3607

@apt-bh

Description

@apt-bh

Is there an existing issue that is already proposing this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe it

When using tags, without using external plugins, we only have one level of tags. To better order our documentation, we would like to have nesting tags capabilities.

Describe the solution you'd like

Since OpenApi v3.2, that capability is now available, using the parent and kind keywords.
Having that capability in the decorator @ApiTags would be very much appreciated.

What I don't know is if that project aims to follow v3.2 or if it's a bit too early for that, especially on the rendering side.

Teachability, documentation, adoption, migration strategy

We could allow both string or object specification

The current string

@ApiTags('Cats')

Would optionnaly now become an object like this

@ApiTags({name: 'Cats', parent: 'Animals'})

What is the motivation / use case for changing the behavior?

We have a growing api in which in become increasingly difficult to use just one level of classification for our entities. The business logic would be better represented with a hierarchical structure.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions