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

Implement a compatibility matrix between the API and the Spec #25

Open
smoya opened this issue Nov 3, 2021 · 4 comments
Open

Implement a compatibility matrix between the API and the Spec #25

smoya opened this issue Nov 3, 2021 · 4 comments
Labels
enhancement New feature or request keep-open

Comments

@smoya
Copy link
Member

smoya commented Nov 3, 2021

Reason/Context

The Parser-API is built for being used in the long-term. Most of AsyncAPI spec breaking changes won't affect this API.
However, there are always changes in the AsyncAPI spec that will need to be reflected into this API, generating patches, minors or less expected major versions.

This is why I think we should create and maintain a compatibility matrix between the API and the Spec.
We already discussed about this in the past here, where some proposals were written down as well.

Description

Based on asyncapi/shape-up-process#95 (comment), also including further comments, a table similar to the following would be included in this repo README (or where documentation goes).
Inspiration from https://github.com/kubernetes/kube-state-metrics/blob/master/README.md#compatibility-matrix.

Parser API Spec v2.0.0 Spec v2.1.0 Spec v2.2.0 Spec v3.0.0
v1.0.0 - X
  • Fully supported version.
  • - The AsyncAPI Spec version has features the Parser API can't use but the rest are fully supported.
  • X Not supported version.
@smoya smoya added the enhancement New feature or request label Nov 3, 2021
@github-actions
Copy link

github-actions bot commented Nov 3, 2021

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. 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.

@github-actions
Copy link

github-actions bot commented Mar 4, 2022

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Mar 4, 2022
@smoya
Copy link
Member Author

smoya commented Mar 4, 2022

Even though this is already done in parser-js next-major branch (See this), I would like to leave this issue opened so we can close it once we validate all the work we are doing in parser-js and backported to the final API definition here in this repository.

@smoya smoya removed the stale label Mar 4, 2022
@github-actions
Copy link

github-actions bot commented Jul 3, 2022

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Jul 3, 2022
@smoya smoya added keep-open and removed stale labels Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request keep-open
Projects
None yet
Development

No branches or pull requests

1 participant