@scalar/openapi-types 0.1.8 → 0.2.0

package/dist/schemas/3.1/processed/callback-object.d.ts

@@ -0,0 +1,169 @@
+import { z } from 'zod';
+/**
+ * Callback Object
+ *
+ * A map of possible out-of-band callbacks related to the parent operation. Each value in the map is a
+ * Path Item Object that describes a set of requests that may be initiated by the API provider and the
+ * expected responses. The key value used to identify the callback object is an expression, evaluated
+ * at runtime, that identifies a URL to be used for the callback operation.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#callback-object
+ */
+export declare const CallbackObjectSchema: z.ZodRecord<z.ZodEffects<z.ZodString, string, string>, z.ZodType<{
+    servers?: {
+        url: string;
+        description?: string | undefined;
+        variables?: Record<string, {
+            description?: string | undefined;
+            default?: string | undefined;
+            enum?: string[] | undefined;
+        }> | undefined;
+    }[] | undefined;
+    description?: string | undefined;
+    summary?: string | undefined;
+    parameters?: {
+        name: string;
+        in: "path" | "query" | "header" | "cookie";
+        description?: string | undefined;
+        deprecated?: boolean | undefined;
+        content?: Record<string, {
+            example?: any;
+            examples?: Record<string, {
+                description?: string | undefined;
+                summary?: string | undefined;
+                value?: any;
+                externalValue?: string | undefined;
+            }> | undefined;
+            schema?: Record<string, any> | undefined;
+            encoding?: Record<string, {
+                contentType: string;
+                headers?: Record<string, {
+                    description?: string | undefined;
+                    deprecated?: boolean | undefined;
+                    content?: Record<string, {
+                        example?: any;
+                        examples?: Record<string, {
+                            description?: string | undefined;
+                            summary?: string | undefined;
+                            value?: any;
+                            externalValue?: string | undefined;
+                        }> | undefined;
+                        schema?: Record<string, any> | undefined;
+                    }> | undefined;
+                    required?: boolean | undefined;
+                    example?: any;
+                    examples?: Record<string, {
+                        description?: string | undefined;
+                        summary?: string | undefined;
+                        value?: any;
+                        externalValue?: string | undefined;
+                    }> | undefined;
+                    schema?: Record<string, any> | undefined;
+                    style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    explode?: boolean | undefined;
+                }> | undefined;
+            }> | undefined;
+        }> | undefined;
+        required?: boolean | undefined;
+        example?: any;
+        examples?: Record<string, {
+            description?: string | undefined;
+            summary?: string | undefined;
+            value?: any;
+            externalValue?: string | undefined;
+        }> | undefined;
+        schema?: Record<string, any> | undefined;
+        style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
+        allowEmptyValue?: boolean | undefined;
+        allowReserved?: boolean | undefined;
+    }[] | undefined;
+} & {
+    get?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    put?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    post?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    delete?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    options?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    head?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    patch?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    trace?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+}, z.ZodTypeDef, {
+    servers?: {
+        url: string;
+        description?: string | undefined;
+        variables?: Record<string, {
+            description?: string | undefined;
+            default?: string | undefined;
+            enum?: string[] | undefined;
+        }> | undefined;
+    }[] | undefined;
+    description?: string | undefined;
+    summary?: string | undefined;
+    parameters?: {
+        name: string;
+        in: "path" | "query" | "header" | "cookie";
+        description?: string | undefined;
+        deprecated?: boolean | undefined;
+        content?: Record<string, {
+            example?: any;
+            examples?: Record<string, {
+                description?: string | undefined;
+                summary?: string | undefined;
+                value?: any;
+                externalValue?: string | undefined;
+            }> | undefined;
+            schema?: Record<string, any> | undefined;
+            encoding?: Record<string, {
+                contentType: string;
+                headers?: Record<string, {
+                    description?: string | undefined;
+                    deprecated?: boolean | undefined;
+                    content?: Record<string, {
+                        example?: any;
+                        examples?: Record<string, {
+                            description?: string | undefined;
+                            summary?: string | undefined;
+                            value?: any;
+                            externalValue?: string | undefined;
+                        }> | undefined;
+                        schema?: Record<string, any> | undefined;
+                    }> | undefined;
+                    required?: boolean | undefined;
+                    example?: any;
+                    examples?: Record<string, {
+                        description?: string | undefined;
+                        summary?: string | undefined;
+                        value?: any;
+                        externalValue?: string | undefined;
+                    }> | undefined;
+                    schema?: Record<string, any> | undefined;
+                    style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    explode?: boolean | undefined;
+                }> | undefined;
+            }> | undefined;
+        }> | undefined;
+        required?: boolean | undefined;
+        example?: any;
+        examples?: Record<string, {
+            description?: string | undefined;
+            summary?: string | undefined;
+            value?: any;
+            externalValue?: string | undefined;
+        }> | undefined;
+        schema?: Record<string, any> | undefined;
+        style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
+        allowEmptyValue?: boolean | undefined;
+        allowReserved?: boolean | undefined;
+    }[] | undefined;
+} & {
+    get?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    put?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    post?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    delete?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    options?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    head?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    patch?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+    trace?: z.infer<typeof import("./operation-object-without-callbacks.js").OperationObjectSchemaWithoutCallbacks>;
+}>>;
+//# sourceMappingURL=callback-object.d.ts.map

package/dist/schemas/3.1/processed/callback-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"callback-object.d.ts","sourceRoot":"","sources":["../../../../src/schemas/3.1/processed/callback-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAPgD,EAAE,KAAK;UACjD,EAAG,KAAK;WAC9C,EAAE,KAAI;aAAyD,EAAG,KAAK;cAC5C,EAAG,KAAK;WAExB,EAAG,KAAK;YAAwD,EAAG,KAAK;YAE7C,EAAG,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAPoC,KAAK;YAC9C,KAAK;aAC5C,KAAI;eAA4D,KAAK;gBACzC,KAAK;aAErB,KAAK;cAA2D,KAAK;cAE1C,KAAK;GAA4D,CAAA"}

package/dist/schemas/3.1/processed/callback-object.js

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+import { PathItemObjectSchemaWithoutCallbacks } from './path-item-object-without-callbacks.js';
+import { RuntimeExpressionSchema } from './runtime-expression.js';
+
+/**
+ * Callback Object
+ *
+ * A map of possible out-of-band callbacks related to the parent operation. Each value in the map is a
+ * Path Item Object that describes a set of requests that may be initiated by the API provider and the
+ * expected responses. The key value used to identify the callback object is an expression, evaluated
+ * at runtime, that identifies a URL to be used for the callback operation.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#callback-object
+ */
+const CallbackObjectSchema = z.record(RuntimeExpressionSchema, PathItemObjectSchemaWithoutCallbacks);
+
+export { CallbackObjectSchema };