Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Properties

accepts

accepts: StrField[]

callbacks

callbacks: Callback[]

contentType

contentType: StrField[]

customDomainProperties

customDomainProperties: DomainExtension[]

deprecated

deprecated: BoolField

description

description: StrField

documentation

documentation: CreativeWork

extendsNode

extendsNode: DomainElement[]

id

id: string

method

method: StrField

name

name: StrField

position

position: Range

request

request: Request

requests

requests: Request[]

responses

responses: Response[]

schemes

schemes: StrField[]

security

servers

servers: Server[]

summary

summary: StrField

Methods

annotations

  • annotations(): any

graph

withAccepts

  • withAccepts(accepts: string[]): this
  • Parameters

    • accepts: string[]

    Returns this

withCallback

  • Parameters

    • name: string

    Returns Callback

withCallbacks

  • withCallbacks(callbacks: Callback[]): this
  • Parameters

    Returns this

withContentType

  • withContentType(contentType: string[]): this
  • Parameters

    • contentType: string[]

    Returns this

withCustomDomainProperties

withDeprecated

  • withDeprecated(deprecated: boolean): this
  • Parameters

    • deprecated: boolean

    Returns this

withDescription

  • withDescription(description: string): this
  • Parameters

    • description: string

    Returns this

withDocumentation

  • Parameters

    Returns this

withExtendsNode

withId

  • withId(id: string): this
  • Parameters

    • id: string

    Returns this

withMethod

  • withMethod(method: string): this
  • Parameters

    • method: string

    Returns this

withName

  • withName(name: string): this
  • Parameters

    • name: string

    Returns this

withRequest

  • Parameters

    Returns this

  • Returns Request

withRequests

  • withRequests(requests: Request[]): this
  • Parameters

    Returns this

withResponse

  • Parameters

    • name: string

    Returns Response

withResponses

  • withResponses(responses: Response[]): this
  • Parameters

    Returns this

withSchemes

  • withSchemes(schemes: string[]): this
  • Parameters

    • schemes: string[]

    Returns this

withSecurity

withServer

  • withServer(name: string): Server
  • Parameters

    • name: string

    Returns Server

withServers

  • withServers(servers: Server[]): this
  • Parameters

    Returns this

withSummary

  • withSummary(summary: string): this
  • Parameters

    • summary: string

    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