Uporządkowane przedstawienie deklaracji funkcji zgodnie ze specyfikacją OpenAPI 3.0. Ta deklaracja zawiera nazwę funkcji i jej parametry. Ten element FunctionDeclaration to reprezentacja bloku kodu, który może być używany przez model jako narzędzie i wykonywany przez klienta.
Podpis:
export declare interface FunctionDeclaration
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| description | ciąg znaków | Opcjonalnie. Opis i przeznaczenie funkcji. Model używa go do określenia, czy i w jaki sposób wywołać tę funkcję. |
| name | ciąg znaków | Nazwa funkcji do wywołania. Musi zaczynać się od litery lub podkreślenia. Nazwa musi mieć format a–z, A–Z lub 0–9 albo zawierać podkreślenia i myślniki o maksymalnej długości 64 znaki. |
| parametry | Schemat deklaracji funkcji | Opcjonalnie. Opisuje parametry tej funkcji w formacie obiektu schematu JSON. Odzwierciedla obiekt parametru Open API 3.03. W nazwach parametrów rozróżniana jest wielkość liter. W przypadku funkcji bez parametrów ta wartość może być nieskonfigurowana. |
Deklaracja funkcji.opis
Opcjonalnie. Opis i przeznaczenie funkcji. Model używa go do określenia, czy i w jaki sposób 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 mieć format a–z, A–Z lub 0–9 albo zawierać podkreślenia i myślniki o maksymalnej długości 64 znaki.
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 rozróżniana jest wielkość liter. W przypadku funkcji bez parametrów ta wartość może być nieskonfigurowana.
Podpis:
parameters?: FunctionDeclarationSchema;