Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-01-27 21:39:16 -05:00
Code Issues Activity

chore(core): do not throw error for api doc integrity on prod

Browse source
This commit is contained in:
Gao Sun 2023-12-03 19:52:37 +08:00
parent b05fb2960d
commit 2b28fd7d75
No known key found for this signature in database
GPG key ID: 13EBE123E4773688
2 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/core/src/routes/swagger/index.ts
View file

@ -228,7 +228,9 @@ export default function swaggerRoutes<T extends AnonymousRouter, R extends Route
if (EnvSet.values.isUnitTest) {
consoleLog.warn('Skip validating swagger document in unit test.');
} else {
}
// Don't throw for integrity check in production as it has no benefit.
else if (!EnvSet.values.isProduction || EnvSet.values.isIntegrationTest) {
for (const document of supplementDocuments) {
validateSupplement(baseDocument, document);
}

8
packages/core/src/routes/swagger/utils/general.ts
View file

@ -6,7 +6,6 @@ import { isKeyInObject, type Optional } from '@silverhand/essentials';
import { OpenAPIV3 } from 'openapi-types';
import { z } from 'zod';
import { EnvSet } from '#src/env-set/index.js';
import { consoleLog } from '#src/utils/console.js';
const capitalize = (value: string) => value.charAt(0).toUpperCase() + value.slice(1);
@ -156,11 +155,16 @@ export const validateSupplement = (
*/
export const validateSwaggerDocument = (document: OpenAPIV3.Document) => {
for (const [path, operations] of Object.entries(document.paths)) {
if (!EnvSet.values.isProduction && path.startsWith('/api/interaction')) {
if (path.startsWith('/api/interaction')) {
consoleLog.warn(`Path \`${path}\` is not documented. Do something!`);
continue;
}
// This path is for admin tenant only, skip it.
if (path === '/api/.well-known/endpoints/{tenantId}') {
continue;
}
if (!operations) {
continue;
}