Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RepresentationContract

Package version

Operation request/response representation details.

Hierarchy

  • RepresentationContract

Index

Properties

contentType

contentType: string

Specifies a registered or custom content type for this representation, e.g. application/xml.

Optional examples

examples: undefined | {}

Exampled defined for the representation.

Optional formParameters

formParameters: ParameterContract[]

Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..

Optional schemaId

schemaId: undefined | string

Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

Optional typeName

typeName: undefined | string

Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

Generated using TypeDoc