Skip to content

Add support for x-tagGroups for Scalar Swagger Document generation #201

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Alex4386
Copy link

Abstract

This PR adds support for redoc's x-tagGroups (Ref), which is supported by Scalar (Reference)

Example

new Elysia()
  .use(swagger({
    path: '/docs',
    documentation: {
      tags: [
        {
           name: 'two-factor',
           description: 'Allow users to manage their 2FA config'
        }, {
           name: 'password',
           description: 'User actions for changing their own password'
        }
      ],
      'x-tagGroups': [
        {
          name: 'user',
          tags: ['two-factor', 'password']
        }
      ]
    }
  })

The example code will generate Scalar UI like the following:
image

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

Successfully merging this pull request may close these issues.

1 participant