Skip to content

Latest commit

 

History

History
449 lines (409 loc) · 13.3 KB

v1.md

File metadata and controls

449 lines (409 loc) · 13.3 KB

AsyncAPI Parser API v1.0.0-alpha.4

AsyncAPIDocument

  • channels() : Channels
  • allChannels() : Channels
  • allMessages() : Messages
  • allOperations() : Operations
  • allSchemas() : Schemas
  • allServers() : Servers
  • components() : Components
  • defaultContentType() : string | undefined
  • extensions : Extensions
  • hasDefaultContentType() : boolean
  • info() : Info
  • messages() : Messages
  • operations() : Operations
  • schemas() : Schemas
  • securitySchemes() : SecuritySchemes
  • servers() : Servers
  • version() : string

Binding

  • protocol() : string
  • version() : string
  • value() : any

Bindings

  • all() : Binding[]
  • extensions() : Extensions
  • filterBy(filter : (binding: Binding) => boolean) : Binding[]
  • get(id: string) : Binding | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

Channel

  • address() : string
  • bindings() : Bindings
  • description() : string | undefined
  • extensions() : Extensions
  • hasDescription() : boolean
  • id() : string
  • messages() : Messages
  • operations() : Operations
  • parameters() : ChannelParameters
  • servers() : Servers

Channels

  • all() : Channel[]
  • filterBy(filter : (channel: Channel) => boolean) : Channel[]
  • filterBySend() : Channel[]
  • filterByReceive() : Channel[]
  • get(id: string) : Channel | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

ChannelParameter

  • id() : string
  • hasDescription() : boolean
  • description() : string | undefined
  • hasSchema(): boolean
  • schema() : Schema | undefined
  • hasLocation() : boolean
  • location(): string | undefined
  • extensions() : Extensions

ChannelParameters

  • all() : ChannelParameter[]
  • filterBy(filter : (parameter: ChannelParameter) => boolean) : ChannelParameter[]
  • get(id: string) : ChannelParameter | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

Components

  • servers(): Servers
  • channels(): Channels
  • messages(): Messages
  • operations() : Operations
  • schemas(): Schemas
  • channelParameters(): ChannelParameters
  • serverVariables(): ServerVariables
  • operationTraits(): OperationTraits
  • messageTraits(): MessageTraits
  • correlationIds(): CorrelationIds
  • securitySchemes(): SecuritySchemes
  • serverBindings(): Map[string, Bindings]
  • channelBindings(): Map[string, Bindings]
  • operationBindings(): Map[string, Bindings]
  • messageBindings(): Map[string, Bindings]
  • isEmpty() : boolean

Contact

  • email() : string | undefined
  • extensions() : Extensions
  • hasEmail() : boolean
  • hasName() : boolean
  • hasUrl() : boolean
  • name() : string | undefined
  • url() : string | undefined

CorrelationId

  • description() : string | undefined
  • extensions() : Extensions
  • hasDescription() : boolean
  • hasLocation() : boolean
  • location() : string | undefined

CorrelationIds

  • all() : CorrelationId[]
  • filterBy(filter : (correlationId: CorrelationId) => boolean) : CorrelationId[]
  • get(id: string) : CorrelationId | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

Extension

  • id() : string
  • value() : any

Extensions

  • all() : Extension[]
  • filterBy(filter : (extension: Extension) => boolean) : Extension[]
  • get(id: string) : Extension | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

ExternalDocumention

  • description() : string | undefined
  • extensions() : Extensions
  • hasDescription() : boolean
  • url() : string

Info

  • contact() : Contact | undefined
  • description() : string | undefined
  • extensions() : Extensions
  • externalDocs() : ExternalDocumention | undefined
  • hasContact() : boolean
  • hasDescription() : boolean
  • hasExternalDocs() : boolean
  • hasId() : boolean
  • hasLicense() : boolean
  • hasTermsOfService() : boolean
  • id() : string | undefined
  • license() : License | undefined
  • tags() : Tags
  • termsOfService() : string | undefined
  • title() : string
  • version() : string

License

  • extensions() : Extensions
  • hasUrl() : boolean
  • name() : string
  • url() : string | undefined

Message

  • bindings() : Bindings
  • channels() : Channels
  • contentType() : string
  • correlationId() : CorrelationId | undefined
  • description() : string | undefined
  • examples() : MessageExamples
  • extensions() : Extensions
  • hasCorrelationId() : boolean
  • hasDescription() : boolean
  • hasHeaders() : boolean
  • hasName() : boolean
  • hasSummary() : boolean
  • hasTitle() : boolean
  • headers() : Schema | undefined
  • id() : string
  • name() : string | undefined
  • operations() : Operations
  • hasPayload() : boolean
  • payload() : Schema | undefined
  • schemaFormat() : string
  • servers() : Servers
  • summary() : string | undefined
  • tags() : Tags
  • title() : string | undefined
  • traits(): MessageTraits

Messages

  • all() : Message[]
  • filterBy(filter : (message: Message) => boolean) : Message[]
  • filterBySend() : Message[]
  • filterByReceive() : Message[]
  • get(id: string) : Message | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

MessageExample

  • extensions() : Extensions
  • hasName() : boolean
  • hasSummary() : boolean
  • headers() : Map[string, any] | undefined
  • name() : string | undefined
  • payload() : Map[string, any] | undefined
  • summary() : string | undefined

MessageExamples

  • all() : MessageExample[]
  • filterBy(filter : (messageExample: MessageExample) => boolean) : MessageExample[]
  • get(name: string) : MessageExample | undefined
  • has(name: string) : boolean
  • isEmpty() : boolean

MessageTrait

  • bindings() : Bindings
  • contentType() : string | undefined
  • correlationId() : CorrelationId | undefined
  • description() : string | undefined
  • examples() : MessageExamples
  • extensions() : Extensions
  • hasCorrelationId() : boolean
  • hasDescription() : boolean
  • hasHeaders() : boolean
  • hasName() : boolean
  • hasSummary() : boolean
  • hasTitle() : boolean
  • headers() : Schema | undefined
  • id() : string
  • name() : string | undefined
  • schemaFormat() : string
  • summary() : string | undefined
  • tags() : Tags
  • title() : string | undefined

MessageTraits

  • all() : MessageTrait[]
  • filterBy(filter : (messageTrait: MessageTrait) => boolean) : MessageTrait[]
  • get(id: string) : MessageTrait | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

OAuthFlow

  • authorizationUrl() : string | undefined
  • extensions() : Extensions
  • hasRefreshUrl() : boolean
  • refreshUrl() : string | undefined
  • scopes() : Map[string, string] | undefined
  • tokenUrl() : string | undefined

OAuthFlows

  • authorizationCode() : OAuthFlow | undefined
  • clientCredentials() : OAuthFlow | undefined
  • extensions() : Extensions
  • hasAuthorizationCode() : boolean
  • hasClientCredentials() : boolean
  • hasImplicit() : boolean
  • hasPassword() : boolean
  • implicit() : OAuthFlow | undefined
  • password() : OAuthFlow | undefined

Operation

  • bindings() : Bindings
  • channels() : Channel[]
  • description() : string | undefined
  • extensions() : Extensions
  • externalDocs() : ExternalDocumention | undefined
  • hasDescription() : boolean
  • hasSummary() : boolean
  • id() : string
  • messages() : Message[]
  • servers() : Server[]
  • summary() : string | undefined
  • tags() : Tags
  • security() : SecurityRequirements[]
  • isSend(): boolean
  • isReceive(): boolean
  • action() : enum{'send', 'receive', 'publish', 'subscribe'}
  • traits: OperationTraits

Operations

  • all() : Operation[]
  • filterBy(filter : (operation: Operation) => boolean) : Operation[]
  • filterBySend() : Operation[]
  • filterByReceive() : Operation[]
  • get(id: string) : Operation | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

OperationTrait

  • bindings() : Bindings
  • description() : string | undefined
  • extensions() : Extensions
  • externalDocs() : ExternalDocumention | undefined
  • hasDescription() : boolean
  • hasSummary() : boolean
  • id() : string
  • summary() : string | undefined
  • tags() : Tags
  • security() : SecurityRequirements[]

OperationTraits

  • all() : OperationTrait[]
  • filterBy(filter : (operationTrait: OperationTrait) => boolean) : OperationTrait[]
  • get(id: string) : OperationTrait | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

Schema

  • $id() : string | undefined
  • additionalItems : boolean | Schema
  • additionalProperties : boolean | Schema
  • allOf : Schema[] | undefined
  • anyOf : Schema[] | undefined
  • const : any
  • contains : Schema | undefined
  • contentEncoding : string | undefined
  • contentMediaType : string | undefined
  • default : any
  • definitions : Map[string, Schema] | undefined
  • description : string | undefined
  • dependencies : Map[string, Schema|string[]] | undefined
  • deprecated : boolean
  • discriminator : string | undefined
  • else : Schema | undefined
  • extensions() : Extensions
  • enum : any[] | undefined
  • examples : any[] | undefined
  • exclusiveMaximum() : number | undefined
  • exclusiveMinimum : number | undefined
  • format : string | undefined
  • id() : string
  • isBooleanSchema: boolean
  • if : Schema | undefined
  • isCircular : boolean
  • items : Schema | Schema[] | undefined
  • maximum() : number | undefined
  • maxItems : number | undefined
  • maxLength : number | undefined
  • maxProperties : number | undefined
  • minimum : number | undefined
  • minItems : number | undefined
  • minLength : number | undefined
  • minProperties : number | undefined
  • multipleOf() : number | undefined
  • not : Schema | undefined
  • oneOf : Schema[] | undefined
  • pattern : string | undefined
  • patternProperties : Map[string, Schema] | undefined
  • properties : Map[string, Schema] | undefined
  • property(name: string) : Schema
  • propertyNames : Schema | undefined
  • readOnly : boolean | undefined
  • required : string[] | undefined
  • then : Schema | undefined
  • title : string | undefined
  • type : string | string[] | undefined
  • uniqueItems : boolean | undefined
  • writeOnly : boolean | undefined

Schemas

  • all() : Schema[]
  • filterBy(filter : (schema: Schema) => boolean) : Schema[]
  • get(id: string) : Schema | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

SecurityRequirement

  • scheme(): SecurityScheme
  • scopes(): string[]

SecurityRequirements

  • all() : SecurityRequirement[]
  • filterBy(filter : (securityRequirement: SecurityRequirement) => boolean) : SecurityRequirement[]
  • get(name: string) : SecurityRequirement | undefined
  • has(name: string) : boolean
  • isEmpty() : boolean

SecurityScheme

  • id() : string
  • bearerFormat() : string | undefined
  • description() : string | undefined
  • extensions() : Extensions
  • flows() : OAuthFlows | undefined
  • hasBearerFormat() : boolean
  • hasDescription() : boolean
  • in() : enum{'user', 'password', 'query', 'header', 'cookie'} | undefined
  • openIdConnectUrl() : string
  • scheme() : string | undefined
  • scopes() : string[]
  • type() : enum{'userPassword', 'apiKey', 'X509', 'symmetricEncryption', 'asymmetricEncryption', 'httpApiKey', 'http', 'oauth2', 'openIdConnect', 'plain', 'scramSha256', 'scramSha512', 'gssapi'}

SecuritySchemes

  • all() : SecurityScheme[]
  • filterBy(filter : (securityScheme: SecurityScheme) => boolean) : SecurityScheme[]
  • get(id: string) : SecurityScheme | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

Server

  • bindings() : Bindings
  • channels() : Channels
  • description() : string | undefined
  • extensions() : Extensions
  • hasDescription() : boolean
  • hasProtocolVersion() : boolean
  • messages() : Messages
  • name() : string | undefined
  • operations() : Operations
  • protocol() : string
  • protocolVersion() : string | undefined
  • security() : SecurityRequirements[]
  • url() : string
  • tags() : Tags
  • variables() : ServerVariables

Servers

  • all() : Server[]
  • filterBy(filter : (server: Server) => boolean) : Server[]
  • filterBySend() : Server[]
  • filterByReceive() : Server[]
  • get(id: string) : Server | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

ServerVariable

  • allowedValues() : string[]
  • defaultValue() : string | undefined
  • description() : string | undefined
  • examples() : string[]
  • extensions() : Extensions
  • hasAllowedValues() : boolean
  • hasDefaultValue() : boolean
  • hasDescription() : boolean
  • id() : string

ServerVariables

  • all() : ServerVariable[]
  • filterBy(filter : (serverVariable: ServerVariable) => boolean) : ServerVariable[]
  • get(id: string) : ServerVariable | undefined
  • has(id: string) : boolean
  • isEmpty() : boolean

Tag

  • description() : string | undefined
  • extensions() : Extensions
  • externalDocs() : ExternalDocumention | undefined
  • hasDescription() : boolean
  • hasExternalDocs() : boolean
  • name() : string

Tags

  • all() : Tag[]
  • filterBy(filter : (tag: Tag) => boolean) : Tag[]
  • get(name: string) : Tag | undefined
  • has(name: string) : boolean
  • isEmpty() : boolean