Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-03-31 22:51:25 -05:00
Code Issues Activity

fix(core): do not titlize tags of .well-known APIs (#1412)

Browse source
This commit is contained in:
IceHe.xyz 2022-07-05 12:33:47 +08:00 • committed by GitHub
parent 6a83732185
commit 5559fb10c3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
packages/core/src/routes/swagger.test.ts
View file

@ -68,15 +68,20 @@ describe('GET /swagger.json', () => {
});
it('should generate the tags', async () => {
const response = await mockSwaggerRequest.get('/swagger.json');
const testTagRouter = new Router();
testTagRouter.get('/mock', () => ({}));
testTagRouter.put('/.well-known', () => ({}));
const swaggerRequest = createSwaggerRequest([testTagRouter]);
const response = await swaggerRequest.get('/swagger.json');
expect(response.body.paths).toMatchObject(
expect.objectContaining({
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
'/api/mock': expect.objectContaining({
get: expect.objectContaining({ tags: ['Mock'] }),
}),
'/api/test': expect.objectContaining({
put: expect.objectContaining({ tags: ['Test'] }),
'/api/.well-known': expect.objectContaining({
put: expect.objectContaining({ tags: ['.well-known'] }),
}),
/* eslint-enable @typescript-eslint/no-unsafe-assignment */
})

12
packages/core/src/routes/swagger.ts
View file

@ -62,6 +62,16 @@ const buildParameters = (
}));
};
function buildTag(path: string) {
const root = path.split('/')[1];
if (root?.startsWith('.')) {
return root;
}
return toTitle(root ?? 'General');
}
const buildOperation = (stack: IMiddleware[], path: string): OpenAPIV3.OperationObject => {
const guard = stack.find((function_): function_ is WithGuardConfig<IMiddleware> =>
isGuardMiddleware(function_)
@ -85,7 +95,7 @@ const buildOperation = (stack: IMiddleware[], path: string): OpenAPIV3.Operation
];
return {
tags: [toTitle(path.split('/')[1] ?? 'General')],
tags: [buildTag(path)],
parameters: [...pathParameters, ...queryParameters],
requestBody,
responses: {