Migration guide mentions offline_access_token_expires, but the supported key appears to be expiring_offline_access_tokens
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.9k
- Forks
- 739
- Avg merge
- 21h 2m
- Merged PRs (30d)
- 1
Description
Overview/summary
While following the migration guide for expiring offline access tokens, I noticed a documentation inconsistency.
In docs/shopify_app/sessions.md, the ShopifyAPI::Context.setup example uses expiring_offline_access_tokens: true, but later in the same guide it also mentions offline_access_token_expires: true.
I could not find support for offline_access_token_expires in either shopify_app or shopify_api. The supported key appears to be expiring_offline_access_tokens.
The same offline_access_token_expires naming also appears in CHANGELOG.md, which makes it unclear which configuration key is actually valid.
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 with the configuration example and later reference in docs/shopify_app/sessions.md, then compare them with the supported naming in shopify_app and shopify_api. Check the matching entry in CHANGELOG.md. Done means the migration guide and changelog consistently identify the valid configuration key.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100