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 REST API deprecation notice to README #752

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

nasudadada
Copy link
Contributor

Add REST API deprecation notice to README

WHY are these changes introduced?

Related to #751 #745

According to Shopify's announcement, the REST Admin API will become legacy as of October 1, 2024. This change adds necessary warnings to the README to inform users about the upcoming deprecation and migration requirements.

WHAT is this pull request doing?

  • Adds deprecation notice to the Making API Calls section
  • Adds deprecation notice to the Advanced Usage section
  • Includes timeline information (February 2025 for public apps, April 2025 for custom apps)
  • Adds link to Shopify's official migration guide
  • Updates code examples with deprecation comments

Checklist

  • [ ] I have updated the CHANGELOG (if applicable)
  • I have followed the Shopify Python guide

@nasudadada
Copy link
Contributor Author

I have signed the CLA

Copy link
Contributor

@sle-c sle-c left a comment

Choose a reason for hiding this comment

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

thank you for adding this

@nasudadada
Copy link
Contributor Author

@sle-c
Thank you for the review and approval!

I notice the pre-commit check is failing and blocking the merge. I'll create a separate issue to address this.

@nasudadada
Copy link
Contributor Author

@sle-c The CI check is failing, but I believe this is due to the CI issue that has already been fixed in the #755.
What would be the preferred way to re-trigger the CI checks in this case?

Options I'm considering:

  1. Adding an empty commit
  2. Merging upstream changes
  3. Waiting for maintainer's intervention

Please advise on the best approach for this project.

@sle-c
Copy link
Contributor

sle-c commented Jan 14, 2025

Hi @nasudadada ,

In this case I'll just merge the PR because it's a readme change. Thank you for your contribution.

Si

@sle-c sle-c merged commit 92aa042 into Shopify:main Jan 14, 2025
6 of 7 checks passed
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.

2 participants