@scalar/openapi-types 0.1.9 → 0.2.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"responses-object.d.ts","sourceRoot":"","sources":["../../../../src/schemas/3.1/unprocessed/responses-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAWjC,CAAA"}

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

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+import { ReferenceObjectSchema } from './reference-object.js';
+import { ResponseObjectSchema } from './response-object.js';
+
+/**
+ * Responses Object
+ *
+ * A container for the expected responses of an operation. The container maps a HTTP response code to the expected
+ * response.
+ *
+ * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known
+ *  in advance. However, documentation is expected to cover a successful operation response and any known errors.
+ * The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the
+ * Responses Object.
+ *
+ * The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be
+ * the response for a successful operation call.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#responses-object
+ */
+const ResponsesObjectSchema = z.record(
+/**
+ * Response Object | Reference Object	Any HTTP status code can be used as the property name, but only one property per
+ *  code, to describe the expected response for that HTTP status code. This field MUST be enclosed in quotation marks
+ * (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY
+ * contain the uppercase wildcard character X. For example, 2XX represents all response codes between 200 and 299.
+ * Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX. If a response is defined using an
+ * explicit code, the explicit code definition takes precedence over the range definition for that code.
+ */
+z.string(), z.union([ReferenceObjectSchema, ResponseObjectSchema]));
+
+export { ResponsesObjectSchema };

package/dist/schemas/3.1/unprocessed/runtime-expression.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Runtime Expression Schema
+ *
+ * Runtime expressions allow defining values based on information that will only be available within the HTTP message in
+ * an actual API call. This mechanism is used by Link Objects and Callback Objects.
+ *
+ * Expressions can be:
+ * 1. Pure runtime expressions starting with $ (e.g. $method, $request.path.id)
+ * 2. Embedded expressions in strings using curly braces (e.g. "Hello {$request.body#/name}!")
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#runtime-expressions
+ */
+export declare const RuntimeExpressionSchema: import("zod").ZodEffects<import("zod").ZodString, string, string>;
+//# sourceMappingURL=runtime-expression.d.ts.map

package/dist/schemas/3.1/unprocessed/runtime-expression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-expression.d.ts","sourceRoot":"","sources":["../../../../src/schemas/3.1/unprocessed/runtime-expression.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uBAAuB,mEAAkC,CAAA"}

package/dist/schemas/3.1/unprocessed/runtime-expression.js

@@ -0,0 +1,17 @@
+import { RuntimeExpressionSchema as RuntimeExpressionSchema$1 } from '../processed/runtime-expression.js';
+
+/**
+ * Runtime Expression Schema
+ *
+ * Runtime expressions allow defining values based on information that will only be available within the HTTP message in
+ * an actual API call. This mechanism is used by Link Objects and Callback Objects.
+ *
+ * Expressions can be:
+ * 1. Pure runtime expressions starting with $ (e.g. $method, $request.path.id)
+ * 2. Embedded expressions in strings using curly braces (e.g. "Hello {$request.body#/name}!")
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#runtime-expressions
+ */
+const RuntimeExpressionSchema = RuntimeExpressionSchema$1;
+
+export { RuntimeExpressionSchema };

package/dist/schemas/3.1/unprocessed/schema-object.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+/**
+ * The Schema Object with reference fields.
+ * This extends the base Schema Object to include reference-related fields
+ * that are processed differently in the unprocessed schema.
+ */
+export declare const SchemaObjectSchema: z.ZodType<any>;
+//# sourceMappingURL=schema-object.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schema-object.d.ts","sourceRoot":"","sources":["../../../../src/schemas/3.1/unprocessed/schema-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CA0B7C,CAAA"}

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

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+import { SchemaObjectSchema as SchemaObjectSchema$1 } from '../processed/schema-object.js';
+import { ReferenceObjectSchema } from './reference-object.js';
+
+/**
+ * The Schema Object with reference fields.
+ * This extends the base Schema Object to include reference-related fields
+ * that are processed differently in the unprocessed schema.
+ */
+const SchemaObjectSchema = z.lazy(() => z.intersection(SchemaObjectSchema$1, z.object({
+    // Reference-related fields
+    $ref: z.string().optional(),
+    $id: z.string().optional(),
+    $schema: z.string().optional(),
+    $defs: z.record(z.lazy(() => SchemaObjectSchema)).optional(),
+    $dynamicRef: z.string().optional(),
+    $dynamicAnchor: z.string().optional(),
+    // Override the recursive fields to use this schema instead of the original
+    properties: z.record(z.string(), z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema])).optional(),
+    additionalProperties: z.union([z.boolean(), z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema]).optional(),
+    patternProperties: z
+        .record(z.string(), z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema]))
+        .optional(),
+    items: z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema]).optional(),
+    prefixItems: z.array(z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema])).optional(),
+    allOf: z.array(z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema])).optional(),
+    oneOf: z.array(z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema])).optional(),
+    anyOf: z.array(z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema])).optional(),
+    not: z.union([z.lazy(() => SchemaObjectSchema), ReferenceObjectSchema]).optional(),
+})));
+
+export { SchemaObjectSchema };

package/dist/schemas/3.1/unprocessed/security-requirement-object.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Security Requirement Object
+ *
+ * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a
+ * security scheme declared in the Security Schemes under the Components Object.
+ *
+ * A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for
+ * a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are
+ * required to convey security information.
+ *
+ * When the security field is defined on the OpenAPI Object or Operation Object and contains multiple Security
+ * Requirement Objects, only one of the entries in the list needs to be satisfied to authorize the request. This
+ * enables support for scenarios where the API allows multiple, independent security schemes.
+ *
+ * An empty Security Requirement Object ({}) indicates anonymous access is supported.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#security-requirement-object
+ */
+export declare const SecurityRequirementObjectSchema: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodArray<import("zod").ZodString, "many">>;
+//# sourceMappingURL=security-requirement-object.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"security-requirement-object.d.ts","sourceRoot":"","sources":["../../../../src/schemas/3.1/unprocessed/security-requirement-object.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,+BAA+B,2GAA0C,CAAA"}

package/dist/schemas/3.1/unprocessed/security-requirement-object.js

@@ -0,0 +1,23 @@
+import { SecurityRequirementObjectSchema as SecurityRequirementObjectSchema$1 } from '../processed/security-requirement-object.js';
+
+/**
+ * Security Requirement Object
+ *
+ * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a
+ * security scheme declared in the Security Schemes under the Components Object.
+ *
+ * A Security Requirement Object MAY refer to multiple security schemes in which case all schemes MUST be satisfied for
+ * a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are
+ * required to convey security information.
+ *
+ * When the security field is defined on the OpenAPI Object or Operation Object and contains multiple Security
+ * Requirement Objects, only one of the entries in the list needs to be satisfied to authorize the request. This
+ * enables support for scenarios where the API allows multiple, independent security schemes.
+ *
+ * An empty Security Requirement Object ({}) indicates anonymous access is supported.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#security-requirement-object
+ */
+const SecurityRequirementObjectSchema = SecurityRequirementObjectSchema$1;
+
+export { SecurityRequirementObjectSchema };