Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Properties

accepts

accepts: StrField[]

contentType

contentType: StrField[]

customDomainProperties

customDomainProperties: DomainExtension[]

description

description: StrField

documentations

documentations: CreativeWork[]

endPoints

endPoints: EndPoint[]

extendsNode

extendsNode: DomainElement[]

id

id: string

license

license: License

name

name: StrField

position

position: Range

provider

provider: Organization

schemes

schemes: StrField[]

security

servers

servers: Server[]

termsOfService

termsOfService: StrField

version

version: StrField

Methods

annotations

  • annotations(): any

graph

withAccepts

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

    • accepts: string[]

    Returns this

withContentType

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

    • contentType: string[]

    Returns this

withCustomDomainProperties

withDefaultServer

  • withDefaultServer(url: string): Server
  • Parameters

    • url: string

    Returns Server

withDescription

  • withDescription(description: string): this
  • Parameters

    • description: string

    Returns this

withDocumentation

  • Parameters

    Returns this

withDocumentationTitle

  • Parameters

    • title: string

    Returns CreativeWork

withDocumentationUrl

  • Parameters

    • url: string

    Returns CreativeWork

withEndPoint

  • Parameters

    • path: string

    Returns EndPoint

withEndPoints

  • withEndPoints(endPoints: EndPoint[]): this
  • Parameters

    Returns this

withExtendsNode

withId

  • withId(id: string): this
  • Parameters

    • id: string

    Returns this

withLicense

  • withLicense(license: License): this
  • Parameters

    Returns this

withName

  • withName(name: string): this
  • Parameters

    • name: string

    Returns this

withProvider

  • Parameters

    Returns this

withSchemes

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

    • schemes: string[]

    Returns this

withSecurity

withServer

  • withServer(url: string): Server
  • Parameters

    • url: string

    Returns Server

withServers

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

    Returns this

withTermsOfService

  • withTermsOfService(terms: string): this
  • Parameters

    • terms: string

    Returns this

withVersion

  • withVersion(version: string): this
  • Parameters

    • version: 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