Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TT-13742] Update swagger to 5.7.1 #6803

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

lghiur
Copy link
Member

@lghiur lghiur commented Dec 20, 2024

User description

TT-13742
Summary Update Tyk API documentation for 5.3.9/5.7.1 release
Type Task Task
Status In Dev
Points N/A
Labels -

https://tyktech.atlassian.net/browse/TT-13742 updates swagger version


PR Type

enhancement


Description

  • Updated the Swagger API documentation to reflect the new version 5.7.1.
  • This change ensures the API documentation is aligned with the latest release.

Changes walkthrough 📝

Relevant files
Enhancement
swagger.yml
Update Swagger API version to 5.7.1                                           

swagger.yml

  • Updated the version field in the Swagger API documentation from 5.7.0
    to 5.7.1.
  • +1/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @buger
    Copy link
    Member

    buger commented Dec 20, 2024

    Let's make that PR title a 💯 shall we? 💪

    Your PR title and story title look slightly different. Just checking in to know if it was intentional!

    Story Title Update Tyk API documentation for 5.3.9/5.7.1 release
    PR Title [TT-13742] Update swagger to 5.7.1

    Check out this guide to learn more about PR best-practices.

    Copy link
    Contributor

    Swagger Changes

         _        __  __
       _| |_   _ / _|/ _|  between swagger-prev.yml
      ± value change
     / _' | | | | |_| |_       and swagger-current.yml
     \__,_|\__, |_| |_|   returned one difference
    info.version
    | (_| | |_| |  _|  _|

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    API Changes

    no api changes detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    Quality Gate Failed Quality Gate failed

    Failed conditions
    1 Security Hotspot

    See analysis details on SonarQube Cloud

    @lghiur lghiur merged commit d46c967 into master Dec 20, 2024
    41 of 43 checks passed
    @lghiur lghiur deleted the TT-13742-update-swagger-version-5.7.1 branch December 20, 2024 18:13
    @lghiur
    Copy link
    Member Author

    lghiur commented Dec 20, 2024

    /release to release-5.7

    @lghiur
    Copy link
    Member Author

    lghiur commented Dec 20, 2024

    /release to release-5.7.1

    Copy link

    tykbot bot commented Dec 20, 2024

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

    1 similar comment
    Copy link

    tykbot bot commented Dec 20, 2024

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

    Copy link

    tykbot bot commented Dec 20, 2024

    Still working...

    1 similar comment
    Copy link

    tykbot bot commented Dec 20, 2024

    Still working...

    tykbot bot pushed a commit that referenced this pull request Dec 20, 2024
    ### **User description**
    <details open>
    <summary><a href="https://tyktech.atlassian.net/browse/TT-13742"
    title="TT-13742" target="_blank">TT-13742</a></summary>
      <br />
      <table>
        <tr>
          <th>Summary</th>
          <td>Update Tyk API documentation for 5.3.9/5.7.1 release</td>
        </tr>
        <tr>
          <th>Type</th>
          <td>
    <img alt="Task"
    src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium"
    />
            Task
          </td>
        </tr>
        <tr>
          <th>Status</th>
          <td>In Dev</td>
        </tr>
        <tr>
          <th>Points</th>
          <td>N/A</td>
        </tr>
        <tr>
          <th>Labels</th>
          <td>-</td>
        </tr>
      </table>
    </details>
    <!--
      do not remove this marker as it will break jira-lint's functionality.
      added_by_jira_lint
    -->
    
    ---
    
    https://tyktech.atlassian.net/browse/TT-13742 updates swagger version
    
    
    ___
    
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Updated the Swagger API documentation to reflect the new version
    `5.7.1`.
    - This change ensures the API documentation is aligned with the latest
    release.
    
    
    
    ___
    
    
    
    ### **Changes walkthrough** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>swagger.yml</strong><dd><code>Update Swagger API
    version to 5.7.1</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    swagger.yml
    
    <li>Updated the <code>version</code> field in the Swagger API
    documentation from <code>5.7.0</code> <br>to <code>5.7.1</code>.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6803/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    
    </tr>
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
    request to receive relevant information
    
    (cherry picked from commit d46c967)
    tykbot bot pushed a commit that referenced this pull request Dec 20, 2024
    ### **User description**
    <details open>
    <summary><a href="https://tyktech.atlassian.net/browse/TT-13742"
    title="TT-13742" target="_blank">TT-13742</a></summary>
      <br />
      <table>
        <tr>
          <th>Summary</th>
          <td>Update Tyk API documentation for 5.3.9/5.7.1 release</td>
        </tr>
        <tr>
          <th>Type</th>
          <td>
    <img alt="Task"
    src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium"
    />
            Task
          </td>
        </tr>
        <tr>
          <th>Status</th>
          <td>In Dev</td>
        </tr>
        <tr>
          <th>Points</th>
          <td>N/A</td>
        </tr>
        <tr>
          <th>Labels</th>
          <td>-</td>
        </tr>
      </table>
    </details>
    <!--
      do not remove this marker as it will break jira-lint's functionality.
      added_by_jira_lint
    -->
    
    ---
    
    https://tyktech.atlassian.net/browse/TT-13742 updates swagger version
    
    
    ___
    
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Updated the Swagger API documentation to reflect the new version
    `5.7.1`.
    - This change ensures the API documentation is aligned with the latest
    release.
    
    
    
    ___
    
    
    
    ### **Changes walkthrough** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>swagger.yml</strong><dd><code>Update Swagger API
    version to 5.7.1</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    swagger.yml
    
    <li>Updated the <code>version</code> field in the Swagger API
    documentation from <code>5.7.0</code> <br>to <code>5.7.1</code>.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6803/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    
    </tr>
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
    request to receive relevant information
    
    (cherry picked from commit d46c967)
    lghiur added a commit that referenced this pull request Dec 20, 2024
    …6805)
    
    ### **User description**
    [TT-13742] Update swagger to 5.7.1 (#6803)
    
    ### **User description**
    <details open>
    <summary><a href="https://tyktech.atlassian.net/browse/TT-13742"
    title="TT-13742" target="_blank">TT-13742</a></summary>
      <br />
      <table>
        <tr>
          <th>Summary</th>
          <td>Update Tyk API documentation for 5.3.9/5.7.1 release</td>
        </tr>
        <tr>
          <th>Type</th>
          <td>
    <img alt="Task"
    
    src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium"
    />
            Task
          </td>
        </tr>
        <tr>
          <th>Status</th>
          <td>In Dev</td>
        </tr>
        <tr>
          <th>Points</th>
          <td>N/A</td>
        </tr>
        <tr>
          <th>Labels</th>
          <td>-</td>
        </tr>
      </table>
    </details>
    <!--
      do not remove this marker as it will break jira-lint's functionality.
      added_by_jira_lint
    -->
    
    ---
    
    https://tyktech.atlassian.net/browse/TT-13742 updates swagger version
    
    
    ___
    
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Updated the Swagger API documentation to reflect the new version
    `5.7.1`.
    - This change ensures the API documentation is aligned with the latest
    release.
    
    
    
    ___
    
    
    
    ### **Changes walkthrough** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>swagger.yml</strong><dd><code>Update Swagger API
    version to 5.7.1</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    swagger.yml
    
    <li>Updated the <code>version</code> field in the Swagger API
    documentation from <code>5.7.0</code> <br>to <code>5.7.1</code>.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    
    href="https://github.com/TykTechnologies/tyk/pull/6803/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    
    </tr>
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
    request to receive relevant information
    
    [TT-13742]:
    https://tyktech.atlassian.net/browse/TT-13742?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
    
    
    ___
    
    ### **PR Type**
    Enhancement
    
    
    ___
    
    ### **Description**
    - Updated the Swagger API documentation to reflect the new version
    `5.7.1`.
    - Ensures the API documentation is aligned with the latest release.
    
    
    
    ___
    
    
    
    ### **Changes walkthrough** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>swagger.yml</strong><dd><code>Update Swagger API
    version to 5.7.1</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    swagger.yml
    
    <li>Updated the <code>version</code> field in the Swagger API
    documentation from <code>5.7.0</code> <br>to <code>5.7.1</code>.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6805/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    
    </tr>
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
    request to receive relevant information
    
    Co-authored-by: Laurentiu <[email protected]>
    lghiur added a commit that referenced this pull request Dec 20, 2024
    …6806)
    
    ### **User description**
    [TT-13742] Update swagger to 5.7.1 (#6803)
    
    ### **User description**
    <details open>
    <summary><a href="https://tyktech.atlassian.net/browse/TT-13742"
    title="TT-13742" target="_blank">TT-13742</a></summary>
      <br />
      <table>
        <tr>
          <th>Summary</th>
          <td>Update Tyk API documentation for 5.3.9/5.7.1 release</td>
        </tr>
        <tr>
          <th>Type</th>
          <td>
    <img alt="Task"
    
    src="https://tyktech.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium"
    />
            Task
          </td>
        </tr>
        <tr>
          <th>Status</th>
          <td>In Dev</td>
        </tr>
        <tr>
          <th>Points</th>
          <td>N/A</td>
        </tr>
        <tr>
          <th>Labels</th>
          <td>-</td>
        </tr>
      </table>
    </details>
    <!--
      do not remove this marker as it will break jira-lint's functionality.
      added_by_jira_lint
    -->
    
    ---
    
    https://tyktech.atlassian.net/browse/TT-13742 updates swagger version
    
    
    ___
    
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Updated the Swagger API documentation to reflect the new version
    `5.7.1`.
    - This change ensures the API documentation is aligned with the latest
    release.
    
    
    
    ___
    
    
    
    ### **Changes walkthrough** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>swagger.yml</strong><dd><code>Update Swagger API
    version to 5.7.1</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    swagger.yml
    
    <li>Updated the <code>version</code> field in the Swagger API
    documentation from <code>5.7.0</code> <br>to <code>5.7.1</code>.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    
    href="https://github.com/TykTechnologies/tyk/pull/6803/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    
    </tr>
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
    request to receive relevant information
    
    [TT-13742]:
    https://tyktech.atlassian.net/browse/TT-13742?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
    
    
    ___
    
    ### **PR Type**
    Enhancement
    
    
    ___
    
    ### **Description**
    - Updated the Swagger API documentation to reflect the new version
    `5.7.1`.
    - Ensured the API documentation is aligned with the latest release.
    
    
    
    ___
    
    
    
    ### **Changes walkthrough** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>swagger.yml</strong><dd><code>Update Swagger API
    version to 5.7.1</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    swagger.yml
    
    <li>Updated the <code>version</code> field in the Swagger API
    documentation from <code>5.7.0</code> <br>to <code>5.7.1</code>.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6806/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    
    </tr>
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
    request to receive relevant information
    
    Co-authored-by: Laurentiu <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants