RepresentationContract interface
Operation request/response representation details.
Properties
content |
Specifies a registered or custom content type for this representation, e.g. application/xml. |
examples | Exampled defined for the representation. |
form |
Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. |
schema |
Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. |
type |
Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. |
Property Details
contentType
Specifies a registered or custom content type for this representation, e.g. application/xml.
contentType: string
Property Value
string
examples
Exampled defined for the representation.
examples?: {[propertyName: string]: ParameterExampleContract}
Property Value
{[propertyName: string]: ParameterExampleContract}
formParameters
Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
formParameters?: ParameterContract[]
Property Value
schemaId
Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
schemaId?: string
Property Value
string
typeName
Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
typeName?: string
Property Value
string