[I] OpenAPI2Response
Describes a single response from an API Operation.
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#response-object
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
description | string | A short description of the response. Commonmark syntax can be used for rich text representation |
examples? | Record<string, OpenAPI2Example> | An example of the response message. |
headers? | Record<string, OpenAPI2HeaderDefinition> | A list of headers that are sent with the response. |
schema? | | OpenAPI2Schema | OpenAPI2FileSchema | A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be “file”. This SHOULD be accompanied by a relevant produces mime-type. |
x-ms-error-response? | boolean | Indicates whether the response status code should be treated as an error response. |