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

🐛 Source Recharge: Added the UI toggle Use 'Orders' Deprecated API to switch between deprecated and modern api versions for Orders stream #34707

Merged
merged 10 commits into from
Feb 1, 2024

Conversation

bazarnov
Copy link
Collaborator

@bazarnov bazarnov commented Jan 31, 2024

What

Resolving: https://github.com/airbytehq/oncall/issues/3860

How

  • split the original Orders stream class into 2 separate classes: OrdersModernApi and OrdersDeprecatedApi to the api.py to be able to switch between the two via UI toggle: Use 'Orders' Deprecated API
  • extended the Orders stream schema to cover the new properties introduced in the 2021-11 API version (ModernApi)
  • added the select_orders_stream method stream Selector to source.py to define which API to use, based on the user's input configuration.
  • updated expected_records since the CAT test is failing
  • covered the case with unit test

🚨 User Impact 🚨

No impact is expected, because this is not a breaking change, the default value for the new UI toggle is True, meaning for all the existing connections nothing will change, they will remain on DeprecatedAPI version.

To change this, change the toggle value in the UI to False and continue with the syncs.

@bazarnov bazarnov self-assigned this Jan 31, 2024
Copy link

vercel bot commented Jan 31, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Jan 31, 2024 10:07pm

Copy link
Contributor

github-actions bot commented Jan 31, 2024

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@bazarnov bazarnov merged commit 7bd2dd6 into master Feb 1, 2024
27 of 29 checks passed
@bazarnov bazarnov deleted the baz/source-recharge/fix-orders-missing-records branch February 1, 2024 14:10
xiaohansong pushed a commit that referenced this pull request Feb 13, 2024
…to switch between `deprecated` and `modern` api versions for `Orders` stream (#34707)
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 21, 2024
…to switch between `deprecated` and `modern` api versions for `Orders` stream (airbytehq#34707)
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
…to switch between `deprecated` and `modern` api versions for `Orders` stream (airbytehq#34707)
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
…to switch between `deprecated` and `modern` api versions for `Orders` stream (airbytehq#34707)
xiaohansong pushed a commit that referenced this pull request Feb 27, 2024
…to switch between `deprecated` and `modern` api versions for `Orders` stream (#34707)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/recharge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants