Uporządkowana deklaracja funkcji zgodnie z definicją w specyfikacji OpenAPI 3.0. Deklaracja zawiera nazwę funkcji i jej parametry. Ten element FunctionDeclaration to blok kodu, którego model może użyć jako narzędzia i wykonać go przez klienta.
Podpis:
export declare interface FunctionDeclaration
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| description | string, | Opcjonalnie. Opis i przeznaczenie funkcji. Na jego podstawie model decyduje, czy i jak wywołać tę funkcję. |
| name | string, | Nazwa funkcji do wywołania. Musi zaczynać się od litery lub podkreślenia. Nazwa musi należeć do zakresu a–z, A–Z, 0–9 lub zawierać podkreślenia i myślniki o maksymalnej długości 64 znaków. |
| parametry | FunctionDeklaracjaSchema | Opcjonalnie. Opisuje parametry tej funkcji w formacie obiektu schematu JSON. Odzwierciedla obiekt parametru Open API 3.03. W nazwach parametrów wielkość liter ma znaczenie. W przypadku funkcji bez parametrów to pole może być nieskonfigurowane. |
Deklaracja funkcji.opis
Opcjonalnie. Opis i przeznaczenie funkcji. Na jego podstawie model decyduje, czy i jak wywołać tę funkcję.
Podpis:
description?: string;
Deklaracja_funkcji.nazwa
Nazwa funkcji do wywołania. Musi zaczynać się od litery lub podkreślenia. Nazwa musi należeć do zakresu a–z, A–Z, 0–9 lub zawierać podkreślenia i myślniki o maksymalnej długości 64 znaków.
Podpis:
name: string;
Deklaracja_funkcji.parametry
Opcjonalnie. Opisuje parametry tej funkcji w formacie obiektu schematu JSON. Odzwierciedla obiekt parametru Open API 3.03. W nazwach parametrów wielkość liter ma znaczenie. W przypadku funkcji bez parametrów to pole może być nieskonfigurowane.
Podpis:
parameters?: FunctionDeclarationSchema;