set version field to default to v5.0 #80
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
royalfig
changed the title
|
The only concern with this PR is this: Is there any risk to defaulting to |
daniellockyer
requested review from
naz
and removed request for
daniellockyer
naz
approved these changes
Jan 23, 2023
There was a problem hiding this comment.
The is no risk defaulting to v5.0, it's a correct expected behavior. In the next version of the SDK we might drop the "canary" altogether, so it's expected for all clients to migrate now 👍
As long as the "themes" API does not have breaking changes the v5.0 is fine to pass. And when there are breaking changes or we start serving back-compatible responses, we will notify the instance owner of a "broken client".
This was referenced Jan 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With the transition to an unversioned API, I removed
version: 'canary'from theGhostAdminApiconfig, as it's optional and was generating warnings in the Action logs. These warnings were causing confusion among users.Without the version field, the API client will default to the unversioned path.
Ref: https://forum.ghost.org/t/github-actions-error/34731/8 #76 #79