Class ResponseShape

[[include:responses/responseUtil.md]]

Hierarchy (view full)

Constructors

Properties

code?: number
content?: Record<string, MediaTypeObject>
default?: boolean
description?: string
headers?: Record<string, ReferenceObject | HeaderObject>
links?: Record<string, ReferenceObject | LinkObject>
name: string
ref?: string

Methods

  • Returns undefined | number

  • Returns undefined | string

  • Returns string

  • Returns undefined | string

  • Returns boolean

  • Parameters

    • key: string

    Returns undefined | ReferenceObject | HeaderObject

  • Returns undefined | Record<string, ReferenceObject | HeaderObject>

  • Parameters

    • key: string

    Returns undefined | ReferenceObject | LinkObject

  • Returns undefined | Record<string, ReferenceObject | LinkObject>

  • Parameters

    • contentType: string

    Returns undefined | MediaTypeObject

  • Returns undefined | Record<string, MediaTypeObject>

  • Returns undefined | string

  • Parameters

    • description: string

      A short description of the response. CommonMark syntax MAY be used for rich text representation.

    Returns ResponseUtil

  • Parameters

    • headers: Record<string, ReferenceObject | HeaderObject>

    Returns ResponseUtil

  • Parameters

    • links: Record<string, ReferenceObject | LinkObject>

    Returns ResponseUtil

  • Returns Record<string, ReferenceObject | ResponseObject>

  • Parameters

    Returns Record<string, ReferenceObject | ResponseObject>

  • Returns ResponseObject[]

  • Parameters

    • ctxt: IPostmanResponseContext

    Returns ResponseObject[]