Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Components, Security Requirement(s) models and other improvements #71

Merged
merged 29 commits into from
Feb 8, 2023
Merged

feat: add Components, Security Requirement(s) models and other improvements #71

Changes from 6 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
6d47e9c
feat: add 'components' and 'correlationIds' models
smoya Aug 25, 2022
424660a
Update v1.md
smoya Aug 26, 2022
8f922db
Update v1.md
smoya Aug 26, 2022
f522013
Update v1.md
smoya Aug 26, 2022
7b9b575
add operations under components
smoya Aug 29, 2022
5897a1e
add Security Requirements
smoya Aug 29, 2022
3826e0b
fix security requirements
smoya Aug 30, 2022
50a267f
add missing MessageExample(s) model
smoya Aug 30, 2022
83703e6
remove hasKnownSchemaFormat
smoya Aug 30, 2022
b82a10f
add missing address and id to Channel
smoya Sep 1, 2022
eab44c2
simplify Traits since there is no clear use case
smoya Sep 2, 2022
1595275
add extensions() to bindings model
smoya Sep 6, 2022
1605ee1
cleanup models
smoya Sep 7, 2022
a3db4f3
add `filterByInUse()` and `filterByNotInUse()`
smoya Sep 15, 2022
eda0ef7
Merge branch 'master' into feat/components
smoya Sep 26, 2022
14cd75e
Remove filters by usage +add all* methods
smoya Oct 4, 2022
33e4025
remove empty lines
smoya Oct 5, 2022
1add6c4
Merge branch 'master' into feat/components
smoya Oct 5, 2022
0ae8f98
change schema.uid() method to schema.id()
smoya Oct 6, 2022
874fccd
Update docs/v1.md
smoya Oct 7, 2022
fb434bf
update README
smoya Oct 10, 2022
05af4ff
Merge branch 'master' into feat/components
smoya Oct 13, 2022
11e0919
Merge branch 'master' into feat/components
smoya Oct 20, 2022
e618297
Merge branch 'master' into feat/components
smoya Oct 27, 2022
835892a
Update docs/v1.md
smoya Oct 27, 2022
3a0c511
Merge branch 'master' into feat/components
smoya Nov 8, 2022
fc99a2a
add payload() to the Messages model and extension(id) method
magicmatatjahu Dec 20, 2022
fef1191
Merge branch 'master' into feat/components
magicmatatjahu Feb 2, 2023
dc68fe2
fix API
magicmatatjahu Feb 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 40 additions & 5 deletions docs/v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# AsyncAPI Parser API v1.0.0-alpha.3
# AsyncAPI Parser API v1.0.0-alpha.4

## AsyncAPIDocument
- channels() : `Channels`
- components() : `Components`
smoya marked this conversation as resolved.
Show resolved Hide resolved
- defaultContentType() : `string` | `undefined`
- extensions : `Extensions`
- hasDefaultContentType() : `boolean`
Expand Down Expand Up @@ -59,6 +60,24 @@
- has(id: `string`) : `boolean`
- isEmpty() : `boolean`

## Components
- servers(): `Servers`
- channels(): `Channels`
- messages(): `Messages`
- operations() : `Operations`
smoya marked this conversation as resolved.
Show resolved Hide resolved
- 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`
Expand All @@ -75,6 +94,12 @@
- hasLocation() : `boolean`
- location() : `string` | `undefined`

## CorrelationIds
- all() : `CorrelationId[]`
- get(id: `string`) : `CorrelationId` | `undefined`
- has(id: `string`) : `boolean`
- isEmpty() : `boolean`

## Extension
- id() : `string`
- version() : `string`
smoya marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -190,7 +215,7 @@
- extensions() : `Extensions`
- hasRefreshUrl() : `boolean`
- refreshUrl() : `string` | `undefined`
- scopes() : `Object.<string, string>` | `undefined`
- scopes() : `Map[string, string]` | `undefined`
- tokenUrl() : `string` | `undefined`

## OAuthFlows
Expand Down Expand Up @@ -226,7 +251,7 @@
- servers() : `Server[]`
- summary() : `string` | `undefined`
- tags() : `Tags`
- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
- security() : `SecurityRequirements`
smoya marked this conversation as resolved.
Show resolved Hide resolved
- isSend(): `boolean`
- isReceive(): `boolean`
- action() : `enum{'Send', 'Receive', 'Publish', 'Subscribe'}`
Expand All @@ -250,7 +275,7 @@
- servers() : `Server[]`
- summary() : `string` | `undefined`
- tags() : `Tags`
- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
- security() : `SecurityRequirements`
- isSend(): `boolean`
- isReceive(): `boolean`
- action() : `enum{'Send', 'Receive', 'Publish', 'Subscribe'}`
Expand Down Expand Up @@ -314,6 +339,16 @@
- has(id: `string`) : `boolean`
- isEmpty() : `boolean`

## SecurityRequirement
- scheme: `SecurityScheme`
- scopes: `string[]`

## SecurityRequirements
- all() : `SecurityRequirement[]`
- get(name: `string`) : `SecurityRequirement` | `undefined`
- has(name: `string`) : `boolean`
- isEmpty() : `boolean`

## SecurityScheme
- id() : `string`
- bearerFormat() : `string` | `undefined`
Expand Down Expand Up @@ -355,7 +390,7 @@
- operations() : `Operations`
- protocol() : `string` | `undefined`
- protocolVersion() : `string` | `undefined`
- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
- security() : `SecurityRequirements`
- url() : `string` | `undefined`
- variables() : `ServerVariables`

Expand Down