Representación estructurada de una declaración de función según lo define la especificación de OpenAPI 3.0. Esta declaración incluye el nombre y los parámetros de la función. Este FunctionDeclaration es una representación de un bloque de código que el modelo puede usar como herramienta y que el cliente puede ejecutar.
Firma:
export declare interface FunctionDeclaration
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| description | cadena | Opcional. Descripción y propósito de la función. El modelo la usa para decidir si se debe llamar a la función y cómo hacerlo. |
| name | cadena | El nombre de la función a la que se llamará. Debe comenzar con una letra o un guion bajo. Debe ser a-z, A-Z, 0-9 o contener guiones bajos y guiones, con una longitud máxima de 64. |
| Parámetros | FunctionDeclarationSchema | Opcional. Describe los parámetros de esta función en formato de objeto de esquema JSON. Refleja el objeto de parámetro de Open API 3.03. Los nombres de parámetros distinguen mayúsculas de minúsculas. Para una función sin parámetros, esto no se puede configurar. |
FunctionDeclaration.description
Opcional. Descripción y propósito de la función. El modelo la usa para decidir si se debe llamar a la función y cómo hacerlo.
Firma:
description?: string;
FunctionDeclaration.name
El nombre de la función a la que se llamará. Debe comenzar con una letra o un guion bajo. Debe ser a-z, A-Z, 0-9 o contener guiones bajos y guiones, con una longitud máxima de 64.
Firma:
name: string;
FunctionDeclaration.parameters
Opcional. Describe los parámetros de esta función en formato de objeto de esquema JSON. Refleja el objeto de parámetro de Open API 3.03. Los nombres de parámetros distinguen mayúsculas de minúsculas. Para una función sin parámetros, esto no se puede configurar.
Firma:
parameters?: FunctionDeclarationSchema;