Representação estruturada de uma declaração de função, conforme definido pela especificação OpenAPI 3.0. Essa declaração inclui 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 uma 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. O modelo a usa para decidir como e se chamar a função. |
| name | string | O nome da função a ser chamada. Precisa começar com uma letra ou um sublinhado. Precisa ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com comprimento máximo de 64. |
| parameters | FunctionDeclarationSchema (link em inglês) | Opcional. Descreve os parâmetros para esta função no formato Objeto de esquema JSON. Reflete o objeto de parâmetro da OpenAPI 3.03. Os nomes dos parâmetros diferenciam maiúsculas de minúsculas. Para uma função sem parâmetros, esta opção pode ser deixada sem definição. |
FunctionDeclaration.description
Opcional. Descrição e propósito da função. O modelo a usa para decidir como e se chamar a função.
Assinatura:
description?: string;
FunçãoDeclaration.name
O nome da função a ser chamada. Precisa começar com uma letra ou um sublinhado. Precisa ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com comprimento máximo de 64.
Assinatura:
name: string;
FunctionDeclaration.parameters
Opcional. Descreve os parâmetros para esta função no formato Objeto de esquema JSON. Reflete o objeto de parâmetro da OpenAPI 3.03. Os nomes dos parâmetros diferenciam maiúsculas de minúsculas. Para uma função sem parâmetros, esta opção pode ser deixada sem definição.
Assinatura:
parameters?: FunctionDeclarationSchema;