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

Merging to release-5.3.9: [TT-13742] update swagger version (#6802) #6804

Conversation

buger
Copy link
Member

@buger buger commented Dec 20, 2024

User description

TT-13742 update swagger version (#6802)

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

documentation


Description

  • Updated the OpenAPI specification in swagger.yml to reflect the new
    version 5.3.9.
  • This change ensures the API documentation aligns with the latest
    release version.

Changes walkthrough 📝

Relevant files
Documentation
swagger.yml
Update OpenAPI version in `swagger.yml` to 5.3.9                 

swagger.yml

  • Updated the version field in the OpenAPI specification from 5.3.8 to
    5.3.9.
  • No other changes were made to the file.
  • +1/-1     

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


    PR Type

    Documentation


    Description

    • Updated the OpenAPI specification in swagger.yml to reflect the new version 5.3.9.
    • This change ensures the API documentation aligns with the latest release version.

    Changes walkthrough 📝

    Relevant files
    Documentation
    swagger.yml
    Update OpenAPI version in `swagger.yml` to 5.3.9                 

    swagger.yml

  • Updated the version field in the OpenAPI specification from 5.3.8 to
    5.3.9.
  • Ensured the API documentation aligns with the latest release version.
  • +1/-1     

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

    ### **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**
    documentation
    
    
    ___
    
    ### **Description**
    - Updated the OpenAPI specification in `swagger.yml` to reflect the new
    version `5.3.9`.
    - This change ensures the API documentation aligns with the latest
    release version.
    
    
    
    ___
    
    
    
    ### **Changes walkthrough** 📝
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>swagger.yml</strong><dd><code>Update OpenAPI version in
    `swagger.yml` to 5.3.9</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    swagger.yml
    
    <li>Updated the <code>version</code> field in the OpenAPI specification
    from <code>5.3.8</code> to <br><code>5.3.9</code>.<br> <li> No other
    changes were made to the file.<br>
    
    
    </details>
    
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6802/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 88c47d9)
    @buger buger enabled auto-merge (squash) December 20, 2024 18:12
    Copy link
    Contributor

    API Changes

    no api changes detected

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis ✅

    6802 - Fully compliant

    Fully compliant requirements:

    • Update the OpenAPI specification in swagger.yml to reflect the new version 5.3.9.
    • Ensure the API documentation aligns with the latest release version.

    Not compliant requirements:

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

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @buger buger merged commit 84488ed into release-5.3.9 Dec 20, 2024
    35 of 38 checks passed
    @buger buger deleted the merge/release-5.3.9/88c47d961d2498266adea6720aa2e720304399ca branch December 20, 2024 18:26
    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.

    2 participants