@scalar/openapi-types 0.1.9 → 0.2.0

package/dist/schemas/3.1/unprocessed/parameter-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter-object.d.ts","sourceRoot":"","sources":["../../../../src/schemas/3.1/unprocessed/parameter-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAMvB;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAChC;;;;;QAKI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEJ;;;QAGI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEJ,CAAA"}

package/dist/schemas/3.1/unprocessed/parameter-object.js

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import { ParameterObjectSchema as ParameterObjectSchema$1 } from '../processed/parameter-object.js';
+import { ExampleObjectSchema } from './example-object.js';
+import { MediaTypeObjectSchema } from './media-type-object.js';
+import { ReferenceObjectSchema } from './reference-object.js';
+
+/**
+ * Parameter Object
+ *
+ * Describes a single operation parameter.
+ *
+ * A unique parameter is defined by a combination of a name and location.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#parameter-object
+ */
+const ParameterObjectSchema = ParameterObjectSchema$1.extend({
+    /**
+     * Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as
+     * specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore,
+     * if referencing a schema that contains an example, the examples value SHALL override the example provided by the
+     * schema.
+     **/
+    examples: z.record(z.string(), z.union([ReferenceObjectSchema, ExampleObjectSchema])).optional(),
+    /**
+     * A map containing the representations for the parameter. The key is the media type and the value describes it.
+     * The map MUST only contain one entry.
+     **/
+    content: z.record(z.string(), MediaTypeObjectSchema).optional(),
+});
+
+export { ParameterObjectSchema };

package/dist/schemas/3.1/unprocessed/path-item-object-without-callbacks.d.ts

@@ -0,0 +1,25 @@
+import type { z } from 'zod';
+import { BasePathItemObjectSchema } from './base-path-item-object.js';
+import { OperationObjectSchemaWithoutCallbacks } from './operation-object-without-callbacks.js';
+type PathItemObjectSchemaWithoutCallbacks = z.infer<typeof BasePathItemObjectSchema> & {
+    get?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+    put?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+    post?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+    delete?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+    options?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+    head?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+    patch?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+    trace?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>;
+};
+/**
+ * Path Item Object (without callbacks)
+ *
+ * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path
+ * itself is still exposed to the documentation viewer but they will not know which operations and parameters are
+ * available.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#path-item-object
+ */
+export declare const PathItemObjectSchemaWithoutCallbacks: z.ZodType<PathItemObjectSchemaWithoutCallbacks>;
+export {};
+//# sourceMappingURL=path-item-object-without-callbacks.d.ts.map

package/dist/schemas/3.1/unprocessed/path-item-object-without-callbacks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-item-object-without-callbacks.d.ts","sourceRoot":"","sources":["../../../../src/schemas/3.1/unprocessed/path-item-object-without-callbacks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,EAAE,qCAAqC,EAAE,MAAM,sCAAsC,CAAA;AAE5F,KAAK,oCAAoC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,GAAG;IACrF,GAAG,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;IAC3D,GAAG,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;IAC3D,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;IAC5D,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;IAC9D,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;IAC/D,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;IAC5D,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;IAC7D,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAA;CAC9D,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAkC7F,CAAA"}

package/dist/schemas/3.1/unprocessed/path-item-object-without-callbacks.js

@@ -0,0 +1,48 @@
+import { BasePathItemObjectSchema } from './base-path-item-object.js';
+import { OperationObjectSchemaWithoutCallbacks } from './operation-object-without-callbacks.js';
+
+/**
+ * Path Item Object (without callbacks)
+ *
+ * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path
+ * itself is still exposed to the documentation viewer but they will not know which operations and parameters are
+ * available.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#path-item-object
+ */
+const PathItemObjectSchemaWithoutCallbacks = BasePathItemObjectSchema.extend({
+    /**
+     * A definition of a GET operation on this path.
+     */
+    get: OperationObjectSchemaWithoutCallbacks.optional(),
+    /**
+     * A definition of a PUT operation on this path.
+     */
+    put: OperationObjectSchemaWithoutCallbacks.optional(),
+    /**
+     * A definition of a POST operation on this path.
+     */
+    post: OperationObjectSchemaWithoutCallbacks.optional(),
+    /**
+     * A definition of a DELETE operation on this path.
+     */
+    delete: OperationObjectSchemaWithoutCallbacks.optional(),
+    /**
+     * A definition of a OPTIONS operation on this path.
+     */
+    options: OperationObjectSchemaWithoutCallbacks.optional(),
+    /**
+     * A definition of a HEAD operation on this path.
+     */
+    head: OperationObjectSchemaWithoutCallbacks.optional(),
+    /**
+     * A definition of a PATCH operation on this path.
+     */
+    patch: OperationObjectSchemaWithoutCallbacks.optional(),
+    /**
+     * A definition of a TRACE operation on this path.
+     */
+    trace: OperationObjectSchemaWithoutCallbacks.optional(),
+});
+
+export { PathItemObjectSchemaWithoutCallbacks };