El esquema se usa para definir el formato de los datos de entrada y salida. Representa un subconjunto seleccionado de un objeto de esquema de OpenAPI 3.0. Es posible que se agreguen más campos en el futuro según sea necesario.
Firma:
export interface FunctionDeclarationSchemaProperty
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| description | cadena | Opcional. Es la descripción de la propiedad. |
| enum. | string[] | Opcional. La enumeración de la propiedad. |
| ejemplo | desconocido | Opcional. El ejemplo de la propiedad. |
| formato | cadena | Opcional. Es el formato de la propiedad. |
| elementos | FunctionDeclarationSchema | Opcional. Son los elementos de la propiedad. FunctionDeclarationSchema |
| nulable | boolean | Opcional. Si la propiedad es anulable. |
| propiedades | { [k: string]: FunctionDeclarationSchema; } | Opcional. Mapa de FunctionDeclarationSchema. |
| required | string[] | Opcional. Arreglo de propiedades requeridas. |
| tipo | FunctionDeclarationSchemaType. | Opcional. Es el tipo de propiedad. FunctionDeclarationSchemaType. |
FunctionDeclarationSchemaProperty.description.
Opcional. Es la descripción de la propiedad.
Firma:
description?: string;
FunctionDeclarationSchemaProperty.enum
Opcional. La enumeración de la propiedad.
Firma:
enum?: string[];
FunctionDeclarationSchemaProperty.example
Opcional. El ejemplo de la propiedad.
Firma:
example?: unknown;
FunctionDeclarationSchemaProperty.format.
Opcional. Es el formato de la propiedad.
Firma:
format?: string;
FunctionDeclarationSchemaProperty.items
Opcional. Son los elementos de la propiedad. FunctionDeclarationSchema
Firma:
items?: FunctionDeclarationSchema;
FunctionDeclarationSchemaProperty.nullable.
Opcional. Si la propiedad es anulable.
Firma:
nullable?: boolean;
FunctionDeclarationSchemaProperty.properties
Opcional. Mapa de FunctionDeclarationSchema.
Firma:
properties?: {
[k: string]: FunctionDeclarationSchema;
};
FunctionDeclarationSchemaProperty.required.
Opcional. Arreglo de propiedades requeridas.
Firma:
required?: string[];
FunctionDeclarationSchemaProperty.type.
Opcional. Es el tipo de propiedad. FunctionDeclarationSchemaType.
Firma:
type?: FunctionDeclarationSchemaType;