@scalar/openapi-types 0.1.8 → 0.2.0

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

@@ -0,0 +1,93 @@
+import { z } from 'zod';
+import { ExampleObjectSchema } from './example-object.js';
+import { MediaTypeObjectSchema } from './media-type-object.js';
+import { SchemaObjectSchema } from './schema-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 = z.object({
+    /**
+     * REQUIRED. The name of the parameter. Parameter names are case sensitive.
+     *
+     * - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the
+     *   Paths Object. See Path Templating for further information.
+     * - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition
+     *   SHALL be ignored.
+     * - For all other cases, the name corresponds to the parameter name used by the in property.
+     **/
+    name: z.string(),
+    /**
+     * REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".
+     **/
+    in: z.enum(['query', 'header', 'path', 'cookie']),
+    /**
+     * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich
+     * text representation.
+     **/
+    description: z.string().optional(),
+    /**
+     * Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and
+     * its value MUST be true. Otherwise, the property MAY be included and its default value is false.
+     **/
+    required: z.boolean().optional(),
+    /**
+     * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
+     **/
+    deprecated: z.boolean().optional(),
+    /**
+     * Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a
+     * parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be
+     * serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is
+     * likely to be removed in a later revision.
+     **/
+    allowEmptyValue: z.boolean().optional(),
+    /**
+     * Describes how the parameter value will be serialized depending on the type of the parameter value. Default values
+     * (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.
+     **/
+    style: z.enum(['matrix', 'label', 'form', 'simple', 'spaceDelimited', 'pipeDelimited', 'deepObject']).optional(),
+    /**
+     * When this is true, parameter values of type array or object generate separate parameters for each value of the
+     * array or key-value pair of the map. For other types of parameters this property has no effect. When style is form,
+     * the default value is true. For all other styles, the default value is false. */
+    explode: z.boolean().optional(),
+    /**
+     * Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;=
+     * to be included without percent-encoding. This property only applies to parameters with an in value of query.
+     * The default value is false.
+     **/
+    allowReserved: z.boolean().optional(),
+    /**
+     * The schema defining the type used for the parameter.
+     **/
+    schema: SchemaObjectSchema.optional(),
+    /**
+     * Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties
+     * if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema
+     * that contains an example, the example value SHALL override the example provided by the schema. To represent
+     * examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the
+     * example with escaping where necessary.
+     **/
+    example: z.any().optional(),
+    /**
+     * 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(), 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/processed/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/processed/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/processed/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/processed/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 };