docs: update parser-api (asyncapi#64)

KhudaDad414 · Jun 23, 2022 · 0524be9 · 0524be9
1 parent 06712e6
commit 0524be9
Showing 1 changed file with 76 additions and 15 deletions.
diff --git a/docs/v1.md b/docs/v1.md
@@ -1,4 +1,5 @@
-# AsyncAPI Parser API v1.0.0-alpha.2
+# AsyncAPI Parser API v1.0.0-alpha.3
+
 ## AsyncAPIDocument
 - channels() : `Channels`
 - defaultContentType() : `string` | `undefined`
@@ -43,10 +44,14 @@
 - servers() : `Servers`
 
 ## ChannelParameter
+- id() : `string`
+- hasDescription() : `boolean`
 - description() : `string` | `undefined`
+- hasSchema(): `boolean`
+- schema() : `Schema` | `undefined`
+- hasLocation() : `boolean`
+- location(): `string` | `undefined`
 - extensions() : `Extensions`
-- id() : `string`
-- schema() : `Schema`
 
 ## ChannelParameters
 - all() : `ChannelParameter[]`
@@ -140,12 +145,45 @@
 - id() : `string`
 - name() : `string` | `undefined`
 - operations() : `Operations`
+- hasPayload() : `boolean`
 - payload() : `Schema | any`
 - schemaFormat() : `string`
 - servers() : `Servers`
 - summary() : `string` | `undefined`
 - tags() : `Tags`
 - title() : `string` | `undefined`
+- traits(): `MessageTraits`
+
+## MessageTraits
+- all() : `MessageTrait[]`
+- get(id: `string`) : `MessageTrait` | `undefined`
+- has(id: `string`) : `boolean`
+- isEmpty() : `boolean`
+
+## MessageTrait
+- bindings() : `Bindings`
+- channels() : `Channels`
+- contentType() : `string`
+- correlationId() : `CorrelationId` | `undefined`
+- description() : `string` | `undefined`
+- examples() : `Map[string, any][]`
+- extensions() : `Extensions`
+- hasCorrelationId() : `boolean`
+- hasDescription() : `boolean`
+- hasHeaders() : `boolean`
+- hasKnownSchemaFormat() : `boolean`
+- hasName() : `boolean`
+- hasSummary() : `boolean`
+- hasTitle() : `boolean`
+- headers() : `Schema` | `undefined`
+- id() : `string`
+- name() : `string` | `undefined`
+- operations() : `Operations`
+- schemaFormat() : `string`
+- servers() : `Servers`
+- summary() : `string` | `undefined`
+- tags() : `Tags`
+- title() : `string` | `undefined`
 
 ## OAuthFlow
 - authorizationUrl() : `string` | `undefined`
@@ -166,6 +204,15 @@
 - implicit() : `OAuthFlow` | `undefined`
 - password() : `OAuthFlow` | `undefined`
 
+## Operations
+- all() : `Operation[]`
+- filterBy(filter : `(operation: Operation) => boolean`) : `Operation[]`
+- filterBySend() : `Operation[]`
+- filterByReceive() : `Operation[]`
+- get(id: `string`) : `Operation` | `undefined`
+- has(id: `string`) : `boolean`
+- isEmpty() : `boolean`
+
 ## Operation   
 - bindings() : `Bindings`
 - channels() : `Channel[]`
@@ -175,25 +222,39 @@
 - hasDescription() : `boolean`
 - hasSummary() : `boolean`
 - id() : `string`
-- isApplicationPublishing() : `boolean`
-- isApplicationSubscribing() : `boolean`
-- isClientPublishing() : `boolean`
-- isClientSubscribing() : `boolean`
 - messages() : `Message[]`
 - servers() : `Server[]`
 - summary() : `string` | `undefined`
 - tags() : `Tags`
-- type() : `enum{'ClientSubscribing', 'ClientPublishing', 'ApplicationSubscribing', 'ApplicationPublishing}`
+- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
+- 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`
+## OperationTraits
+- all() : `OperationTrait[]`
+- get(id: `string`) : `OperationTrait` | `undefined`
 - has(id: `string`) : `boolean`
 - isEmpty() : `boolean`
 
+## OperationTrait
+- bindings() : `Bindings`
+- channels() : `Channel[]`
+- description() : `string` | `undefined`
+- extensions() : `Extensions`
+- externalDocs() : `ExternalDocument` | `undefined`
+- hasDescription() : `boolean`
+- hasSummary() : `boolean`
+- id() : `string`
+- servers() : `Server[]`
+- summary() : `string` | `undefined`
+- tags() : `Tags`
+- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
+- isSend(): `boolean`
+- isReceive(): `boolean`
+- action() : `enum{'Send', 'Receive', 'Publish', 'Subscribe'}`
+
 ## Schema
 - $id() : `string` | `undefined`
 - additionalItems : `boolean | Schema`
@@ -294,7 +355,7 @@
 - operations() : `Operations`
 - protocol() : `string` | `undefined`
 - protocolVersion() : `string` | `undefined`
-- securitySchemes() : `SecuritySchemes`
+- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
 - url() : `string` | `undefined`
 - variables() : `ServerVariables`