Schemat służy do określania formatu danych wejściowych i wyjściowych. Reprezentuje wybrany podzbiór obiektu schematu OpenAPI 3.0. W przyszłości można dodać więcej pól.
Podpis:
export interface FunctionDeclarationSchemaProperty
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| description | string, | Opcjonalnie. Opis nieruchomości. |
| wyliczenie | string[] | Opcjonalnie. Wyliczenie właściwości. |
| przykład | brak informacji | Opcjonalnie. Przykład właściwości. |
| format | string, | Opcjonalnie. Format właściwości. |
| items | FunctionDeklaracjaSchema | Opcjonalnie. Elementy właściwości. FunctionDeklaracjaSchema |
| z wartością null (wartość null) | boolean, | Opcjonalnie. Wskazuje, czy właściwość może mieć wartość null. |
| właściwości | { [k: string]: FunctionDefinitionSchema; } | Opcjonalnie. Mapa elementu FunctionDefinitionSchema. |
| wymagane | string[] | Opcjonalnie. Tablica wymaganych właściwości. |
| type | FunctionDefinitionationSchemaType, | Opcjonalnie. Typ nieruchomości. FunctionDeklaracjaSchemaType. |
FunctionIndexationSchemaProperty.description
Opcjonalnie. Opis nieruchomości.
Podpis:
description?: string;
FunctionIndexationSchemaProperty.enum
Opcjonalnie. Wyliczenie właściwości.
Podpis:
enum?: string[];
Deklaracja FunkcjiSchemaProperty.example
Opcjonalnie. Przykład właściwości.
Podpis:
example?: unknown;
FunctionIndexationSchemaProperty.format
Opcjonalnie. Format właściwości.
Podpis:
format?: string;
FunctionIndexationSchemaProperty.items
Opcjonalnie. Elementy właściwości. FunctionDeklaracjaSchema
Podpis:
items?: FunctionDeclarationSchema;
FunctionIndexationSchemaProperty.nullable
Opcjonalnie. Wskazuje, czy właściwość może mieć wartość null.
Podpis:
nullable?: boolean;
FunctionIndexationSchemaProperty.properties
Opcjonalnie. Mapa elementu FunctionDefinitionSchema.
Podpis:
properties?: {
[k: string]: FunctionDeclarationSchema;
};
FunctionDeklaracjaSchemaProperty.wymagane
Opcjonalnie. Tablica wymaganych właściwości.
Podpis:
required?: string[];
FunctionIndexationSchemaProperty.type
Opcjonalnie. Typ nieruchomości. FunctionDeklaracjaSchemaType.
Podpis:
type?: FunctionDeclarationSchemaType;