tyk-docs icon indicating copy to clipboard operation
tyk-docs copied to clipboard

Fix versioning bug

Open dcs3spp opened this issue 9 months ago • 7 comments

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

preview

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
oas-versioning.md
Fix Incorrect Versioning Documentation                                     

tyk-docs/content/getting-started/key-concepts/oas-versioning.md

  • Corrected the description of default versioning behavior when no
    version identifier is provided in the request.
  • +1/-1     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    dcs3spp avatar May 14 '24 12:05 dcs3spp

    PR Description updated to latest commit (https://github.com/TykTechnologies/tyk-docs/commit/bafb60a89c1ef4d57b31aa7ac0af1e291ef70be1)

    github-actions[bot] avatar May 14 '24 12:05 github-actions[bot]

    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:

    github-actions[bot] avatar May 14 '24 12:05 github-actions[bot]

    PR Code Suggestions ✨

    No code suggestions found for PR.

    github-actions[bot] avatar May 14 '24 12:05 github-actions[bot]

    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...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    netlify[bot] avatar May 14 '24 12:05 netlify[bot]

    PR Description updated to latest commit (https://github.com/TykTechnologies/tyk-docs/commit/bafb60a89c1ef4d57b31aa7ac0af1e291ef70be1)

    github-actions[bot] avatar May 14 '24 13:05 github-actions[bot]

    Persistent review updated to latest commit https://github.com/TykTechnologies/tyk-docs/commit/bafb60a89c1ef4d57b31aa7ac0af1e291ef70be1

    github-actions[bot] avatar May 14 '24 13:05 github-actions[bot]

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Clarify the condition under which the default API version is selected to avoid user confusion

    The added line in the documentation introduces a potential ambiguity regarding the
    condition under which the default API version is selected. The original text specifies
    that the default is set when a versioning identifier is provided, but the new text
    suggests it applies when the identifier is not provided. This change could confuse users
    about the actual behavior of the system. It is recommended to clarify this condition to
    accurately reflect the system's functionality.

    tyk-docs/content/getting-started/key-concepts/oas-versioning.md [55]

    -- Within the `versioning` section, you can set which of the APIs (versions) can be the default one if a versioning identifier (i.e. header) is not provided with the request. By default, this is set to `self`, which tells your Tyk Gateway that the Base API is the default version. Otherwise, you can provide the API ID of the API you want to be the default version.
    +- Within the `versioning` section, you can set which of the APIs (versions) will be the default one when a versioning identifier (i.e. header) is not provided with the request. By default, this is set to `self`, which tells your Tyk Gateway that the Base API is the default version. Otherwise, you can specify the API ID of the API you want to be the default version.
     
    
    Suggestion importance[1-10]: 8

    Why: 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

    github-actions[bot] avatar May 14 '24 13:05 github-actions[bot]

    /release to release-5.3

    dcs3spp avatar May 17 '24 15:05 dcs3spp

    Working on it! Note that it can take a few minutes.

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]

    @dcs3spp Succesfully merged PR

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]

    /release to release-5.2

    dcs3spp avatar May 17 '24 15:05 dcs3spp

    Working on it! Note that it can take a few minutes.

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]

    @dcs3spp Succesfully merged PR

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]

    /release to release-5.1

    dcs3spp avatar May 17 '24 15:05 dcs3spp

    Working on it! Note that it can take a few minutes.

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]

    @dcs3spp Succesfully merged PR

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]

    /release to release-5

    dcs3spp avatar May 17 '24 15:05 dcs3spp

    Working on it! Note that it can take a few minutes.

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]

    @dcs3spp Succesfully merged PR

    tykbot[bot] avatar May 17 '24 15:05 tykbot[bot]