@scalar/openapi-types
Version:
Modern OpenAPI types
116 lines • 6.07 kB
TypeScript
import { z } from 'zod';
/**
* 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
*/
export declare const ResponsesObjectSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
description: z.ZodString;
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
description: z.ZodOptional<z.ZodString>;
required: z.ZodOptional<z.ZodBoolean>;
deprecated: z.ZodOptional<z.ZodBoolean>;
style: z.ZodOptional<z.ZodEnum<{
matrix: "matrix";
label: "label";
form: "form";
simple: "simple";
spaceDelimited: "spaceDelimited";
pipeDelimited: "pipeDelimited";
deepObject: "deepObject";
}>>;
explode: z.ZodOptional<z.ZodBoolean>;
schema: z.ZodOptional<z.ZodType<Record<string, any>, unknown, z.core.$ZodTypeInternals<Record<string, any>, unknown>>>;
example: z.ZodOptional<z.ZodAny>;
examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
summary: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
value: z.ZodOptional<z.ZodAny>;
externalValue: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
schema: z.ZodOptional<z.ZodType<Record<string, any>, unknown, z.core.$ZodTypeInternals<Record<string, any>, unknown>>>;
example: z.ZodOptional<z.ZodAny>;
examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
summary: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
value: z.ZodOptional<z.ZodAny>;
externalValue: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
schema: z.ZodOptional<z.ZodType<Record<string, any>, unknown, z.core.$ZodTypeInternals<Record<string, any>, unknown>>>;
example: z.ZodOptional<z.ZodAny>;
examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
summary: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
value: z.ZodOptional<z.ZodAny>;
externalValue: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
encoding: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
contentType: z.ZodString;
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
description: z.ZodOptional<z.ZodString>;
required: z.ZodOptional<z.ZodBoolean>;
deprecated: z.ZodOptional<z.ZodBoolean>;
style: z.ZodOptional<z.ZodEnum<{
matrix: "matrix";
label: "label";
form: "form";
simple: "simple";
spaceDelimited: "spaceDelimited";
pipeDelimited: "pipeDelimited";
deepObject: "deepObject";
}>>;
explode: z.ZodOptional<z.ZodBoolean>;
schema: z.ZodOptional<z.ZodType<Record<string, any>, unknown, z.core.$ZodTypeInternals<Record<string, any>, unknown>>>;
example: z.ZodOptional<z.ZodAny>;
examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
summary: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
value: z.ZodOptional<z.ZodAny>;
externalValue: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
schema: z.ZodOptional<z.ZodType<Record<string, any>, unknown, z.core.$ZodTypeInternals<Record<string, any>, unknown>>>;
example: z.ZodOptional<z.ZodAny>;
examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
summary: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
value: z.ZodOptional<z.ZodAny>;
externalValue: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
operationRef: z.ZodOptional<z.ZodString>;
operationId: z.ZodOptional<z.ZodString>;
parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
requestBody: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
server: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
description: z.ZodOptional<z.ZodString>;
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
default: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
//# sourceMappingURL=responses-object.d.ts.map