Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParameterContract

Package version

Operation parameters details.

Hierarchy

  • ParameterContract

Index

Properties

Properties

Optional defaultValue

defaultValue: undefined | string

Default parameter value.

Optional description

description: undefined | string

Parameter description.

Optional examples

examples: undefined | {}

Exampled defined for the parameter.

name

name: string

Parameter name.

Optional required

required: undefined | false | true

Specifies whether parameter is required or not.

Optional schemaId

schemaId: undefined | string

Schema identifier.

type

type: string

Parameter type.

Optional typeName

typeName: undefined | string

Type name defined by the schema.

Optional values

values: string[]

Parameter values.

Generated using TypeDoc