@mintlify/scraping 4.0.230 → 4.0.232
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/__test__/getAsyncApiDefinition.test.ts +6 -9
- package/__test__/getOpenApiDefinition.test.ts +34 -9
- package/bin/asyncapi/generateAsyncApiPagesForDocsConfig.d.ts +1 -0
- package/bin/asyncapi/generateAsyncApiPagesForDocsConfig.js +1 -1
- package/bin/asyncapi/generateAsyncApiPagesForDocsConfig.js.map +1 -1
- package/bin/asyncapi/getAsyncApiDefinition.d.ts +1 -1
- package/bin/asyncapi/getAsyncApiDefinition.js +6 -6
- package/bin/asyncapi/getAsyncApiDefinition.js.map +1 -1
- package/bin/asyncapi/processAsyncApiChannel.js +1 -3
- package/bin/asyncapi/processAsyncApiChannel.js.map +1 -1
- package/bin/openapi/common.d.ts +2 -1
- package/bin/openapi/common.js +6 -6
- package/bin/openapi/common.js.map +1 -1
- package/bin/openapi/generateOpenApiPages.js +1 -1
- package/bin/openapi/generateOpenApiPages.js.map +1 -1
- package/bin/openapi/generateOpenApiPagesForDocsConfig.js +1 -1
- package/bin/openapi/generateOpenApiPagesForDocsConfig.js.map +1 -1
- package/bin/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +4 -4
- package/src/asyncapi/generateAsyncApiPagesForDocsConfig.ts +5 -2
- package/src/asyncapi/getAsyncApiDefinition.ts +15 -6
- package/src/asyncapi/processAsyncApiChannel.ts +1 -3
- package/src/openapi/common.ts +12 -5
- package/src/openapi/generateOpenApiPages.ts +1 -1
- package/src/openapi/generateOpenApiPagesForDocsConfig.ts +1 -1
|
@@ -5,6 +5,9 @@ import { describe, it, expect, beforeEach, vi } from 'vitest';
|
|
|
5
5
|
|
|
6
6
|
import { getAsyncApiDefinition } from '../src/asyncapi/getAsyncApiDefinition.js';
|
|
7
7
|
|
|
8
|
+
const httpsError =
|
|
9
|
+
'Only HTTPS URLs are supported. HTTP URLs are only supported with the cli option --local-schema.';
|
|
10
|
+
|
|
8
11
|
describe('getAsyncApiDefinition', () => {
|
|
9
12
|
beforeEach(() => {
|
|
10
13
|
vi.resetAllMocks();
|
|
@@ -54,23 +57,17 @@ describe('getAsyncApiDefinition', () => {
|
|
|
54
57
|
|
|
55
58
|
it('should throw error when HTTP URL is provided', async () => {
|
|
56
59
|
const httpUrl = new URL('http://example.com/asyncapi.yaml');
|
|
57
|
-
await expect(getAsyncApiDefinition(httpUrl)).rejects.toThrow(
|
|
58
|
-
'Only HTTPS URLs are supported. Please provide an HTTPS URL'
|
|
59
|
-
);
|
|
60
|
+
await expect(getAsyncApiDefinition(httpUrl)).rejects.toThrow(httpsError);
|
|
60
61
|
});
|
|
61
62
|
|
|
62
63
|
it('should throw error when HTTP URL string is provided', async () => {
|
|
63
64
|
const httpUrlString = 'http://example.com/asyncapi.yaml';
|
|
64
|
-
await expect(getAsyncApiDefinition(httpUrlString)).rejects.toThrow(
|
|
65
|
-
'Only HTTPS URLs are supported. Please provide an HTTPS URL'
|
|
66
|
-
);
|
|
65
|
+
await expect(getAsyncApiDefinition(httpUrlString)).rejects.toThrow(httpsError);
|
|
67
66
|
});
|
|
68
67
|
|
|
69
68
|
it('should throw error when non-HTTPS URL string is provided', async () => {
|
|
70
69
|
const httpUrlString = 'ftp://example.com/asyncapi.yaml';
|
|
71
|
-
await expect(getAsyncApiDefinition(httpUrlString)).rejects.toThrow(
|
|
72
|
-
'Only HTTPS URLs are supported. Please provide an HTTPS URL'
|
|
73
|
-
);
|
|
70
|
+
await expect(getAsyncApiDefinition(httpUrlString)).rejects.toThrow(httpsError);
|
|
74
71
|
});
|
|
75
72
|
|
|
76
73
|
it('should throw error when URL response is invalid', async () => {
|
|
@@ -17,6 +17,9 @@ const mockOpenApiDoc: OpenAPI.Document = {
|
|
|
17
17
|
paths: {},
|
|
18
18
|
};
|
|
19
19
|
|
|
20
|
+
const httpsError =
|
|
21
|
+
'Only HTTPS URLs are supported. HTTP URLs are only supported with the cli option --local-schema.';
|
|
22
|
+
|
|
20
23
|
describe('getOpenApiDefinition', () => {
|
|
21
24
|
beforeEach(() => {
|
|
22
25
|
vi.resetAllMocks();
|
|
@@ -105,23 +108,45 @@ describe('getOpenApiDefinition', () => {
|
|
|
105
108
|
|
|
106
109
|
it('should throw error when HTTP URL is provided', async () => {
|
|
107
110
|
const httpUrl = new URL('http://example.com/openapi.yaml');
|
|
108
|
-
await expect(getOpenApiDefinition(httpUrl)).rejects.toThrow(
|
|
109
|
-
|
|
110
|
-
|
|
111
|
+
await expect(getOpenApiDefinition(httpUrl)).rejects.toThrow(httpsError);
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
it('should allow HTTP URL when local schema is true', async () => {
|
|
115
|
+
const httpUrl = new URL('http://example.com/openapi.yaml');
|
|
116
|
+
const mockYaml = yaml.dump(mockOpenApiDoc);
|
|
117
|
+
global.fetch = vi.fn().mockResolvedValue({
|
|
118
|
+
ok: true,
|
|
119
|
+
status: 200,
|
|
120
|
+
text: () => Promise.resolve(mockYaml),
|
|
121
|
+
});
|
|
122
|
+
await expect(getOpenApiDefinition(httpUrl, true)).resolves.toEqual({
|
|
123
|
+
document: mockOpenApiDoc,
|
|
124
|
+
isUrl: true,
|
|
125
|
+
});
|
|
111
126
|
});
|
|
112
127
|
|
|
113
128
|
it('should throw error when HTTP URL string is provided', async () => {
|
|
114
129
|
const httpUrlString = 'http://example.com/openapi.yaml';
|
|
115
|
-
await expect(getOpenApiDefinition(httpUrlString)).rejects.toThrow(
|
|
116
|
-
|
|
117
|
-
|
|
130
|
+
await expect(getOpenApiDefinition(httpUrlString)).rejects.toThrow(httpsError);
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
it('should allow HTTP URL string when local schema is true', async () => {
|
|
134
|
+
const httpUrlString = 'http://example.com/openapi.yaml';
|
|
135
|
+
const mockYaml = yaml.dump(mockOpenApiDoc);
|
|
136
|
+
global.fetch = vi.fn().mockResolvedValue({
|
|
137
|
+
ok: true,
|
|
138
|
+
status: 200,
|
|
139
|
+
text: () => Promise.resolve(mockYaml),
|
|
140
|
+
});
|
|
141
|
+
await expect(getOpenApiDefinition(httpUrlString, true)).resolves.toEqual({
|
|
142
|
+
document: mockOpenApiDoc,
|
|
143
|
+
isUrl: true,
|
|
144
|
+
});
|
|
118
145
|
});
|
|
119
146
|
|
|
120
147
|
it('should throw error when non-HTTPS URL string is provided', async () => {
|
|
121
148
|
const httpUrlString = 'ftp://example.com/openapi.yaml';
|
|
122
|
-
await expect(getOpenApiDefinition(httpUrlString)).rejects.toThrow(
|
|
123
|
-
'Only HTTPS URLs are supported. Please provide an HTTPS URL'
|
|
124
|
-
);
|
|
149
|
+
await expect(getOpenApiDefinition(httpUrlString)).rejects.toThrow(httpsError);
|
|
125
150
|
});
|
|
126
151
|
|
|
127
152
|
it('should throw error when URL response is invalid YAML', async () => {
|
|
@@ -6,7 +6,7 @@ export async function generateAsyncApiPagesForDocsConfig(spec, opts) {
|
|
|
6
6
|
let document = undefined;
|
|
7
7
|
let isUrl;
|
|
8
8
|
if (typeof spec === 'string' || spec instanceof URL) {
|
|
9
|
-
const { document: asyncApiDocument, isUrl: isUrlFromDefinition } = await getAsyncApiDefinition(spec);
|
|
9
|
+
const { document: asyncApiDocument, isUrl: isUrlFromDefinition } = await getAsyncApiDefinition(spec, opts?.localSchema);
|
|
10
10
|
if (asyncApiDocument) {
|
|
11
11
|
document = asyncApiDocument;
|
|
12
12
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generateAsyncApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/asyncapi/generateAsyncApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8C,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAIhG,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"generateAsyncApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/asyncapi/generateAsyncApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8C,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAIhG,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAoBrE,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACtD,IAA8C,EAC9C,IAAmC;IAEnC,IAAI,QAAQ,GAA0C,SAAS,CAAC;IAChE,IAAI,KAAc,CAAC;IACnB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;QACpD,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAAG,MAAM,qBAAqB,CAC5F,IAAI,EACJ,IAAI,EAAE,WAAW,CAClB,CAAC;QACF,IAAI,gBAAgB,EAAE,CAAC;YACrB,QAAQ,GAAG,gBAAgB,CAAC;QAC9B,CAAC;QACD,KAAK,GAAG,mBAAmB,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACzF,IAAI,CAAC,KAAK,IAAI,YAAY,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QACD,QAAQ,GAAG,gBAAgB,CAAC;QAC5B,KAAK,GAAG,KAAK,CAAC;IAChB,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAErC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,MAAM,YAAY,GAA0B,EAAE,CAAC;IAC/C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAE7D,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACjC,sBAAsB,CAAC;YACrB,OAAO,EAAE,OAA0B;YACnC,GAAG;YACH,YAAY;YACZ,aAAa;YACb,QAAQ;YACR,IAAI;YACJ,YAAY;SACb,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,QAAQ;QACd,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AsyncAPIDocumentInterface } from '@mintlify/common';
|
|
2
|
-
export declare const getAsyncApiDefinition: (pathOrDocumentOrUrl: string | URL) => Promise<{
|
|
2
|
+
export declare const getAsyncApiDefinition: (pathOrDocumentOrUrl: string | URL, localSchema?: boolean) => Promise<{
|
|
3
3
|
document: AsyncAPIDocumentInterface | undefined;
|
|
4
4
|
isUrl: boolean;
|
|
5
5
|
}>;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import { validateAsyncApi } from '@mintlify/common';
|
|
1
|
+
import { validateAsyncApi, isAllowedLocalSchemaUrl, } from '@mintlify/common';
|
|
2
2
|
import * as fs from 'fs/promises';
|
|
3
3
|
import * as path from 'path';
|
|
4
4
|
import { fetchAsyncApi } from '../utils/network.js';
|
|
5
|
-
export const getAsyncApiDefinition = async (pathOrDocumentOrUrl) => {
|
|
5
|
+
export const getAsyncApiDefinition = async (pathOrDocumentOrUrl, localSchema) => {
|
|
6
6
|
let document = undefined;
|
|
7
7
|
if (typeof pathOrDocumentOrUrl === 'string') {
|
|
8
|
-
if (pathOrDocumentOrUrl.startsWith('http
|
|
8
|
+
if (pathOrDocumentOrUrl.startsWith('http:') && !localSchema) {
|
|
9
9
|
// This is an invalid location either for a file or a URL
|
|
10
|
-
throw new Error('Only HTTPS URLs are supported.
|
|
10
|
+
throw new Error('Only HTTPS URLs are supported. HTTP URLs are only supported with the cli option --local-schema.');
|
|
11
11
|
}
|
|
12
12
|
else {
|
|
13
13
|
try {
|
|
@@ -32,8 +32,8 @@ export const getAsyncApiDefinition = async (pathOrDocumentOrUrl) => {
|
|
|
32
32
|
}
|
|
33
33
|
const isUrl = pathOrDocumentOrUrl instanceof URL;
|
|
34
34
|
if (pathOrDocumentOrUrl instanceof URL) {
|
|
35
|
-
if (pathOrDocumentOrUrl.
|
|
36
|
-
throw new Error('Only HTTPS URLs are supported.
|
|
35
|
+
if (!isAllowedLocalSchemaUrl(pathOrDocumentOrUrl.toString(), localSchema)) {
|
|
36
|
+
throw new Error('Only HTTPS URLs are supported. HTTP URLs are only supported with the cli option --local-schema.');
|
|
37
37
|
}
|
|
38
38
|
document = await fetchAsyncApi(pathOrDocumentOrUrl);
|
|
39
39
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getAsyncApiDefinition.js","sourceRoot":"","sources":["../../src/asyncapi/getAsyncApiDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"getAsyncApiDefinition.js","sourceRoot":"","sources":["../../src/asyncapi/getAsyncApiDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,EAChB,uBAAuB,GACxB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EACxC,mBAAiC,EACjC,WAAqB,EACyD,EAAE;IAChF,IAAI,QAAQ,GAA0C,SAAS,CAAC;IAChE,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;QAC5C,IAAI,mBAAmB,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5D,yDAAyD;YACzD,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBACzC,mBAAmB,GAAG,GAAG,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC1E,IAAI,CAAC;oBACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;oBAClD,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;oBAClF,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACtB,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,uDAAuD,YAAY,EAAE,CACjF,CAAC;oBACJ,CAAC;oBACD,QAAQ,GAAG,gBAAgB,CAAC;gBAC9B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,MAAM,KAAK,EAAE,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,mBAAmB,YAAY,GAAG,CAAC;IACjD,IAAI,mBAAmB,YAAY,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,EAAE,CAAC;YAC1E,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;QACJ,CAAC;QACD,QAAQ,GAAG,MAAM,aAAa,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC,CAAC"}
|
|
@@ -5,9 +5,7 @@ import { join, resolve } from 'path';
|
|
|
5
5
|
import { DEFAULT_WEBSOCKETS_GROUP_NAME, prepareStringToBeValidFilename, generateUniqueFilenameWithoutExtension, } from '../apiPages/common.js';
|
|
6
6
|
export const processAsyncApiChannel = ({ channel, nav, decoratedNav, writePromises, pagesAcc, opts, findNavGroup, }) => {
|
|
7
7
|
const asyncApiFilePathFromRoot = opts?.asyncApiFilePath
|
|
8
|
-
? opts.asyncApiFilePath
|
|
9
|
-
? opts.asyncApiFilePath
|
|
10
|
-
: optionallyAddLeadingSlash(opts.asyncApiFilePath)
|
|
8
|
+
? optionallyAddLeadingSlash(opts.asyncApiFilePath)
|
|
11
9
|
: undefined;
|
|
12
10
|
const tags = channel.tags().all();
|
|
13
11
|
const groupName = tags[0]?.name() ?? DEFAULT_WEBSOCKETS_GROUP_NAME;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"processAsyncApiChannel.js","sourceRoot":"","sources":["../../src/asyncapi/processAsyncApiChannel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AASlF,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,EACL,6BAA6B,EAC7B,8BAA8B,EAC9B,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAwB/B,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,EACrC,OAAO,EACP,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,EACJ,YAAY,GACe,EAAE,EAAE;IAC/B,MAAM,wBAAwB,GAAG,IAAI,EAAE,gBAAgB;QACrD,CAAC,CAAC,
|
|
1
|
+
{"version":3,"file":"processAsyncApiChannel.js","sourceRoot":"","sources":["../../src/asyncapi/processAsyncApiChannel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AASlF,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,EACL,6BAA6B,EAC7B,8BAA8B,EAC9B,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAwB/B,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,EACrC,OAAO,EACP,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,EACJ,YAAY,GACe,EAAE,EAAE;IAC/B,MAAM,wBAAwB,GAAG,IAAI,EAAE,gBAAgB;QACrD,CAAC,CAAC,yBAAyB,CAAC,IAAI,CAAC,gBAAgB,CAAC;QAClD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;IAClC,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,6BAA6B,CAAC;IACnE,MAAM,SAAS,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,SAAS,CAAC;IAC3C,MAAM,QAAQ,GAAG,8BAA8B,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC;IAErE,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAExD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAExF,MAAM,eAAe,GAAG,GACtB,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,GAAG,CAAC,CAAC,CAAC,EAC9D,GAAG,SAAS,EAAE,CAAC;IAEf,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAExC,MAAM,IAAI,GAA4B;QACpC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;QAC5C,KAAK,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;QAC/D,WAAW;QACX,OAAO,EAAE,IAAI,EAAE,OAAO;KACvB,CAAC;IACF,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;IAE1C,MAAM,UAAU,GAAG,IAAI,EAAE,cAAc;QACrC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;QAC9D,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;IACtC,IAAI,IAAI,EAAE,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5E,aAAa,CAAC,IAAI,CAAC,yBAAyB,CAAC,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3F,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,KAAK,EACrC,QAAgB,EAChB,eAAuB,EACvB,OAAgB,EAChB,EAAE;IACF,MAAM,IAAI,GAAG;YACH,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;IAChE,CAAC;IAEH,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC"}
|
package/bin/openapi/common.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { DecoratedNavigationPage } from '@mintlify/models';
|
|
2
2
|
import { OpenAPI, OpenAPIV3 } from 'openapi-types';
|
|
3
|
-
export declare const getOpenApiDefinition: (pathOrDocumentOrUrl: string | OpenAPI.Document | URL) => Promise<{
|
|
3
|
+
export declare const getOpenApiDefinition: (pathOrDocumentOrUrl: string | OpenAPI.Document | URL, localSchema?: boolean) => Promise<{
|
|
4
4
|
document: OpenAPI.Document;
|
|
5
5
|
isUrl: boolean;
|
|
6
6
|
}>;
|
|
@@ -17,6 +17,7 @@ export type GenerateOpenApiPagesOptions = {
|
|
|
17
17
|
outDir?: string;
|
|
18
18
|
outDirBasePath?: string;
|
|
19
19
|
overwrite?: boolean;
|
|
20
|
+
localSchema?: boolean;
|
|
20
21
|
};
|
|
21
22
|
export type OpenApiPageGenerationResult<N, DN> = {
|
|
22
23
|
nav: N;
|
package/bin/openapi/common.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { getOpenApiTitleAndDescription, optionallyAddLeadingSlash, slugToTitle, buildOpenApiMetaTag, } from '@mintlify/common';
|
|
1
|
+
import { getOpenApiTitleAndDescription, optionallyAddLeadingSlash, slugToTitle, isAllowedLocalSchemaUrl, buildOpenApiMetaTag, } from '@mintlify/common';
|
|
2
2
|
import { outputFile } from 'fs-extra';
|
|
3
3
|
import fse from 'fs-extra';
|
|
4
4
|
import fs from 'fs/promises';
|
|
@@ -7,11 +7,11 @@ import { OpenAPIV3 } from 'openapi-types';
|
|
|
7
7
|
import path, { join, parse, resolve } from 'path';
|
|
8
8
|
import { prepareStringToBeValidFilename, generateUniqueFilenameWithoutExtension, } from '../apiPages/common.js';
|
|
9
9
|
import { fetchOpenApi } from '../utils/network.js';
|
|
10
|
-
export const getOpenApiDefinition = async (pathOrDocumentOrUrl) => {
|
|
10
|
+
export const getOpenApiDefinition = async (pathOrDocumentOrUrl, localSchema) => {
|
|
11
11
|
if (typeof pathOrDocumentOrUrl === 'string') {
|
|
12
|
-
if (pathOrDocumentOrUrl.startsWith('http
|
|
12
|
+
if (pathOrDocumentOrUrl.startsWith('http:') && !localSchema) {
|
|
13
13
|
// This is an invalid location either for a file or a URL
|
|
14
|
-
throw new Error('Only HTTPS URLs are supported.
|
|
14
|
+
throw new Error('Only HTTPS URLs are supported. HTTP URLs are only supported with the cli option --local-schema.');
|
|
15
15
|
}
|
|
16
16
|
else {
|
|
17
17
|
try {
|
|
@@ -27,8 +27,8 @@ export const getOpenApiDefinition = async (pathOrDocumentOrUrl) => {
|
|
|
27
27
|
}
|
|
28
28
|
const isUrl = pathOrDocumentOrUrl instanceof URL;
|
|
29
29
|
if (pathOrDocumentOrUrl instanceof URL) {
|
|
30
|
-
if (pathOrDocumentOrUrl.
|
|
31
|
-
throw new Error('Only HTTPS URLs are supported.
|
|
30
|
+
if (!isAllowedLocalSchemaUrl(pathOrDocumentOrUrl.toString(), localSchema)) {
|
|
31
|
+
throw new Error('Only HTTPS URLs are supported. HTTP URLs are only supported with the cli option --local-schema.');
|
|
32
32
|
}
|
|
33
33
|
pathOrDocumentOrUrl = await fetchOpenApi(pathOrDocumentOrUrl);
|
|
34
34
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/openapi/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAE7B,yBAAyB,EACzB,WAAW,EACX,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAW,SAAS,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EACL,8BAA8B,EAC9B,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,mBAAoD,
|
|
1
|
+
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/openapi/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAE7B,yBAAyB,EACzB,WAAW,EACX,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAW,SAAS,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EACL,8BAA8B,EAC9B,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,mBAAoD,EACpD,WAAqB,EACoC,EAAE;IAC3D,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;QAC5C,IAAI,mBAAmB,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5D,yDAAyD;YACzD,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBACzC,mBAAmB,GAAG,GAAG,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC1E,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,mBAAmB,YAAY,GAAG,CAAC;IACjD,IAAI,mBAAmB,YAAY,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,EAAE,CAAC;YAC1E,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;QACJ,CAAC;QACD,mBAAmB,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC;AAClD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,EAAE,EAC7C,QAAQ,EACR,cAAc,EACd,OAAO,EACP,UAAU,GAMX,EAAE,EAAE;IACH,MAAM,IAAI,GAAG;WACJ,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,GAC9D,UAAU,CAAC,CAAC,CAAC,iBAAiB,UAAU,EAAE,CAAC,CAAC,CAAC,EAC/C;IACE,CAAC;IAEH,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAyBF,MAAM,iBAAiB,GAAG,CAAC,SAA6C,EAAE,EAAE;IAC1E,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,SAA6C,EAAE,EAAE;IAC5E,OAAO,SAAS,CAAC,YAAY,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,UAAU,kBAAkB,CAChC,IAAY,EACZ,cAAwC,EACxC,MAAwB,EACxB,GAAM,EACN,YAAgB,EAChB,aAA8B,EAC9B,QAAiD,EACjD,OAAoC;AACpC,8DAA8D;AAC9D,YAAmD;IAEnD,MAAM,uBAAuB,GAAG,OAAO,CAAC,eAAe;QACrD,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,eAAe,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACtD,IAAI,MAAM,IAAI,cAAc,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,mBAAmB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACzE,OAAO;YACT,CAAC;YACD,MAAM,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,KAAK,GACT,8BAA8B,CAAC,SAAS,EAAE,OAAO,CAAC;gBAClD,GAAG,MAAM,IAAI,8BAA8B,CAAC,IAAI,CAAC,EAAE,CAAC;YACtD,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACxF,MAAM,cAAc,GAAG,mBAAmB,CAAC;gBACzC,QAAQ,EAAE,uBAAuB;gBACjC,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,6BAA6B,CACpE;gBACE;oBACE,QAAQ,EAAE,OAAO,CAAC,eAAe;wBAC/B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI;wBACrC,CAAC,CAAC,iBAAiB;oBACrB,IAAI,EAAE,MAAM;oBACZ,oBAAoB,EAAE,OAAO,CAAC,eAAe;iBAC9C;aACF,EACD,cAAc,CACf,CAAC;YACF,MAAM,IAAI,GAA4B;gBACpC,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;gBAC5C,KAAK,EAAE,QAAQ,IAAI,WAAW,CAAC,wBAAwB,CAAC;gBACxD,WAAW;gBACX,UAAU,EAAE,SAAS,EAAE,UAAU;gBACjC,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAC;YAEF,IAAI,CAAC,iBAAiB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACxE,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBACxC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;YAC1C,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc;gBACvC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;gBACjE,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;YACtC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjF,aAAa,CAAC,IAAI,CAChB,wBAAwB,CAAC;oBACvB,QAAQ,EAAE,UAAU;oBACpB,cAAc,EAAE,cAAc;oBAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,UAAU,EAAE,SAAS,EAAE,UAAU;iBAClC,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,OAAe,EACf,aAAuC,EACvC,OAAyB,EACzB,GAAM,EACN,YAAgB,EAChB,aAA8B,EAC9B,QAAiD,EACjD,OAAoC;AACpC,8DAA8D;AAC9D,YAAmD;IAEnD,MAAM,uBAAuB,GAAG,OAAO,CAAC,eAAe;QACrD,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,eAAe,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACtD,IAAI,MAAM,IAAI,aAAa,EAAE,CAAC;YAC5B,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,mBAAmB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACzE,OAAO;YACT,CAAC;YACD,MAAM,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,KAAK,GACT,8BAA8B,CAAC,SAAS,EAAE,OAAO,CAAC;gBAClD,GAAG,8BAA8B,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAExF,MAAM,cAAc,GAAG,mBAAmB,CAAC;gBACzC,QAAQ,EAAE,uBAAuB;gBACjC,MAAM,EAAE,SAAS;gBACjB,IAAI,EAAE,OAAO;aACd,CAAC,CAAC;YAEH,MAAM,WAAW,GAAG,SAAS,EAAE,WAAW,CAAC;YAE3C,MAAM,IAAI,GAA4B;gBACpC,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;gBAC5C,KAAK,EAAE,WAAW,CAAC,wBAAwB,CAAC;gBAC5C,WAAW;gBACX,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,UAAU,EAAE,SAAS,EAAE,UAAU;aAClC,CAAC;YAEF,IAAI,CAAC,iBAAiB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACxE,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBACxC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;YAC1C,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc;gBACvC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;gBACjE,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;YACtC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjF,aAAa,CAAC,IAAI,CAChB,wBAAwB,CAAC;oBACvB,QAAQ,EAAE,UAAU;oBACpB,cAAc,EAAE,cAAc;oBAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,UAAU,EAAE,SAAS,EAAE,UAAU;iBAClC,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -2,7 +2,7 @@ import { validate } from '@mintlify/common';
|
|
|
2
2
|
import { DEFAULT_API_GROUP_NAME } from '../apiPages/common.js';
|
|
3
3
|
import { getOpenApiDefinition, processOpenApiPath, processOpenApiWebhook, } from './common.js';
|
|
4
4
|
export async function generateOpenApiPages(pathOrDocumentOrUrl, opts) {
|
|
5
|
-
const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl);
|
|
5
|
+
const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl, opts?.localSchema);
|
|
6
6
|
const { schema } = await validate(document);
|
|
7
7
|
if (schema?.openapi === '3.0.0' &&
|
|
8
8
|
(schema.paths === undefined || Object.keys(schema.paths).length === 0)) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generateOpenApiPages.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"generateOpenApiPages.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IAC/F,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5C,IACE,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EACtE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;SAAM,IACL,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;QACtE,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAC5E,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,YAAY,GAAwB,EAAE,CAAC;IAC7C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAE7D,IAAI,MAAM,EAAE,KAAK,EAAE,CAAC;QAClB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE;YAC9D,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAC1D,OAAO;YACT,CAAC;YACD,kBAAkB,CAChB,IAAI,EACJ,cAAc,EACd,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE;YACnE,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACxD,OAAO;YACT,CAAC;YACD,qBAAqB,CACnB,OAAO,EACP,aAAa,EACb,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,MAA0B;QAChC,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,CACnB,GAAyB,EACzB,YAAoB,sBAAsB,EACpB,EAAE;IACxB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,CAAC,WAAW,EAAE,EAAE,CACd,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,CAC9E,CAAC;IACnB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG;YACf,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -2,7 +2,7 @@ import { validate } from '@mintlify/common';
|
|
|
2
2
|
import { findNavGroup } from '../apiPages/common.js';
|
|
3
3
|
import { getOpenApiDefinition, processOpenApiPath, processOpenApiWebhook, } from './common.js';
|
|
4
4
|
export async function generateOpenApiPagesForDocsConfig(pathOrDocumentOrUrl, opts) {
|
|
5
|
-
const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl);
|
|
5
|
+
const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl, opts?.localSchema);
|
|
6
6
|
const { schema } = await validate(document);
|
|
7
7
|
if (schema?.openapi === '3.0.0' &&
|
|
8
8
|
(schema.paths === undefined || Object.keys(schema.paths).length === 0)) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generateOpenApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAK5C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,iCAAiC,CACrD,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"generateOpenApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAK5C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,iCAAiC,CACrD,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IAC/F,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5C,IACE,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EACtE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;SAAM,IACL,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;QACtE,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAC5E,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,MAAM,YAAY,GAA0B,EAAE,CAAC;IAC/C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAE7D,IAAI,MAAM,EAAE,KAAK,EAAE,CAAC;QAClB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE;YAC9D,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAC1D,OAAO;YACT,CAAC;YACD,kBAAkB,CAChB,IAAI,EACJ,cAAc,EACd,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE;YACnE,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACxD,OAAO;YACT,CAAC;YACD,qBAAqB,CACnB,OAAO,EACP,aAAa,EACb,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,MAA0B;QAChC,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC"}
|