tyk-docs
tyk-docs copied to clipboard
Fix versioning bug
User description
Fix versioning bug to mention that if a version identifier header is not provided then the default version is used
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Fix versioning bug to mention that if a version identifier header is not provided then the default version is used
Screenshots (if appropriate)
Checklist
- [x] I have added a preview link to the PR description.
- [x] I have reviewed the guidelines for contributing to this repository.
- [x] I have read the technical guidelines for contributing to this repository.
- [x] Make sure you have started your change off our latest
master
. - [x] I labelled the PR
PR Type
bug_fix
Description
- Corrected an error in the documentation regarding the default API version selection when no version identifier is provided.
Changes walkthrough 📝
Relevant files | |||
---|---|---|---|
Documentation |
|
💡 PR-Agent usage: Comment
/help
on the PR to get a list of all available PR-Agent tools and their descriptions
PR Description updated to latest commit (https://github.com/TykTechnologies/tyk-docs/commit/bafb60a89c1ef4d57b31aa7ac0af1e291ef70be1)
PR Review 🔍
(Review updated until commit https://github.com/TykTechnologies/tyk-docs/commit/bafb60a89c1ef4d57b31aa7ac0af1e291ef70be1)
⏱️ Estimated effort to review [1-5] |
1, because the PR involves a simple text change in the documentation which is straightforward to review. |
🧪 Relevant tests |
No |
⚡ Possible issues |
No |
🔒 Security concerns |
No |
Code feedback:
PR Code Suggestions ✨
No code suggestions found for PR.
PS. Pls add /docs/nightly to the end of url
Name | Link |
---|---|
Latest commit | 86b42e293f3a8bb706a9a5845d02055e1cc70e84 |
Latest deploy log | https://app.netlify.com/sites/tyk-docs/deploys/6647751b864e1a00080db9e7 |
Deploy Preview | https://deploy-preview-4631--tyk-docs.netlify.app |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
PR Description updated to latest commit (https://github.com/TykTechnologies/tyk-docs/commit/bafb60a89c1ef4d57b31aa7ac0af1e291ef70be1)
Persistent review updated to latest commit https://github.com/TykTechnologies/tyk-docs/commit/bafb60a89c1ef4d57b31aa7ac0af1e291ef70be1
PR Code Suggestions ✨
Category | Suggestion | Score |
Possible issue |
Clarify the condition under which the default API version is selected to avoid user confusionThe added line in the documentation introduces a potential ambiguity regarding the tyk-docs/content/getting-started/key-concepts/oas-versioning.md [55]
Suggestion importance[1-10]: 8Why: The suggestion correctly identifies a significant change in the documentation that could lead to user confusion regarding when the default API version is set. This clarification is crucial for correct API usage and understanding. | 8 |
/release to release-5.3
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR
/release to release-5.2
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR
/release to release-5.1
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR
/release to release-5
Working on it! Note that it can take a few minutes.
@dcs3spp Succesfully merged PR