[TT-11966/TT-12064] update typo in cooldown period#6266
Merged
Conversation
Contributor
|
API Changes --- prev.txt 2024-05-09 16:12:13.278466911 +0000
+++ current.txt 2024-05-09 16:12:10.114437897 +0000
@@ -4513,7 +4513,7 @@
// An empty value is interpreted as "0s", implying no cool-down.
// It's important to format the string correctly, as invalid formats will
// be considered as 0s/empty.
- CoolDownPeriod time.ReadableDuration `json:"coolDownPeriod" bson:"coolDownPeriod"`
+ CoolDownPeriod time.ReadableDuration `json:"cooldownPeriod" bson:"cooldownPeriod"`
// BodyTemplate is the template to be used for request payload.
BodyTemplate string `json:"bodyTemplate,omitempty" bson:"bodyTemplate,omitempty"`
// Headers are the list of request headers to be used. |
lghiur
approved these changes
May 9, 2024
Contributor
|
PR Description updated to latest commit (95e6af5) |
Contributor
PR Review 🔍
Code feedback: |
Contributor
|
Failed to generate code suggestions for PR |
jeffy-mathew
enabled auto-merge (squash)
May 9, 2024 15:59
jeffy-mathew
disabled auto-merge
May 9, 2024 15:59
jeffy-mathew
enabled auto-merge (squash)
May 9, 2024 15:59
Contributor
💥 CI tests failed 🙈git-stateall okPlease look at the run or in the Checks tab. |
|
nerdydread
pushed a commit
that referenced
this pull request
Sep 6, 2024
### **User description** ## Description fix typo in `coolDownPeriod` json tag. renaming it to `cooldownPeriod` ## Related Issue Parent task: https://tyktech.atlassian.net/browse/TT-11966 Sub task: https://tyktech.atlassian.net/browse/TT-12064 ## 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** Bug fix ___ ### **Description** - Updated the field name from `coolDownPeriod` to `cooldownPeriod` in both Go struct and JSON schema to maintain consistency and correct a typo. - Modified the required fields in the JSON schema to align with the updated field name. ___ ### **Changes walkthrough** 📝 <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Bug fix</strong></td><td><table> <tr> <td> <details> <summary><strong>event.go</strong><dd><code>Update Field Names in WebhookEvent Struct</code> </dd></summary> <hr> apidef/oas/event.go <li>Changed the JSON and BSON field names from <code>coolDownPeriod</code> to <br><code>cooldownPeriod</code>. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6266/files#diff-528a9f5b311ff21c0b3a9b273e61398209ca8b51550327e4d437bba81e49d577">+1/-1</a> </td> </tr> <tr> <td> <details> <summary><strong>x-tyk-api-gateway.json</strong><dd><code>Update JSON Schema for API Gateway</code> </dd></summary> <hr> apidef/oas/schema/x-tyk-api-gateway.json <li>Updated the field name in JSON schema from <code>coolDownPeriod</code> to <br><code>cooldownPeriod</code>.<br> <li> Adjusted the required fields list to reflect the new field name. </details> </td> <td><a href="https://github.com/TykTechnologies/tyk/pull/6266/files#diff-78828969c0c04cc1a776dfc93a8bad3c499a8c83e6169f83e96d090bed3e7dd0">+4/-4</a> </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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.




User description
Description
fix typo in
coolDownPeriodjson tag.renaming it to
cooldownPeriodRelated Issue
Parent task: https://tyktech.atlassian.net/browse/TT-11966
Sub task: https://tyktech.atlassian.net/browse/TT-12064
Motivation and Context
How This Has Been Tested
Screenshots (if appropriate)
Types of changes
Checklist
PR Type
Bug fix
Description
coolDownPeriodtocooldownPeriodin both Go struct and JSON schema to maintain consistency and correct a typo.Changes walkthrough 📝
event.go
Update Field Names in WebhookEvent Structapidef/oas/event.go
coolDownPeriodtocooldownPeriod.x-tyk-api-gateway.json
Update JSON Schema for API Gatewayapidef/oas/schema/x-tyk-api-gateway.json
coolDownPeriodtocooldownPeriod.