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.

Sign up for GitHub

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 3 commits into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b1dd3c
feat: implement rudimentary support for `x-tagGroups`
Alex4386 Mar 28, 2025
828b64e
Merge branch 'main' into feature/add-x-tagGroups
Alex4386 May 12, 2025
62875de
Merge branch 'elysiajs:main' into feature/add-x-tagGroups
Alex4386 Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { OpenAPIV3 } from 'openapi-types'
import type { ReferenceConfiguration } from '@scalar/types'
import type { ReferenceConfiguration, TagGroup } from '@scalar/types'
import type { SwaggerUIOptions } from './swagger/types'

export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
Expand All @@ -8,11 +8,7 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
*
* @see https://swagger.io/specification/v2/
*/
documentation?: Omit<
Partial<OpenAPIV3.Document>,
| 'x-express-openapi-additional-middleware'
| 'x-express-openapi-validation-strict'
>
documentation?: ElysiaSwaggerDocumentation;
/**
* Choose your provider, Scalar or Swagger UI
*
Expand Down Expand Up @@ -125,3 +121,15 @@ export interface ElysiaSwaggerConfig<Path extends string = '/swagger'> {
*/
excludeTags?: string[]
}

interface ElysiaSwaggerDocumentation extends Omit<
Partial<OpenAPIV3.Document>,
| 'x-express-openapi-additional-middleware'
| 'x-express-openapi-validation-strict'
> {
/**
* Group tags in Scalar UI using `x-tagGroups` property
*/
'x-tagGroups'?: TagGroup[]
}