@mintlify/validation 0.1.309 → 0.1.311

package/dist/mint-config/validateConfig.d.ts

@@ -741,6 +741,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
         telemetry?: {
             enabled?: boolean | undefined;
         } | undefined;
+        cookies?: {
+            key?: string | undefined;
+            value?: string | undefined;
+        } | undefined;
     } | undefined;
     banner?: {
         content: string;
@@ -1011,6 +1015,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
         telemetry?: {
             enabled?: boolean | undefined;
         } | undefined;
+        cookies?: {
+            key?: string | undefined;
+            value?: string | undefined;
+        } | undefined;
     } | undefined;
     banner?: {
         content: string;
@@ -1281,6 +1289,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
         telemetry?: {
             enabled?: boolean | undefined;
         } | undefined;
+        cookies?: {
+            key?: string | undefined;
+            value?: string | undefined;
+        } | undefined;
     } | undefined;
     banner?: {
         content: string;
@@ -1551,6 +1563,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
         telemetry?: {
             enabled?: boolean | undefined;
         } | undefined;
+        cookies?: {
+            key?: string | undefined;
+            value?: string | undefined;
+        } | undefined;
     } | undefined;
     banner?: {
         content: string;
@@ -1821,6 +1837,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
         telemetry?: {
             enabled?: boolean | undefined;
         } | undefined;
+        cookies?: {
+            key?: string | undefined;
+            value?: string | undefined;
+        } | undefined;
     } | undefined;
     banner?: {
         content: string;
@@ -2094,6 +2114,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
             telemetry?: {
                 enabled?: boolean | undefined;
             } | undefined;
+            cookies?: {
+                key?: string | undefined;
+                value?: string | undefined;
+            } | undefined;
         } | undefined;
         banner?: {
             content: string;
@@ -2364,6 +2388,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
             telemetry?: {
                 enabled?: boolean | undefined;
             } | undefined;
+            cookies?: {
+                key?: string | undefined;
+                value?: string | undefined;
+            } | undefined;
         } | undefined;
         banner?: {
             content: string;
@@ -2634,6 +2662,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
             telemetry?: {
                 enabled?: boolean | undefined;
             } | undefined;
+            cookies?: {
+                key?: string | undefined;
+                value?: string | undefined;
+            } | undefined;
         } | undefined;
         banner?: {
             content: string;
@@ -2904,6 +2936,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
             telemetry?: {
                 enabled?: boolean | undefined;
             } | undefined;
+            cookies?: {
+                key?: string | undefined;
+                value?: string | undefined;
+            } | undefined;
         } | undefined;
         banner?: {
             content: string;
@@ -3174,6 +3210,10 @@ export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
             telemetry?: {
                 enabled?: boolean | undefined;
             } | undefined;
+            cookies?: {
+                key?: string | undefined;
+                value?: string | undefined;
+            } | undefined;
         } | undefined;
         banner?: {
             content: string;

package/dist/openapi/OpenApiToEndpointConverter.d.ts

@@ -1,6 +1,7 @@
 import { OpenAPIV3_1 } from 'openapi-types';
 import { BaseConverter } from './BaseConverter.js';
 import type { ContentSchema, DataSchemaArray, Endpoint, ExampleSchema, HttpMethod, IncrementalDataSchemaArray, ParameterSections, ResponseSchema } from './types/endpoint.js';
+import { EndpointLocation } from './types/endpoint.js';
 export declare abstract class BaseOpenApiToEndpointConverter<D extends DataSchemaArray | IncrementalDataSchemaArray> extends BaseConverter {
     readonly document: OpenAPIV3_1.Document;
     readonly path: string;
@@ -8,6 +9,7 @@ export declare abstract class BaseOpenApiToEndpointConverter<D extends DataSchem
     readonly safeParse: boolean;
     protected pathObject: OpenAPIV3_1.PathItemObject;
     protected operationObject: OpenAPIV3_1.OperationObject;
+    protected location: EndpointLocation;
     protected constructor(document: OpenAPIV3_1.Document, path: string, method: HttpMethod, safeParse?: boolean);
     protected convert(): Endpoint<D>;
     abstract convertParameters(): ParameterSections<D>;

package/dist/openapi/OpenApiToEndpointConverter.js

@@ -6,6 +6,7 @@ import { SecurityConverter } from './SecurityConverter.js';
 import { ServersConverter } from './ServersConverter.js';
 import { InvalidSchemaError } from './errors.js';
 import { generateExampleFromSchema } from './generateExampleFromSchema.js';
+import { EndpointLocation } from './types/endpoint.js';
 import { dereference } from './utils.js';
 export class BaseOpenApiToEndpointConverter extends BaseConverter {
     constructor(document, path, method, safeParse = false) {
@@ -14,18 +15,19 @@ export class BaseOpenApiToEndpointConverter extends BaseConverter {
         this.path = path;
         this.method = method;
         this.safeParse = safeParse;
-        const paths = this.document.paths;
+        this.location = new EndpointLocation(document, path);
+        const paths = this.location.getEndpointPaths();
         if (paths === undefined) {
-            throw new InvalidSchemaError(['#'], 'paths not defined');
+            throw new InvalidSchemaError(['#'], `${this.location.type} not defined`);
         }
-        const pathObject = paths[this.path];
+        const pathObject = this.location.getEndpoint();
         if (pathObject === undefined) {
-            throw new InvalidSchemaError(['#', 'paths'], `path not defined: ${this.path}`);
+            throw new InvalidSchemaError(['#', this.location.path], `${this.location.type} not defined: ${this.path}`);
         }
         this.pathObject = pathObject;
         const operationObject = pathObject[this.method];
         if (operationObject === undefined) {
-            throw new InvalidSchemaError(['#', 'paths', this.path], `operation does not exist: ${this.method}`);
+            throw new InvalidSchemaError(['#', this.location.path, this.path], `operation does not exist: ${this.method}`);
         }
         this.operationObject = operationObject;
     }
@@ -41,7 +43,7 @@ export class BaseOpenApiToEndpointConverter extends BaseConverter {
         const description = (_e = this.operationObject.description) !== null && _e !== void 0 ? _e : this.pathObject.description;
         const body = this.convertBody();
         const deprecated = !!this.operationObject.deprecated;
-        const codeSamples = this.convertCodeSamples(['#', 'paths', this.path, this.method], this.operationObject);
+        const codeSamples = this.convertCodeSamples(['#', this.location.path, this.path, this.method], this.operationObject);
         const response = this.convertResponses();
         return {
             title,
@@ -57,6 +59,7 @@ export class BaseOpenApiToEndpointConverter extends BaseConverter {
             },
             response,
             deprecated,
+            type: this.location.type,
         };
     }
     convertExamples(examples, example, schemaArray) {
@@ -120,7 +123,7 @@ export class BaseOpenApiToEndpointConverter extends BaseConverter {
 export class OpenApiToEndpointConverter extends BaseOpenApiToEndpointConverter {
     convertBody() {
         const requestBody = this.operationObject.requestBody;
-        return this.convertContent(['#', 'paths', this.path, this.method, 'requestBody', 'content'], requestBody === null || requestBody === void 0 ? void 0 : requestBody.content, 'request', requestBody === null || requestBody === void 0 ? void 0 : requestBody.required, requestBody === null || requestBody === void 0 ? void 0 : requestBody.description);
+        return this.convertContent(['#', this.location.path, this.path, this.method, 'requestBody', 'content'], requestBody === null || requestBody === void 0 ? void 0 : requestBody.content, 'request', requestBody === null || requestBody === void 0 ? void 0 : requestBody.required, requestBody === null || requestBody === void 0 ? void 0 : requestBody.description);
     }
     convertResponses() {
         const responses = this.operationObject.responses;
@@ -128,7 +131,7 @@ export class OpenApiToEndpointConverter extends BaseOpenApiToEndpointConverter {
             return {};
         const newEntries = Object.entries(responses).map(([statusCode, response]) => [
             statusCode,
-            this.convertContent(['#', 'paths', this.path, this.method, 'responses', statusCode, 'content'], response.content, 'response', undefined, response.description),
+            this.convertContent(['#', this.location.path, this.path, this.method, 'responses', statusCode, 'content'], response.content, 'response', undefined, response.description),
         ]);
         return Object.fromEntries(newEntries);
     }
@@ -153,7 +156,7 @@ export class OpenApiToEndpointConverter extends BaseOpenApiToEndpointConverter {
     convertParameters() {
         const pathParameters = this.pathObject.parameters;
         const operationParameters = this.operationObject.parameters;
-        return ParametersConverter.convert(this.method, pathParameters, operationParameters, ['#', 'paths', this.path], this.safeParse);
+        return ParametersConverter.convert(this.method, pathParameters, operationParameters, ['#', this.location.path, this.path], this.safeParse);
     }
     static convert(spec, path, method, safeParse) {
         return new OpenApiToEndpointConverter(spec, path, method, safeParse).convert();
@@ -165,25 +168,28 @@ export class OpenApiToIncrementalEndpointConverter extends BaseOpenApiToEndpoint
         this.rawDocument = rawDocument;
     }
     convertParameters() {
-        var _a, _b, _c, _d, _e;
-        const pathParameters = (_b = (_a = this.rawDocument.paths) === null || _a === void 0 ? void 0 : _a[this.path]) === null || _b === void 0 ? void 0 : _b.parameters;
-        const operationParameters = (_e = (_d = (_c = this.rawDocument.paths) === null || _c === void 0 ? void 0 : _c[this.path]) === null || _d === void 0 ? void 0 : _d[this.method]) === null || _e === void 0 ? void 0 : _e.parameters;
-        return IncrementalParametersConverter.convert(this.rawDocument, this.method, pathParameters, operationParameters, ['#', 'paths', this.path], this.safeParse);
+        var _a;
+        const path = this.location.getEndpoint();
+        const pathParameters = path === null || path === void 0 ? void 0 : path.parameters;
+        const operationParameters = (_a = path === null || path === void 0 ? void 0 : path[this.method]) === null || _a === void 0 ? void 0 : _a.parameters;
+        return IncrementalParametersConverter.convert(this.rawDocument, this.method, pathParameters, operationParameters, ['#', this.location.path, this.path], this.safeParse);
     }
     convertBody() {
-        var _a, _b, _c, _d;
-        let rawRequestBody = (_c = (_b = (_a = this.rawDocument.paths) === null || _a === void 0 ? void 0 : _a[this.path]) === null || _b === void 0 ? void 0 : _b[this.method]) === null || _c === void 0 ? void 0 : _c.requestBody;
+        var _a, _b;
+        const path = this.location.getEndpoint();
+        let rawRequestBody = (_a = path === null || path === void 0 ? void 0 : path[this.method]) === null || _a === void 0 ? void 0 : _a.requestBody;
         if (rawRequestBody && '$ref' in rawRequestBody) {
-            rawRequestBody = dereference('requestBodies', rawRequestBody.$ref, (_d = this.rawDocument.components) === null || _d === void 0 ? void 0 : _d.requestBodies);
+            rawRequestBody = dereference('requestBodies', rawRequestBody.$ref, (_b = this.rawDocument.components) === null || _b === void 0 ? void 0 : _b.requestBodies);
         }
         if (!rawRequestBody || '$ref' in rawRequestBody)
             return {};
         const requestBody = this.operationObject.requestBody;
-        return this.convertContent(['#', 'paths', this.path, this.method, 'requestBody', 'content'], rawRequestBody.content, requestBody === null || requestBody === void 0 ? void 0 : requestBody.content, 'request', requestBody === null || requestBody === void 0 ? void 0 : requestBody.required, requestBody === null || requestBody === void 0 ? void 0 : requestBody.description);
+        return this.convertContent(['#', this.location.path, this.path, this.method, 'requestBody', 'content'], rawRequestBody.content, requestBody === null || requestBody === void 0 ? void 0 : requestBody.content, 'request', requestBody === null || requestBody === void 0 ? void 0 : requestBody.required, requestBody === null || requestBody === void 0 ? void 0 : requestBody.description);
     }
     convertResponses() {
-        var _a, _b, _c;
-        const rawResponses = (_c = (_b = (_a = this.rawDocument.paths) === null || _a === void 0 ? void 0 : _a[this.path]) === null || _b === void 0 ? void 0 : _b[this.method]) === null || _c === void 0 ? void 0 : _c.responses;
+        var _a;
+        const path = this.location.getEndpoint();
+        const rawResponses = (_a = path === null || path === void 0 ? void 0 : path[this.method]) === null || _a === void 0 ? void 0 : _a.responses;
         if (!rawResponses)
             return {};
         const newEntries = Object.entries(rawResponses).map(([statusCode, rawResponse]) => {
@@ -197,19 +203,27 @@ export class OpenApiToIncrementalEndpointConverter extends BaseOpenApiToEndpoint
             const response = (_b = this.operationObject.responses) === null || _b === void 0 ? void 0 : _b[statusCode];
             return [
                 statusCode,
-                this.convertContent(['#', 'paths', this.path, this.method, 'responses', statusCode, 'content'], rawResponse.content, response === null || response === void 0 ? void 0 : response.content, 'response', undefined, response === null || response === void 0 ? void 0 : response.description),
+                this.convertContent(['#', this.location.path, this.path, this.method, 'responses', statusCode, 'content'], rawResponse.content, response === null || response === void 0 ? void 0 : response.content, 'response', undefined, response === null || response === void 0 ? void 0 : response.description),
             ];
         });
         return Object.fromEntries(newEntries);
     }
     convertContent(debugPath, rawContent, dereferencedContent, location, required, description) {
         if (!rawContent || !dereferencedContent) {
+            if (description) {
+                return {
+                    '_mintlify/placeholder': {
+                        schemaArray: [{ type: 'any', description }],
+                        examples: {},
+                        description,
+                    },
+                };
+            }
             return {};
         }
         const newEntries = Object.entries(rawContent).map(([contentType, mediaObject]) => {
             var _a;
             const incrementalSchemaArray = generateFirstIncrementalSchema(mediaObject.schema, (_a = this.rawDocument.components) === null || _a === void 0 ? void 0 : _a.schemas, required, location, contentType);
-            // still need to generate schemaArray so we can generate examples
             const dereferencedMediaObject = dereferencedContent[contentType];
             const schemaArray = SchemaConverter.convert({
                 schema: dereferencedMediaObject === null || dereferencedMediaObject === void 0 ? void 0 : dereferencedMediaObject.schema,

package/dist/openapi/types/endpoint.d.ts

@@ -1,4 +1,5 @@
-import { OpenAPIV3_1 } from 'openapi-types';
+import { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
+export type DocumentV3 = OpenAPIV3.Document | OpenAPIV3_1.Document;
 export type Endpoint<D extends DataSchemaArray | IncrementalDataSchemaArray = DataSchemaArray | IncrementalDataSchemaArray> = {
     title?: string;
     description?: string;
@@ -8,7 +9,18 @@ export type Endpoint<D extends DataSchemaArray | IncrementalDataSchemaArray = Da
     request: RequestSchema<D>;
     response: ResponseSchema<D>;
     deprecated: boolean;
-};
+    type?: EndpointType;
+};
+export type EndpointType = 'path' | 'webhook';
+export declare class EndpointLocation {
+    readonly type: EndpointType;
+    readonly path: 'paths' | 'webhooks';
+    readonly endpointPath: string;
+    readonly document: OpenAPIV3_1.Document;
+    constructor(document: OpenAPIV3_1.Document, path: string);
+    getEndpointPaths(): OpenAPIV3_1.PathItemObject | undefined;
+    getEndpoint(): OpenAPIV3_1.PathItemObject | undefined;
+}
 export type Server = {
     url: string;
     description?: string;

package/dist/openapi/types/endpoint.js

@@ -1,3 +1,19 @@
+export class EndpointLocation {
+    constructor(document, path) {
+        var _a;
+        this.document = document;
+        this.endpointPath = path;
+        this.path = ((_a = document.webhooks) === null || _a === void 0 ? void 0 : _a[path]) ? 'webhooks' : 'paths';
+        this.type = this.path.slice(0, -1);
+    }
+    getEndpointPaths() {
+        return this.document[this.path];
+    }
+    getEndpoint() {
+        var _a;
+        return (_a = this.document[this.path]) === null || _a === void 0 ? void 0 : _a[this.endpointPath];
+    }
+}
 // Request types
 export const httpMethods = [
     'get',