Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Conversation

jlalmes
Copy link
Contributor

@jlalmes jlalmes commented Jun 8, 2022

Endpoint tag ordering

Enables you to supply the generateOpenApiDocument function with tags: string[] so that endpoint tag groups will be ordered from first-to-last.

Example

const openApiDocument = generateOpenApiDocument(appRouter, {
  title: 'Example REST API',
  version: '1.0.0',
  baseUrl: 'http://localhost:3001/api',
+  tags: ['auth', 'users', 'posts'],
});

Breaking change

Change to OpenApiMeta.

.query('getUser', {
-  meta: { ..., tags: ['users'] },
+  meta: { ..., tag: 'users' },
  ...
})

@jlalmes jlalmes merged commit 7051c5c into v0.1.0 Jun 8, 2022
@jlalmes jlalmes deleted the feat/order-tags branch August 25, 2022 12:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant