Representação estruturada de uma declaração de função, conforme definido pela especificação OpenAPI 3.0. Incluídos nessa declaração estão o nome e os parâmetros da função. Esse FunctionDeclaration é uma representação de um bloco de código que pode ser usado como ferramenta pelo modelo e executado pelo cliente.
Assinatura:
export declare interface FunctionDeclaration
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| description | string | Opcional. Descrição e propósito da função. Ele é usado pelo modelo para decidir como e se a função será chamada. |
| name | string | O nome da função a ser chamada. Precisa começar com uma letra ou um sublinhado. Precisa ser de a-z, A-Z, 0-9 ou conter sublinhados e traços, com um tamanho máximo de 64. |
| parameters | FunctionDeclarationSchema (link em inglês) | Opcional. Descreve os parâmetros para essa função no formato de objeto de esquema JSON. Reflete o objeto de parâmetro da Open API 3.03. Os nomes dos parâmetros diferenciam maiúsculas de minúsculas. Para uma função sem parâmetros, isso pode ser deixado sem definição. |
FunctionDeclaration.description
Opcional. Descrição e propósito da função. Ele é usado pelo modelo para decidir como e se a função será chamada.
Assinatura:
description?: string;
FunctionDeclaration.name.
O nome da função a ser chamada. Precisa começar com uma letra ou um sublinhado. Precisa ser de a-z, A-Z, 0-9 ou conter sublinhados e traços, com um tamanho máximo de 64.
Assinatura:
name: string;
FunctionDeclaration.parameters
Opcional. Descreve os parâmetros para essa função no formato de objeto de esquema JSON. Reflete o objeto de parâmetro da Open API 3.03. Os nomes dos parâmetros diferenciam maiúsculas de minúsculas. Para uma função sem parâmetros, isso pode ser deixado sem definição.
Assinatura:
parameters?: FunctionDeclarationSchema;