Skip to content

Commit 4bc3915

Browse files
smoyasmoya
authored
docs: add intent-driven API v1.0.0-alpha documentation (#1)
1 parent b9c192e commit 4bc3915

File tree

2 files changed

+376
-0
lines changed

2 files changed

+376
-0
lines changed

‎README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
11
# parser-api
22
Global API definition for all AsyncAPI Parser implementations.
3+
4+
The API follows an Intent-driven design approach, based on user intents rather than technical mechanics.
5+
6+
An **Intent** represents a user intention of performing an action that solves a clear use case.
7+
8+
For example, `Buy five watermelons` is the intent for `Going to the fruit shop, grab five watermelons, go to the counter, pay with cash, put the watermelon in a bag, exit the shop`.
9+
10+
Based on this principle, we have built an API based on the intents of the end-users, hiding the complexity of the tasks (do not care about going to the fruit shop, we do that for you) and providing better usability.
11+
We tried to cover most use cases; however, we cannot think of every use case, so if you feel like the API is missing an intent, please create a feature request with it.
12+
13+
Find all Parser API versions and definitions [here](docs).
14+
15+
## Design
16+
17+
Intents are wrapped in models. Models are spec-independent but based on AsyncAPI concepts that will always exist regardless of the specification version.
18+
19+
The upsides of using this approach are:
20+
- Better user experience. Intents are much simple to use and do not force users to know about all spec internals.
21+
- Improves resiliency to breaking changes on the final user code. Most of the time, users will **only** need to upgrade to the latest version of the parser to be up-to-date with the latest spec.
22+
23+
All individual parsers are following the intent API. Even though that the individual parsers maintain an individual release cycle, changes to the intent API will force the individual parsers to update as well.
24+
> Say we release a new spec version and we are forced to create a breaking change and force a major version change for the intent API (say from version 2 -> 3) the individual parsers are then forced to make a major version change as well (say JS parser go from version 1 -> 2).
25+
26+
Each parser will therefore maintain its own compatibility matrix between which specification and intent API versions are supported in which parser version.
27+
28+
### Models
29+
30+
These are the models in the intent API:
31+
- **AsyncAPI** is the root model. Most of the intents are here, so users don't need to navigate through the object hierarchy.
32+
- **Channel** describes a `topic`/`channel` a Message is transmitted over by some Operation.
33+
- **Contact** contains Contact information of the Application or Client API.
34+
- **Correlation Id** specifies an identifier at design time that can used for message tracing and correlation.
35+
- **Info** contains defined information about the Application or Client API.
36+
- **License** contains License information of the Application or Client API.
37+
- **Message** represents a message in your message-driven architecture. They can relate to Operations and Channels, but the relationship is not mandatory.
38+
- **OauthFlow** holds configuration details for a supported OAuth Flow.
39+
- **OauthFlows** allows configuration of the supported OAuth Flows.
40+
- **Operation** describes an action performed by the Application or the Client. It links messages with channels.
41+
- **Schema** is a superset of the [JSON Schema Specification Draft 07](https://json-schema.org/understanding-json-schema/basics.html). See https://www.asyncapi.com/docs/specifications/2.0.0#schemaObject.
42+
- **SecurityScheme** represents security specifications for servers.
43+
- **Server** represents a Server in your message-driven architecture. Application or Client always want to connect to some server.
44+
- **ServerVariable** represents a Server Variable for server URL template substitution.
45+
- **Tag** contains metadata.
46+
47+
## Development
48+
To avoid polluting the API with intents that have no apparent use case or can be replaced by a call to another model, we have defined the following rule:
49+
50+
Intents at the root model (`AsyncAPI`) **SHOULD** never return properties of other models but instead answer questions, return the model itself or a collection of models.

‎docs/v1.md‎

Lines changed: 328 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,328 @@
1+
# AsyncAPI Parser API v1.0.0-alpha
2+
## AsyncAPIDocument
3+
- applicationPublishableChannels() : `Channel[]`
4+
- applicationPublishableMessages() : `Message[]`
5+
- applicationPublishOperations() : `Operation[]`
6+
- applicationSubscribableChannels() : `Channel[]`
7+
- applicationSubscribableMessages() : `Message[]`
8+
- applicationSubscribeOperations() : `Operation[]`
9+
- channels() : `Channel[]`
10+
- clientPublishableChannels() : `Channel[]`
11+
- clientPublishableMessages() : `Message[]`
12+
- clientPublishOperations() : `Operation[]`
13+
- clientSubscribableChannels() : `Channel[]`
14+
- clientSubscribableMessages() : `Message[]`
15+
- clientSubscribeOperations() : `Operation[]`
16+
- defaultContentType() : `string` | `undefined`
17+
- extension(name) : `any` | `undefined`
18+
- name : `string`
19+
- hasChannels() : `boolean`
20+
- hasDefaultContentType() : `boolean`
21+
- hasExtension(name) : `boolean`
22+
- name : `string`
23+
- hasServers() : `boolean`
24+
- info() : `Info`
25+
- messages() : `Message[]`
26+
- operations() : `Operation[]`
27+
- schemas() : `Schema[]`
28+
- securitySchemes() : `SecurityScheme[]`
29+
- server(server_name) : `Server` | `undefined`
30+
- server_name : `string`
31+
- servers() : `Server[]`
32+
- version() : `string`
33+
34+
## Channel
35+
- binding(bindingProtocol) : `any` | `undefined`
36+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
37+
- description() : `string` | `undefined`
38+
- extension(name) : `any` | `undefined`
39+
- name : `string`
40+
- hasBinding(bindingProtocol) : `boolean`
41+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
42+
- hasDescription() : `boolean`
43+
- hasExtension(name) : `boolean`
44+
- name : `string`
45+
- hasParameters() : `boolean`
46+
- messages() : `Message[]`
47+
- operations() : `Operation[]`
48+
- parameters() : `ChannelParameter[]`
49+
- path() : `string`
50+
51+
## ChannelParameter
52+
- description() : `string` | `undefined`
53+
- extension(name) : `any` | `undefined`
54+
- name : `string`
55+
- hasExtension(name) : `boolean`
56+
- name : `string`
57+
- name() : `string`
58+
- schema() : `Schema`
59+
60+
## Contact
61+
- email() : `string` | `undefined`
62+
- extension(name) : `any` | `undefined`
63+
- name : `string`
64+
- hasEmail() : `boolean`
65+
- hasExtension(name) : `boolean`
66+
- name : `string`
67+
- hasName() : `boolean`
68+
- hasUrl() : `boolean`
69+
- name() : `string` | `undefined`
70+
- url() : `string` | `undefined`
71+
72+
## CorrelationId
73+
- description() : `string` | `undefined`
74+
- extension(name) : `any` | `undefined`
75+
- name : `string`
76+
- hasDescription() : `boolean`
77+
- hasExtension(name) : `boolean`
78+
- name : `string`
79+
- hasLocation() : `boolean`
80+
- location() : `string` | `undefined`
81+
82+
## ExternalDocument
83+
- description() : `string` | `undefined`
84+
- extension(name) : `any` | `undefined`
85+
- name : `string`
86+
- hasDescription() : `boolean`
87+
- hasExtension(name) : `boolean`
88+
- name : `string`
89+
- hasUrl() : `boolean`
90+
- url() : `string` | `undefined`
91+
92+
## Info
93+
- contacts() : `Contact[]`
94+
- description() : `string` | `undefined`
95+
- extension(name) : `any` | `undefined`
96+
- name : `string`
97+
- externalDocs() : `ExternalDocument` | `undefined`
98+
- hasContacts() : `boolean`
99+
- hasDescription() : `boolean`
100+
- hasExtension(name) : `boolean`
101+
- name : `string`
102+
- hasExternalDocs() : `boolean`
103+
- hasId() : `boolean`
104+
- hasLicense() : `boolean`
105+
- hasTags() : `boolean`
106+
- hasTermsOfService() : `boolean`
107+
- id() : `string` | `undefined`
108+
- license() : `License` | `undefined`
109+
- tags() : `Tag[]` | `undefined`
110+
- termsOfService() : `string` | `undefined`
111+
- title() : `string`
112+
- version() : `string`
113+
114+
## License
115+
- extension(name) : `any` | `undefined`
116+
- name : `string`
117+
- hasExtension(name) : `boolean`
118+
- name : `string`
119+
- hasUrl() : `boolean`
120+
- name() : `string`
121+
- url() : `string` | `undefined`
122+
123+
## Message
124+
- binding(bindingProtocol) : `any` | `undefined`
125+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
126+
- channels() : `Channel[]`
127+
- contentType() : `string`
128+
- correlationId() : `CorrelationId` | `undefined`
129+
- description() : `string` | `undefined`
130+
- examples() : `Map[string, any][]`
131+
- extension(name) : `any` | `undefined`
132+
- name : `string`
133+
- hasBinding(bindingProtocol) : `boolean`
134+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
135+
- hasCorrelationId() : `boolean`
136+
- hasDescription() : `boolean`
137+
- hasExtension(name) : `boolean`
138+
- name : `string`
139+
- hasHeaders() : `boolean`
140+
- hasKnownSchemaFormat() : `boolean`
141+
- hasName() : `boolean`
142+
- hasSummary() : `boolean`
143+
- hasTags() : `boolean`
144+
- hasTitle() : `boolean`
145+
- headers() : `Schema` | `undefined`
146+
- name() : `string` | `undefined`
147+
- operations() : `Operation[]`
148+
- payload() : `Schema | any`
149+
- `Schema` type for all [known schema formats](https://www.asyncapi.com/docs/specifications/2.0.0#messageObjectSchemaFormatTable). Otherwise, `any`.
150+
- schemaFormat() : `string`
151+
- summary() : `string` | `undefined`
152+
- tags() : `Tag[]` | `undefined`
153+
- title() : `string` | `undefined`
154+
- uid() : `string`
155+
156+
## OAuthFlow
157+
- authorizationUrl() : `string` | `undefined`
158+
- extension(name) : `any` | `undefined`
159+
- name : `string`
160+
- hasExtension(name) : `boolean`
161+
- name : `string`
162+
- hasRefreshUrl() : `boolean`
163+
- refreshUrl() : `string` | `undefined`
164+
- scopes() : `Object.<string, string>` | `undefined`
165+
- tokenUrl() : `string` | `undefined`
166+
167+
## OAuthFlows
168+
- authorizationCode() : `OAuthFlow` | `undefined`
169+
- clientCredentials() : `OAuthFlow` | `undefined`
170+
- extension(name) : `any` | `undefined`
171+
- name : `string`
172+
- hasAuthorizationCode() : `boolean`
173+
- hasClientCredentials() : `boolean`
174+
- hasExtension(name) : `boolean`
175+
- name : `string`
176+
- hasImplicit() : `boolean`
177+
- hasPassword() : `boolean`
178+
- implicit() : `OAuthFlow` | `undefined`
179+
- password() : `OAuthFlow` | `undefined`
180+
181+
## Operation
182+
- binding(bindingProtocol) : `any` | `undefined`
183+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
184+
- channels() : `Channel[]`
185+
- description() : `string` | `undefined`
186+
- extension(name) : `any` | `undefined`
187+
- name : `string`
188+
- externalDocs() : `ExternalDocument` | `undefined`
189+
- hasBinding(bindingProtocol) : `boolean`
190+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
191+
- hasDescription() : `boolean`
192+
- hasExtension(name) : `boolean`
193+
- name : `string`
194+
- hasMultipleMessages() : `boolean`
195+
- hasSummary() : `boolean`
196+
- hasTags() : `boolean`
197+
- id() : `string`
198+
- isApplicationPublishing() : `boolean`
199+
- isApplicationSubscribing() : `boolean`
200+
- isClientPublishing() : `boolean`
201+
- isClientSubscribing() : `boolean`
202+
- messages() : `Message[]`
203+
- server() : `Server`
204+
- servers() : `Server[]`
205+
- summary() : `string` | `undefined`
206+
- tags() : `Tag[]`
207+
- type() : `enum{'ClientSubscribing', 'ClientPublishing', 'ApplicationSubscribing', 'ApplicationPublishing}`
208+
209+
## Schema
210+
- $id() : `string`
211+
- additionalItems : `Schema`
212+
- additionalProperties : `boolean | Schema`
213+
- allOf : `Schema`
214+
- anyOf : `Schema`
215+
- circularProps : `string[]`
216+
- const : `any`
217+
- contains : `Schema`
218+
- contentEncoding : `string`
219+
- contentMediaType : `string`
220+
- default : `any`
221+
- definitions : `Map[string, Schema]`
222+
- dependencies : `Map[string, Schema|string[]]`
223+
- deprecated : `boolean`
224+
- discriminator : `string`
225+
- else : `Schema`
226+
- extension(name) : `any` | `undefined`
227+
- name : `string`
228+
- enum : `any[]`
229+
- examples : `any[]`
230+
- exclusiveMaximum() : `number`
231+
- exclusiveMinimum : `number`
232+
- format : `string`
233+
- hasCircularProps : `boolean`
234+
- hasExtension(name) : `boolean`
235+
- name : `string`
236+
- if : `Schema`
237+
- isCircular : `boolean`
238+
- items : `Schema | Schema[]`
239+
- maximum() : `number`
240+
- maxItems : `number`
241+
- maxLength : `number`
242+
- maxProperties : `number`
243+
- minimum : `number`
244+
- minItems : `number`
245+
- minLength : `number`
246+
- minProperties : `number`
247+
- multipleOf() : `number`
248+
- not : `Schema`
249+
- oneOf : `Schema`
250+
- pattern : `string`
251+
- patternProperties : `Map[string, Schema]`
252+
- properties : `Map[string, Schema]`
253+
- property(name) : `Schema`
254+
- name : `string`
255+
- propertyNames : `Schema`
256+
- readOnly : `boolean`
257+
- required : `string`
258+
- then : `Schema`
259+
- title : `string`
260+
- type : `string | string[]`
261+
- uid() : `string`
262+
- uniqueItems : `boolean`
263+
- writeOnly : `boolean`
264+
265+
## SecurityScheme
266+
- bearerFormat() : `string` | `undefined`
267+
- description() : `string`
268+
- extension(name) : `any` | `undefined`
269+
- name : `string`
270+
- flows() : `OAuthFlows`
271+
- hasBearerFormat() : `boolean`
272+
- hasDescription() : `boolean`
273+
- hasExtension(name) : `boolean`
274+
- name : `string`
275+
- in() : `enum{'user', 'password', 'query', 'header', 'cookie'}`
276+
- openIdConnectUrl() : `string`
277+
- scheme() : `string` | `undefined`
278+
- scopes() : `string[]`
279+
- type() : `enum{'userPassword', 'apiKey', 'X509', 'symmetricEncryption', 'asymmetricEncryption', 'httpApiKey', 'http', 'oauth2', 'openIdConnect'}`
280+
281+
## ServerVariable
282+
- allowedValues() : `any[]`
283+
- defaultValue() : `string` | `undefined`
284+
- description() : `string` | `undefined`
285+
- examples() : `string[]`
286+
- extension(name) : `any` | `undefined`
287+
- name : `string`
288+
- hasAllowedValues() : `boolean`
289+
- hasDefaultValue() : `boolean`
290+
- hasDescription() : `boolean`
291+
- hasExtension(name) : `boolean`
292+
- name : `string`
293+
- hasName() : `boolean`
294+
- name() : `string` | `undefined`
295+
296+
## Server
297+
- binding(bindingProtocol) : `any` | `undefined`
298+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
299+
- description() : `string` | `undefined`
300+
- extension(name) : `any` | `undefined`
301+
- name : `string`
302+
- hasBinding(bindingProtocol) : `boolean`
303+
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}`
304+
- hasDescription() : `boolean`
305+
- hasExtension(name) : `boolean`
306+
- name : `string`
307+
- hasName() : `boolean`
308+
- hasProtocol() : `boolean`
309+
- hasProtocolVersion() : `boolean`
310+
- hasUrl() : `boolean`
311+
- name() : `string` | `undefined`
312+
- operations() : `Operation[]`
313+
- protocol() : `string` | `undefined`
314+
- protocolVersion() : `string` | `undefined`
315+
- securitySchemes() : `SecurityScheme[]`
316+
- url() : `string` | `undefined`
317+
- variables() : `ServerVariable[]`
318+
319+
## Tag
320+
- description() : `string` | `undefined`
321+
- extension(name) : `any` | `undefined`
322+
- name : `string`
323+
- externalDocs() : `ExternalDocument` | `undefined`
324+
- hasDescription() : `boolean`
325+
- hasExtension(name) : `boolean`
326+
- name : `string`
327+
- hasExternalDocs() : `boolean`
328+
- name() : `string`

0 commit comments

Comments
 (0)