ParameterContract interface
Detalles de los parámetros de la operación.
Propiedades
| default |
Valor de parámetro predeterminado. |
| description | Descripción del parámetro. |
| examples | Se ha definido un ejemplo para el parámetro . |
| name | Nombre del parámetro. |
| required | Especifica si el parámetro es necesario o no. |
| schema |
Identificador de esquema. |
| type | Tipo de parámetro. |
| type |
Nombre de tipo definido por el esquema. |
| values | Valores de parámetro. |
Detalles de las propiedades
defaultValue
Valor de parámetro predeterminado.
defaultValue?: string
Valor de propiedad
string
description
Descripción del parámetro.
description?: string
Valor de propiedad
string
examples
Se ha definido un ejemplo para el parámetro .
examples?: {[propertyName: string]: ParameterExampleContract}
Valor de propiedad
{[propertyName: string]: ParameterExampleContract}
name
Nombre del parámetro.
name: string
Valor de propiedad
string
required
Especifica si el parámetro es necesario o no.
required?: boolean
Valor de propiedad
boolean
schemaId
Identificador de esquema.
schemaId?: string
Valor de propiedad
string
type
Tipo de parámetro.
type: string
Valor de propiedad
string
typeName
Nombre de tipo definido por el esquema.
typeName?: string
Valor de propiedad
string
values
Valores de parámetro.
values?: string[]
Valor de propiedad
string[]