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

Add versioning documentation #19738

Merged
merged 3 commits into from
Nov 28, 2022
Merged

Add versioning documentation #19738

merged 3 commits into from
Nov 28, 2022

Conversation

gosusnp
Copy link
Contributor

@gosusnp gosusnp commented Nov 23, 2022

What

Document the changes related to protocol versioning.

How

Update the docs.

@gosusnp gosusnp requested a review from a team as a code owner November 23, 2022 00:21
@octavia-squidington-iv octavia-squidington-iv added the area/documentation Improvements or additions to documentation label Nov 23, 2022
Comment on lines +20 to +22
1. We will continue to do our best effort to avoid introducing breaking changes to the Airbyte Protocol.
2. When introducing a new minor version of the Airbyte Protocol, new fields must come with sensible defaults for backward compatibility within the same major version, or be entirely optional.
3. When introducing a new major version of the Airbyte Protocol, all connectors from the previous major version will continue to work. This requires the ability to “translate” messages between 1 major version of the Airbyte Protocol.
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@jdpgrailsdev jdpgrailsdev left a comment

Choose a reason for hiding this comment

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

:shipit:

@gosusnp gosusnp merged commit 43e6a52 into master Nov 28, 2022
@gosusnp gosusnp deleted the gosusnp/versioning-documentation branch November 28, 2022 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants