@mintlify/cli 4.0.1729 → 4.0.1731
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/openApiCheck.js +16 -7
- package/bin/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +10 -10
- package/src/openApiCheck.tsx +28 -9
package/bin/openApiCheck.js
CHANGED
|
@@ -53,17 +53,23 @@ export const buildOverlayRegistryForCheck = (localSchema) => __awaiter(void 0, v
|
|
|
53
53
|
loadLocalDocument: (normalizedPath) => readLocalOpenApiFile(normalizedPath),
|
|
54
54
|
});
|
|
55
55
|
});
|
|
56
|
-
|
|
56
|
+
const logOpenApiMessage = ({ level, message }) => {
|
|
57
|
+
addLog(level === 'success' ? (_jsx(SuccessLog, { message: message })) : level === 'warning' ? (_jsx(WarningLog, { message: message })) : (_jsx(ErrorLog, { message: message })));
|
|
58
|
+
};
|
|
59
|
+
export const checkOpenApiFile = (filename_1, localSchema_1, overlayRegistry_1, ...args_1) => __awaiter(void 0, [filename_1, localSchema_1, overlayRegistry_1, ...args_1], void 0, function* (filename, localSchema, overlayRegistry, report = logOpenApiMessage) {
|
|
57
60
|
try {
|
|
58
61
|
const overlays = overlayRegistry ? yield resolveOverlaysForSpec(overlayRegistry, filename) : [];
|
|
59
62
|
if (isAllowedLocalSchemaUrl(filename, localSchema)) {
|
|
60
63
|
yield getOpenApiDocumentFromUrl(filename, { overlays });
|
|
61
|
-
|
|
64
|
+
report({ level: 'success', message: 'OpenAPI definition is valid.' });
|
|
62
65
|
return true;
|
|
63
66
|
}
|
|
64
67
|
if (filename.startsWith('http://') && !localSchema) {
|
|
65
|
-
|
|
66
|
-
|
|
68
|
+
report({
|
|
69
|
+
level: 'warning',
|
|
70
|
+
message: 'include the --local-schema flag to check locally hosted OpenAPI files',
|
|
71
|
+
});
|
|
72
|
+
report({ level: 'warning', message: 'only https protocol is supported in production' });
|
|
67
73
|
return true;
|
|
68
74
|
}
|
|
69
75
|
const document = yield readLocalOpenApiFile(filename);
|
|
@@ -75,15 +81,18 @@ export const checkOpenApiFile = (filename, localSchema, overlayRegistry) => __aw
|
|
|
75
81
|
throw new Error('applying overlays produced an invalid OpenAPI document.');
|
|
76
82
|
}
|
|
77
83
|
yield validate(overlaid);
|
|
78
|
-
|
|
84
|
+
report({ level: 'success', message: 'OpenAPI definition is valid.' });
|
|
79
85
|
return true;
|
|
80
86
|
}
|
|
81
87
|
catch (err) {
|
|
82
88
|
if (err && typeof err === 'object' && 'code' in err && err.code === 'ENOENT') {
|
|
83
|
-
|
|
89
|
+
report({
|
|
90
|
+
level: 'error',
|
|
91
|
+
message: `file not found, please check the path provided: ${filename}`,
|
|
92
|
+
});
|
|
84
93
|
}
|
|
85
94
|
else {
|
|
86
|
-
|
|
95
|
+
report({ level: 'error', message: err instanceof Error ? err.message : 'unknown error' });
|
|
87
96
|
}
|
|
88
97
|
return false;
|
|
89
98
|
}
|