import type { ReferenceObject } from './reference.js'
import type { ResponseObject } from './response.js'
/**
 * Responses object
 *
 * 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.
 *
 * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#responses-object}
 */
export type ResponsesObject = {
  /** The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. */
  default?: ResponseObject | ReferenceObject
} & {
  /** A map of status codes to response objects. */
  [statusCode: string]: ResponseObject | ReferenceObject
} & Record<`x-${string}`, unknown>