@scalar/openapi-types
Version:
Modern OpenAPI types
626 lines • 27.8 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", "label", "simple", "form", "spaceDelimited", "pipeDelimited", "deepObject"]>>;
explode: z.ZodOptional<z.ZodBoolean>;
schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>;
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>;
}, "strip", z.ZodTypeAny, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}>>>;
content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>;
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>;
}, "strip", z.ZodTypeAny, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
example?: any;
examples?: Record<string, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}> | undefined;
schema?: Record<string, any> | undefined;
}, {
example?: any;
examples?: Record<string, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}> | undefined;
schema?: Record<string, any> | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
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;
}, {
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;
}>>>;
content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>;
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>;
}, "strip", z.ZodTypeAny, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}>>>;
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", "label", "simple", "form", "spaceDelimited", "pipeDelimited", "deepObject"]>>;
explode: z.ZodOptional<z.ZodBoolean>;
schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>;
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>;
}, "strip", z.ZodTypeAny, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}>>>;
content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>;
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>;
}, "strip", z.ZodTypeAny, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
example?: any;
examples?: Record<string, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}> | undefined;
schema?: Record<string, any> | undefined;
}, {
example?: any;
examples?: Record<string, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}> | undefined;
schema?: Record<string, any> | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
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;
}, {
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;
}>>>;
}, "strip", z.ZodTypeAny, {
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;
}, {
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;
}>>>;
}, "strip", z.ZodTypeAny, {
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;
}, {
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;
}>>>;
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.ZodEffects<z.ZodString, string, string>>>;
requestBody: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
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, "many">>;
default: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
url: string;
description?: string | undefined;
variables?: Record<string, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}> | undefined;
}, {
url: string;
description?: string | undefined;
variables?: Record<string, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}> | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
description?: string | undefined;
operationId?: string | undefined;
parameters?: Record<string, string> | undefined;
requestBody?: string | undefined;
operationRef?: string | undefined;
server?: {
url: string;
description?: string | undefined;
variables?: Record<string, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}> | undefined;
} | undefined;
}, {
description?: string | undefined;
operationId?: string | undefined;
parameters?: Record<string, string> | undefined;
requestBody?: string | undefined;
operationRef?: string | undefined;
server?: {
url: string;
description?: string | undefined;
variables?: Record<string, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}> | undefined;
} | undefined;
}>>>;
}, "strip", z.ZodTypeAny, {
description: string;
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;
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;
links?: Record<string, {
description?: string | undefined;
operationId?: string | undefined;
parameters?: Record<string, string> | undefined;
requestBody?: string | undefined;
operationRef?: string | undefined;
server?: {
url: string;
description?: string | undefined;
variables?: Record<string, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}> | undefined;
} | undefined;
}> | undefined;
}, {
description: string;
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;
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;
links?: Record<string, {
description?: string | undefined;
operationId?: string | undefined;
parameters?: Record<string, string> | undefined;
requestBody?: string | undefined;
operationRef?: string | undefined;
server?: {
url: string;
description?: string | undefined;
variables?: Record<string, {
description?: string | undefined;
default?: string | undefined;
enum?: string[] | undefined;
}> | undefined;
} | undefined;
}> | undefined;
}>>;
//# sourceMappingURL=responses-object.d.ts.map