Responses

class Responses(d: dict[str, Any] = None, default: Response | Reference = None, codes: dict[str, Response | Reference] = None)

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.

The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.

The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.

The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.

— NOTE: Due to the nature of this type developers accessing this type should prefer indexer syntax, as if it were a dictionary of Response|Reference types.

property default: Response | Reference | None

The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses.

get(key: str, default: Response | Reference | None = None) → Response | Reference | None

Gets the value for the given key.