Skip to content

[TT-12312] update openapi spec version#6323

Merged
jeffy-mathew merged 1 commit into
masterfrom
chores/TT-12312/update-openapi-spec-version
Jun 6, 2024
Merged

[TT-12312] update openapi spec version#6323
jeffy-mathew merged 1 commit into
masterfrom
chores/TT-12312/update-openapi-spec-version

Conversation

@jeffy-mathew

@jeffy-mathew jeffy-mathew commented Jun 6, 2024

Copy link
Copy Markdown
Contributor

User description

Description

Update version in openapi spec.

Related Issue

https://tyktech.atlassian.net/browse/TT-12312

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

  • I ensured that the documentation is up to date
  • I explained why this PR updates go.mod in detail with reasoning why it's required
  • I would like a code coverage CI quality gate exception and have explained why

PR Type

enhancement, documentation


Description

  • Updated the OpenAPI specification version from 5.3.0 to 5.4.0 in the swagger.yml file.
  • Ensured the documentation reflects the latest API version for better integration and automation.

Changes walkthrough 📝

Relevant files
Enhancement
swagger.yml
Update OpenAPI spec version to 5.4.0                                         

swagger.yml

  • Updated the OpenAPI spec version from 5.3.0 to 5.4.0.
+1/-1     

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

@jeffy-mathew
jeffy-mathew requested a review from lghiur June 6, 2024 11:59
@github-actions

github-actions Bot commented Jun 6, 2024

Copy link
Copy Markdown
Contributor

PR Review 🔍

⏱️ Estimated effort to review [1-5]

1, because the PR involves a simple version update in a YAML file, which is straightforward and requires minimal effort to review.

🧪 Relevant tests

No

⚡ Possible issues

No

🔒 Security concerns

No

Code feedback:

@github-actions

github-actions Bot commented Jun 6, 2024

Copy link
Copy Markdown
Contributor

API Changes

no api changes detected

@github-actions

github-actions Bot commented Jun 6, 2024

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Possible issue
Ensure the API version matches the OpenAPI specification version if required

Ensure that the version number in the version field matches the OpenAPI specification
version if they are intended to be synchronized. If the API's version is meant to be
independent and only represents the API's release version, then this is fine as is.
However, if it should match the OpenAPI spec version (which is still at 3.0.0), consider
adjusting it or clarifying this in the documentation to avoid confusion.

swagger.yml [4]

-version: 5.4.0
+version: 3.0.0  # Assuming it should match the OpenAPI spec version
 
Suggestion importance[1-10]: 4

Why: The suggestion is valid in terms of ensuring clarity between the API version and the OpenAPI spec version. However, it is not necessarily a critical issue and might be more of a documentation clarification rather than a code change. The suggestion also assumes a requirement that may not be applicable.

4

@jeffy-mathew
jeffy-mathew enabled auto-merge (squash) June 6, 2024 12:04
@sonarqubecloud

sonarqubecloud Bot commented Jun 6, 2024

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@jeffy-mathew
jeffy-mathew merged commit 874f470 into master Jun 6, 2024
@jeffy-mathew
jeffy-mathew deleted the chores/TT-12312/update-openapi-spec-version branch June 6, 2024 12:20
@jeffy-mathew

Copy link
Copy Markdown
Contributor Author

/release to release-5.4

@jeffy-mathew

Copy link
Copy Markdown
Contributor Author

/release to release-5.4.0

@tykbot

tykbot Bot commented Jun 6, 2024

Copy link
Copy Markdown

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

1 similar comment
@tykbot

tykbot Bot commented Jun 6, 2024

Copy link
Copy Markdown

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

tykbot Bot pushed a commit that referenced this pull request Jun 6, 2024
### **User description**
<!-- Provide a general summary of your changes in the Title above -->

## Description

Update version in openapi spec.

## Related Issue

https://tyktech.atlassian.net/browse/TT-12312

## Motivation and Context

<!-- Why is this change required? What problem does it solve? -->

## How This Has Been Tested

<!-- Please describe in detail how you tested your changes -->
<!-- Include details of your testing environment, and the tests -->
<!-- you ran to see how your change affects other areas of the code,
etc. -->
<!-- This information is helpful for reviewers and QA. -->

## Screenshots (if appropriate)

## Types of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Refactoring or add test (improvements in base code or adds test
coverage to functionality)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply -->
<!-- If there are no documentation updates required, mark the item as
checked. -->
<!-- Raise up any additional concerns not covered by the checklist. -->

- [ ] I ensured that the documentation is up to date
- [ ] I explained why this PR updates go.mod in detail with reasoning
why it's required
- [ ] I would like a code coverage CI quality gate exception and have
explained why


___

### **PR Type**
enhancement, documentation


___

### **Description**
- Updated the OpenAPI specification version from 5.3.0 to 5.4.0 in the
`swagger.yml` file.
- Ensured the documentation reflects the latest API version for better
integration and automation.


___



### **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 OpenAPI spec
version to 5.4.0</code>&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
- Updated the OpenAPI spec version from 5.3.0 to 5.4.0.



</details>
    

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6323/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    
</table></td></tr></tr></tbody></table>

___

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

(cherry picked from commit 874f470)
@tykbot

tykbot Bot commented Jun 6, 2024

Copy link
Copy Markdown

@jeffy-mathew Succesfully merged PR

tykbot Bot pushed a commit that referenced this pull request Jun 6, 2024
### **User description**
<!-- Provide a general summary of your changes in the Title above -->

## Description

Update version in openapi spec.

## Related Issue

https://tyktech.atlassian.net/browse/TT-12312

## Motivation and Context

<!-- Why is this change required? What problem does it solve? -->

## How This Has Been Tested

<!-- Please describe in detail how you tested your changes -->
<!-- Include details of your testing environment, and the tests -->
<!-- you ran to see how your change affects other areas of the code,
etc. -->
<!-- This information is helpful for reviewers and QA. -->

## Screenshots (if appropriate)

## Types of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Refactoring or add test (improvements in base code or adds test
coverage to functionality)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply -->
<!-- If there are no documentation updates required, mark the item as
checked. -->
<!-- Raise up any additional concerns not covered by the checklist. -->

- [ ] I ensured that the documentation is up to date
- [ ] I explained why this PR updates go.mod in detail with reasoning
why it's required
- [ ] I would like a code coverage CI quality gate exception and have
explained why


___

### **PR Type**
enhancement, documentation


___

### **Description**
- Updated the OpenAPI specification version from 5.3.0 to 5.4.0 in the
`swagger.yml` file.
- Ensured the documentation reflects the latest API version for better
integration and automation.


___



### **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 OpenAPI spec
version to 5.4.0</code>&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
- Updated the OpenAPI spec version from 5.3.0 to 5.4.0.



</details>
    

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6323/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    
</table></td></tr></tr></tbody></table>

___

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

(cherry picked from commit 874f470)
@tykbot

tykbot Bot commented Jun 6, 2024

Copy link
Copy Markdown

@jeffy-mathew Succesfully merged PR

buger added a commit that referenced this pull request Jun 6, 2024
[TT-12312] update openapi spec version (#6323)

### **User description**
<!-- Provide a general summary of your changes in the Title above -->

## Description

Update version in openapi spec.

## Related Issue

https://tyktech.atlassian.net/browse/TT-12312

## Motivation and Context

<!-- Why is this change required? What problem does it solve? -->

## How This Has Been Tested

<!-- Please describe in detail how you tested your changes -->
<!-- Include details of your testing environment, and the tests -->
<!-- you ran to see how your change affects other areas of the code,
etc. -->
<!-- This information is helpful for reviewers and QA. -->

## Screenshots (if appropriate)

## Types of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Refactoring or add test (improvements in base code or adds test
coverage to functionality)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply -->
<!-- If there are no documentation updates required, mark the item as
checked. -->
<!-- Raise up any additional concerns not covered by the checklist. -->

- [ ] I ensured that the documentation is up to date
- [ ] I explained why this PR updates go.mod in detail with reasoning
why it's required
- [ ] I would like a code coverage CI quality gate exception and have
explained why


___

### **PR Type**
enhancement, documentation


___

### **Description**
- Updated the OpenAPI specification version from 5.3.0 to 5.4.0 in the
`swagger.yml` file.
- Ensured the documentation reflects the latest API version for better
integration and automation.


___



### **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 OpenAPI spec
version to 5.4.0</code>&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
- Updated the OpenAPI spec version from 5.3.0 to 5.4.0.



</details>
    

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6323/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    
</table></td></tr></tr></tbody></table>

___

> 💡 **PR-Agent usage**:
>Comment `/help` on the PR to get a list of all available PR-Agent tools
and their descriptions
buger added a commit that referenced this pull request Jun 6, 2024
[TT-12312] update openapi spec version (#6323)

### **User description**
<!-- Provide a general summary of your changes in the Title above -->

## Description

Update version in openapi spec.

## Related Issue

https://tyktech.atlassian.net/browse/TT-12312

## Motivation and Context

<!-- Why is this change required? What problem does it solve? -->

## How This Has Been Tested

<!-- Please describe in detail how you tested your changes -->
<!-- Include details of your testing environment, and the tests -->
<!-- you ran to see how your change affects other areas of the code,
etc. -->
<!-- This information is helpful for reviewers and QA. -->

## Screenshots (if appropriate)

## Types of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Refactoring or add test (improvements in base code or adds test
coverage to functionality)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply -->
<!-- If there are no documentation updates required, mark the item as
checked. -->
<!-- Raise up any additional concerns not covered by the checklist. -->

- [ ] I ensured that the documentation is up to date
- [ ] I explained why this PR updates go.mod in detail with reasoning
why it's required
- [ ] I would like a code coverage CI quality gate exception and have
explained why


___

### **PR Type**
enhancement, documentation


___

### **Description**
- Updated the OpenAPI specification version from 5.3.0 to 5.4.0 in the
`swagger.yml` file.
- Ensured the documentation reflects the latest API version for better
integration and automation.


___



### **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 OpenAPI spec
version to 5.4.0</code>&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
- Updated the OpenAPI spec version from 5.3.0 to 5.4.0.



</details>
    

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6323/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    
</table></td></tr></tr></tbody></table>

___

> 💡 **PR-Agent usage**:
>Comment `/help` on the PR to get a list of all available PR-Agent tools
and their descriptions
nerdydread pushed a commit that referenced this pull request Sep 6, 2024
### **User description**
<!-- Provide a general summary of your changes in the Title above -->

## Description

Update version in openapi spec.

## Related Issue

https://tyktech.atlassian.net/browse/TT-12312

## Motivation and Context

<!-- Why is this change required? What problem does it solve? -->

## How This Has Been Tested

<!-- Please describe in detail how you tested your changes -->
<!-- Include details of your testing environment, and the tests -->
<!-- you ran to see how your change affects other areas of the code,
etc. -->
<!-- This information is helpful for reviewers and QA. -->

## Screenshots (if appropriate)

## Types of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Refactoring or add test (improvements in base code or adds test
coverage to functionality)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply -->
<!-- If there are no documentation updates required, mark the item as
checked. -->
<!-- Raise up any additional concerns not covered by the checklist. -->

- [ ] I ensured that the documentation is up to date
- [ ] I explained why this PR updates go.mod in detail with reasoning
why it's required
- [ ] I would like a code coverage CI quality gate exception and have
explained why


___

### **PR Type**
enhancement, documentation


___

### **Description**
- Updated the OpenAPI specification version from 5.3.0 to 5.4.0 in the
`swagger.yml` file.
- Ensured the documentation reflects the latest API version for better
integration and automation.


___



### **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 OpenAPI spec
version to 5.4.0</code>&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
- Updated the OpenAPI spec version from 5.3.0 to 5.4.0.



</details>
    

  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6323/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    
</table></td></tr></tr></tbody></table>

___

> 💡 **PR-Agent usage**:
>Comment `/help` on the PR to get a list of all available PR-Agent tools
and their descriptions
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