@scalar/openapi-types
Version:
Modern OpenAPI types
66 lines • 2.71 kB
TypeScript
/**
* Info Object
*
* The object provides metadata about the API. The metadata MAY be used by the clients if needed,
* and MAY be presented in editing or documentation generation tools for convenience.
*
* @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#info-object
*/
export declare const InfoObjectSchema: import("zod").ZodObject<{
title: import("zod").ZodCatch<import("zod").ZodString>;
summary: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
description: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
termsOfService: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
contact: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodObject<{
name: import("zod").ZodOptional<import("zod").ZodString>;
url: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
email: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
}, "strip", import("zod").ZodTypeAny, {
url?: string | undefined;
name?: string | undefined;
email?: string | undefined;
}, {
url?: unknown;
name?: string | undefined;
email?: unknown;
}>>>;
license: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodObject<{
name: import("zod").ZodCatch<import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>>;
identifier: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
url: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
}, "strip", import("zod").ZodTypeAny, {
url?: string | undefined;
name?: string | null | undefined;
identifier?: string | undefined;
}, {
url?: unknown;
name?: unknown;
identifier?: unknown;
}>>>;
version: import("zod").ZodCatch<import("zod").ZodString>;
}, "strip", import("zod").ZodTypeAny, {
title: string;
version: string;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
url?: string | undefined;
name?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
url?: string | undefined;
name?: string | null | undefined;
identifier?: string | undefined;
} | undefined;
summary?: string | undefined;
}, {
title?: unknown;
description?: unknown;
termsOfService?: unknown;
contact?: unknown;
license?: unknown;
version?: unknown;
summary?: unknown;
}>;
//# sourceMappingURL=info-object.d.ts.map