Class ResponseUtil

{@include ../../../typedocIncludes/responses/responseUtil.md}

Hierarchy (View Summary)

Constructors

constructor

Properties

code? content? default? description? headers? links? name ref?

Methods

addHeader addLink addMediaType getCode getDescription getName getRef isDefault removeHeader removeHeaders removeLink removeLinks removeMediaType removeMediaTypes removeRef setCode setDefault setDescription setHeaders setLinks setMediaTypes setName setRef toOpenAPI toPostman

Constructors

constructor

  • new ResponseUtil(name?: string): ResponseUtil

  • Parameters

    • Optionalname: string

    Returns ResponseUtil

Properties

Protected Optionalcode

code?: number

Protected Optionalcontent

content?: Record<string, MediaTypeObject>

Protected Optionaldefault

default?: boolean

Protected Optionaldescription

description?: string

Protected Optionalheaders

headers?: Record<string, ReferenceObject | HeaderObject>

Protected Optionallinks

links?: Record<string, ReferenceObject | LinkObject>

Protectedname

name: string

Protected Optionalref

ref?: string

Methods

addHeader

  • addHeader(key: string, header: HeaderObject): ResponseUtil

  • Parameters

    • key: string
    • header: HeaderObject

    Returns ResponseUtil

  • addHeader(key: string, header: ReferenceObject): ResponseUtil

  • Parameters

    • key: string
    • header: ReferenceObject

    Returns ResponseUtil

  • addHeader(key: string): ResponseUtil

  • Parameters

    • key: string

    Returns ResponseUtil

addLink

  • addLink(key: string, link: LinkObject): ResponseUtil

  • Parameters

    • key: string
    • link: LinkObject

    Returns ResponseUtil

  • addLink(key: string, link: ReferenceObject): ResponseUtil

  • Parameters

    • key: string
    • link: ReferenceObject

    Returns ResponseUtil

  • addLink(key: string): ResponseUtil

  • Parameters

    • key: string

    Returns ResponseUtil

addMediaType

  • addMediaType(contentType: string, mediaType: MediaTypeObject): ResponseUtil

  • Parameters

    • contentType: string
    • mediaType: MediaTypeObject

    Returns ResponseUtil

  • addMediaType(contentType: string, mediaType: MediaTypeUtil): ResponseUtil

  • Parameters

    Returns ResponseUtil

  • addMediaType(contentType: string): ResponseUtil

  • Parameters

    • contentType: string

    Returns ResponseUtil

getCode

  • getCode(): undefined | number

  • Returns undefined | number

getDescription

  • getDescription(): undefined | string

  • Returns undefined | string

getName

  • getName(): string

  • Returns string

getRef

  • getRef(): undefined | string

  • Returns undefined | string

isDefault

  • isDefault(): boolean

  • Returns boolean

removeHeader

  • removeHeader(key: string): undefined | ReferenceObject | HeaderObject

  • Parameters

    • key: string

    Returns undefined | ReferenceObject | HeaderObject

removeHeaders

  • removeHeaders(): undefined | Record<string, ReferenceObject | HeaderObject>

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

removeLink

  • removeLink(key: string): undefined | ReferenceObject | LinkObject

  • Parameters

    • key: string

    Returns undefined | ReferenceObject | LinkObject

removeLinks

  • removeLinks(): undefined | Record<string, ReferenceObject | LinkObject>

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

removeMediaType

  • removeMediaType(contentType: string): undefined | MediaTypeObject

  • Parameters

    • contentType: string

    Returns undefined | MediaTypeObject

removeMediaTypes

  • removeMediaTypes(): undefined | Record<string, MediaTypeObject>

  • Returns undefined | Record<string, MediaTypeObject>

removeRef

  • removeRef(): undefined | string

  • Returns undefined | string

setCode

  • setCode(code: number): ResponseUtil

  • Parameters

    • code: number

    Returns ResponseUtil

setDefault

  • setDefault(isDefault: boolean): ResponseUtil

  • Parameters

    • isDefault: boolean

    Returns ResponseUtil

setDescription

  • setDescription(description: string): ResponseUtil

  • Parameters

    • description: string

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

    Returns ResponseUtil

setHeaders

  • setHeaders(
        headers: Record<string, ReferenceObject | HeaderObject>,
    ): ResponseUtil

  • Parameters

    • headers: Record<string, ReferenceObject | HeaderObject>

    Returns ResponseUtil

setLinks

  • setLinks(links: Record<string, ReferenceObject | LinkObject>): ResponseUtil

  • Parameters

    • links: Record<string, ReferenceObject | LinkObject>

    Returns ResponseUtil

setMediaTypes

  • setMediaTypes(mediaTypes: Record<string, MediaTypeObject>): ResponseUtil

  • Parameters

    • mediaTypes: Record<string, MediaTypeObject>

    Returns ResponseUtil

setName

  • setName(name: string): ResponseUtil

  • Parameters

    • name: string

    Returns ResponseUtil

setRef

  • setRef(ref: string): ResponseUtil

  • Parameters

    • ref: string

    Returns ResponseUtil

toOpenAPI

  • toOpenAPI(): Record<string, ReferenceObject | ResponseObject>

  • Returns Record<string, ReferenceObject | ResponseObject>

  • toOpenAPI(
        ctxt: IOpenAPIResponseContext,
    ): Record<string, ReferenceObject | ResponseObject>

  • Parameters

    Returns Record<string, ReferenceObject | ResponseObject>

toPostman

  • toPostman(): ResponseObject[]

  • Returns ResponseObject[]

  • toPostman(ctxt: IPostmanResponseContext): ResponseObject[]

  • Parameters

    • ctxt: IPostmanResponseContext

    Returns ResponseObject[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods