@scalar/openapi-types
Version:
Modern OpenAPI types
28 lines • 1.21 kB
TypeScript
/**
* Example Object
*
* An object grouping an internal or external example value with basic summary and description metadata. This object is
* typically used in fields named examples (plural), and is a referenceable alternative to older example (singular)
* fields that do not support referencing or metadata.
*
* Examples allow demonstration of the usage of properties, parameters and objects within OpenAPI.
*
* @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#example-object
*/
export declare const ExampleObjectSchema: import("zod").ZodObject<{
summary: import("zod").ZodOptional<import("zod").ZodString>;
description: import("zod").ZodOptional<import("zod").ZodString>;
value: import("zod").ZodOptional<import("zod").ZodAny>;
externalValue: import("zod").ZodOptional<import("zod").ZodString>;
}, "strip", import("zod").ZodTypeAny, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}, {
description?: string | undefined;
summary?: string | undefined;
value?: any;
externalValue?: string | undefined;
}>;
//# sourceMappingURL=example-object.d.ts.map