Class ContextResponseUtil

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

Hierarchy (View Summary)

Constructors

constructor

Properties

code? default? links? ref? responseUtil

Methods

addLink getCode getRef isDefault removeCode removeLink removeLinks removeRef setCode setDefault setLinks setRef toOpenAPI toPostman

Constructors

constructor

  • new ContextResponseUtil(responseUtil: BaseResponseUtil): ContextResponseUtil

  • Parameters

    • responseUtil: BaseResponseUtil

    Returns ContextResponseUtil

Properties

Protected Optionalcode

code?: number

Protected Optionaldefault

default?: boolean

Protected Optionallinks

links?: Record<string, ReferenceObject | LinkObject>

Protected Optionalref

ref?: string

ProtectedresponseUtil

responseUtil: BaseResponseUtil

Methods

addLink

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

  • Parameters

    • key: string
    • link: LinkObject

    Returns ContextResponseUtil

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

  • Parameters

    • key: string
    • link: ReferenceObject

    Returns ContextResponseUtil

  • addLink(key: string): ContextResponseUtil

  • Parameters

    • key: string

    Returns ContextResponseUtil

getCode

  • getCode(): undefined | number

  • Returns undefined | number

getRef

  • getRef(): undefined | string

  • Returns undefined | string

isDefault

  • isDefault(): boolean

  • Returns boolean

removeCode

  • removeCode(): undefined | number

  • Returns undefined | number

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>

removeRef

  • removeRef(): undefined | string

  • Returns undefined | string

setCode

  • setCode(code: number): ContextResponseUtil

  • Parameters

    • code: number

    Returns ContextResponseUtil

setDefault

  • setDefault(isDefault: boolean): ContextResponseUtil

  • Parameters

    • isDefault: boolean

    Returns ContextResponseUtil

setLinks

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

  • Parameters

    • links: Record<string, ReferenceObject | LinkObject>

    Returns ContextResponseUtil

setRef

toOpenAPI

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

  • Returns Record<string, ReferenceObject | ResponseObject>

toPostman

  • toPostman(): ResponseObject[]

  • Returns ResponseObject[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods