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.

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: include version 2.1 and new bindings #85

Merged
merged 14 commits into from
Jul 30, 2021

Conversation

jonaslagoni
Copy link
Member

Description
This PR introduces a few changes to the documents.

  1. Bindings have been separated completely from the AsyncAPI spec files, this is because the binding versions are, as I understand completely separate from the spec version.
  2. Each binding protocol has been given its own version subfolder i.e. instead of tests/bindings/Message Bindings Object/http/valid.yaml the path given is tests/bindings/Message Bindings Object/http/0.1.0/valid.yaml.
  3. I have only added documents for the changes introduces in AsyncAPI 2.1. Not sure how we should handle this moving forward for the upcoming major versions?

Related issue(s)
fixes #80

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.

Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please refer to my comments, overall is good :)

However I have problem which should be addressed in the next PR. Why do we use the names of the folder with spaces? I don't think so it's a good, because as I remember we have in plan to publish the tck as separate package to the npm.

The another problem. Why do we have the path's format for bindings: bindings/{OBJECT...}/{BINDING}/{VERSION}? I think that bindings/{BINDING}/{VERSION}/{OBJECT...} will be better.

README.md Show resolved Hide resolved
tests/asyncapi-2.1/Message Trait Object/valid.yaml Outdated Show resolved Hide resolved
tests/asyncapi-2.1/Message Object/valid.yaml Outdated Show resolved Hide resolved
tests/asyncapi-2.1/Security Scheme Object/plain/valid.yaml Outdated Show resolved Hide resolved
@jonaslagoni
Copy link
Member Author

However I have problem which should be addressed in the next PR. Why do we use the names of the folder with spaces? I don't think so it's a good, because as I remember we have in plan to publish the tck as separate package to the npm.

Yea I agree, do you mind creating another issue for it?

The another problem. Why do we have the path's format for bindings: bindings/{OBJECT...}/{BINDING}/{VERSION}? I think that bindings/{BINDING}/{VERSION}/{OBJECT...} will be better.

You are right, much cleaner setup, changing 🙂

@magicmatatjahu
Copy link
Member

Yea I agree, do you mind creating another issue for it?

#86 :)

Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One change 😄

README.md Outdated Show resolved Hide resolved
Co-authored-by: Maciej Urbańczyk <[email protected]>
Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jonaslagoni
Copy link
Member Author

jonaslagoni commented Jul 30, 2021

@magicmatatjahu one thing that dawned on me, me saying the bindings do not follow the spec version is bullshit 😆 At least it is once we restructure the operation, message, and channels.

Do you think this is the right approach or should bindings be moved into asyncapi-2.0 ? 🤔

@magicmatatjahu
Copy link
Member

magicmatatjahu commented Jul 30, 2021

@jonaslagoni We have issue for specify spec version in the binding -> asyncapi/spec#590 so I think that binding are "independent" from the spec version. I mean that we should test the binding with asyncapi version separately, so bindings folder is good for me :)

@jonaslagoni jonaslagoni merged commit 8ff06de into asyncapi:master Jul 30, 2021
@jonaslagoni jonaslagoni deleted the feature/2.1 branch July 30, 2021 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support v2.1.0 of the spec
2 participants