Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Properties

cookieParameters

cookieParameters: Parameter[]

customDomainProperties

customDomainProperties: DomainExtension[]

description

description: StrField

extendsNode

extendsNode: DomainElement[]

headers

headers: Parameter[]

id

id: string

payloads

payloads: Payload[]

position

position: Range

queryParameters

queryParameters: Parameter[]

queryString

queryString: Shape

required

required: BoolField

uriParameters

uriParameters: Parameter[]

Methods

annotations

  • annotations(): any

graph

withCookieParameter

  • withCookieParameter(name: string): Parameter
  • Parameters

    • name: string

    Returns Parameter

withCookieParameters

  • withCookieParameters(cookieParameters: Parameter[]): this
  • Parameters

    Returns this

withCustomDomainProperties

withDescription

  • withDescription(description: string): this
  • Parameters

    • description: string

    Returns this

withExtendsNode

withHeader

  • Parameters

    • name: string

    Returns Parameter

withHeaders

  • Parameters

    Returns this

withId

  • withId(id: string): this
  • Parameters

    • id: string

    Returns this

withPayload

  • Returns Payload

  • Parameters

    • mediaType: string

    Returns Payload

withPayloads

  • withPayloads(payloads: Payload[]): this
  • Parameters

    Returns this

withQueryParameter

  • withQueryParameter(name: string): Parameter
  • Parameters

    • name: string

    Returns Parameter

withQueryParameters

  • withQueryParameters(parameters: Parameter[]): this
  • Parameters

    Returns this

withQueryString

  • withQueryString(queryString: Shape): this
  • Parameters

    Returns this

withRequired

  • withRequired(required: boolean): this
  • Parameters

    • required: boolean

    Returns this

withUriParameter

  • Parameters

    • name: string

    Returns Parameter

withUriParameters

  • withUriParameters(uriParameters: Parameter[]): this
  • Parameters

    Returns this

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc