-
-
Notifications
You must be signed in to change notification settings - Fork 9
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
Comments
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. |
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 ❤️ |
Even though this is already done in parser-js |
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 ❤️ |
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.
✓
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.The text was updated successfully, but these errors were encountered: