ParameterContract interface
Detalhes dos parâmetros de operação.
Propriedades
default |
Valor do parâmetro predefinido. |
description | Descrição do parâmetro. |
examples | Exemplo definido para o parâmetro. |
name | Nome do parâmetro. |
required | Especifica se o parâmetro é necessário ou não. |
schema |
Identificador de esquema. |
type | Tipo de parâmetro. |
type |
Escreva o nome definido pelo esquema. |
values | Valores de parâmetros. |
Detalhes de Propriedade
defaultValue
Valor do parâmetro predefinido.
defaultValue?: string
Valor de Propriedade
string
description
Descrição do parâmetro.
description?: string
Valor de Propriedade
string
examples
Exemplo definido para o parâmetro.
examples?: {[propertyName: string]: ParameterExampleContract}
Valor de Propriedade
{[propertyName: string]: ParameterExampleContract}
name
Nome do parâmetro.
name: string
Valor de Propriedade
string
required
Especifica se o parâmetro é necessário ou não.
required?: boolean
Valor de Propriedade
boolean
schemaId
Identificador de esquema.
schemaId?: string
Valor de Propriedade
string
type
Tipo de parâmetro.
type: string
Valor de Propriedade
string
typeName
Escreva o nome definido pelo esquema.
typeName?: string
Valor de Propriedade
string
values
Valores de parâmetros.
values?: string[]
Valor de Propriedade
string[]