Temporarily overwrite the Shopify API version
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.9k
- Forks
- 739
- Avg merge
- 21h 2m
- Merged PRs (30d)
- 1
Description
Overview
In some cases, we will need to make use of an unstable API, while the rest of the time, the app should be using the latest stable version of the API.
A good example is the new app events API.
We would like to leverage this API, but we're not able to, because we need to either configure the ShopifyApp gem to use the unstable API endpoint for everything or we need to write a small API client specifically for accessing the unstable API.
That's not ideal.
I'm not 100% sure how to make this possible, but ideally we would do something like this:
shop.with_shopify_session(api_version: "unstable") do |session|
session.query(query: GET_ORDER, variables: { id: "gid://shopify/Order/123" })
end
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the ShopifyApp session and configuration APIs, especially the existing session.query flow. The change is complete when one session can temporarily use api_version: "unstable" while other requests continue using the configured stable version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rails, ruby
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100