Schemat służy do definiowania formatu danych wejściowych/wyjściowych. Reprezentuje wybrany podzbiór obiektu schematu OpenAPI 3.0. W przyszłości możemy dodać więcej pól.
Podpis:
export interface FunctionDeclarationSchemaProperty
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| description | ciąg znaków | Opcjonalnie. Opis nieruchomości. |
| wyliczenie | ciąg znaków[] | Opcjonalnie. Wyliczenie właściwości. |
| przykład | nieznany | Opcjonalnie. Przykład właściwości. |
| format | ciąg znaków | Opcjonalnie. Format właściwości. |
| items | Schemat deklaracji funkcji | Opcjonalnie. Elementy usługi. Schemat deklaracji funkcji |
| dopuszczalna wartość null | wartość logiczna | Opcjonalnie. Wskazuje, czy właściwość może mieć wartość null. |
| usługi | { [k: string]: FunctionDeklaracjaSchema; | Opcjonalnie. Mapa obiektu FunctionDetectationSchema. |
| wymagane | ciąg znaków[] | Opcjonalnie. Tablica wymaganej właściwości. |
| type | FunctionDeklaracjaSchemaType | Opcjonalnie. Typ usługi. FunctionDeklaracjaSchemaType. |
DeklaracjaSchemat_funkcji.opis
Opcjonalnie. Opis nieruchomości.
Podpis:
description?: string;
DeklaracjaSchematFunkcji.enum
Opcjonalnie. Wyliczenie właściwości.
Podpis:
enum?: string[];
Obiekt schematu deklaracji funkcji.przykład
Opcjonalnie. Przykład właściwości.
Podpis:
example?: unknown;
DeklaracjaSchemat_funkcji.format
Opcjonalnie. Format właściwości.
Podpis:
format?: string;
DeklaracjaSchemat_funkcji.elementy
Opcjonalnie. Elementy usługi. Schemat deklaracji funkcji
Podpis:
items?: FunctionDeclarationSchema;
DeklaracjaSchemat_funkcji.nullable
Opcjonalnie. Wskazuje, czy właściwość może mieć wartość null.
Podpis:
nullable?: boolean;
DeklaracjaSchemat_funkcji.properties
Opcjonalnie. Mapa obiektu FunctionDetectationSchema.
Podpis:
properties?: {
[k: string]: FunctionDeclarationSchema;
};
DeklaracjaSchemat_funkcji.wymagany
Opcjonalnie. Tablica wymaganej właściwości.
Podpis:
required?: string[];
DeklaracjaSchemat_funkcji.type
Opcjonalnie. Typ usługi. FunctionDeklaracjaSchemaType.
Podpis:
type?: FunctionDeclarationSchemaType;