Skip to content

[TT-12365] Add new events to validate in x-tyk-api-gateway#6347

Merged
titpetric merged 1 commit into
masterfrom
update/tt-12365/update-trigger-schema-for-events
Jun 14, 2024
Merged

[TT-12365] Add new events to validate in x-tyk-api-gateway#6347
titpetric merged 1 commit into
masterfrom
update/tt-12365/update-trigger-schema-for-events

Conversation

@titpetric

@titpetric titpetric commented Jun 14, 2024

Copy link
Copy Markdown
Contributor

PR Type

enhancement


Description

  • Added new event types RateLimitSmoothingUp and RateLimitSmoothingDown to the x-tyk-api-gateway schema.

Changes walkthrough 📝

Relevant files
Enhancement
x-tyk-api-gateway.json
Add new event types to the x-tyk-api-gateway schema           

apidef/oas/schema/x-tyk-api-gateway.json

  • Added new event types RateLimitSmoothingUp and RateLimitSmoothingDown
    to the enum list.
  • +2/-0     

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

    @github-actions

    Copy link
    Copy Markdown
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5]

    1

    🧪 Relevant tests

    No

    🔒 Security concerns

    No

    ⚡ Key issues to review

    None

    @github-actions

    Copy link
    Copy Markdown
    Contributor

    API Changes

    no api changes detected

    @github-actions

    Copy link
    Copy Markdown
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Improve clarity of new enum values by renaming them

    Consider renaming "RateLimitSmoothingUp" and "RateLimitSmoothingDown" to
    "RateLimitIncrease" and "RateLimitDecrease" respectively for clearer understanding of the
    actions they represent.

    apidef/oas/schema/x-tyk-api-gateway.json [2015-2016]

    -"RateLimitSmoothingUp",
    -"RateLimitSmoothingDown"
    +"RateLimitIncrease",
    +"RateLimitDecrease"
     
    Suggestion importance[1-10]: 7

    Why: The suggestion to rename "RateLimitSmoothingUp" and "RateLimitSmoothingDown" to "RateLimitIncrease" and "RateLimitDecrease" respectively improves the clarity and understanding of the actions they represent. However, it is a minor enhancement and not crucial.

    7

    @titpetric
    titpetric enabled auto-merge (squash) June 14, 2024 09:55
    @github-actions

    Copy link
    Copy Markdown
    Contributor

    💥 CI tests failed 🙈

    git-state

    all ok

    Please look at the run or in the Checks tab.

    @titpetric
    titpetric disabled auto-merge June 14, 2024 10:00
    @sonarqubecloud

    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

    @titpetric
    titpetric merged commit b780c8f into master Jun 14, 2024
    @titpetric
    titpetric deleted the update/tt-12365/update-trigger-schema-for-events branch June 14, 2024 10:23
    @titpetric

    Copy link
    Copy Markdown
    Contributor Author

    /release to release-5.4

    @tykbot

    tykbot Bot commented Jun 14, 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 14, 2024
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Added new event types `RateLimitSmoothingUp` and
    `RateLimitSmoothingDown` to the `x-tyk-api-gateway` schema.
    
    
    ___
    
    
    
    ### **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>x-tyk-api-gateway.json</strong><dd><code>Add new event
    types to the x-tyk-api-gateway schema</code>&nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; </dd></summary>
    <hr>
    
    apidef/oas/schema/x-tyk-api-gateway.json
    <li>Added new event types <code>RateLimitSmoothingUp</code> and
    <code>RateLimitSmoothingDown</code> <br>to the enum list.<br>
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6347/files#diff-78828969c0c04cc1a776dfc93a8bad3c499a8c83e6169f83e96d090bed3e7dd0">+2/-0</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
    
    Co-authored-by: Tit Petric <[email protected]>
    (cherry picked from commit b780c8f)
    @tykbot

    tykbot Bot commented Jun 14, 2024

    Copy link
    Copy Markdown

    @titpetric Succesfully merged PR

    @titpetric

    Copy link
    Copy Markdown
    Contributor Author

    /release to release-5.4.0

    @tykbot

    tykbot Bot commented Jun 14, 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 14, 2024
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Added new event types `RateLimitSmoothingUp` and
    `RateLimitSmoothingDown` to the `x-tyk-api-gateway` schema.
    
    
    ___
    
    
    
    ### **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>x-tyk-api-gateway.json</strong><dd><code>Add new event
    types to the x-tyk-api-gateway schema</code>&nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; </dd></summary>
    <hr>
    
    apidef/oas/schema/x-tyk-api-gateway.json
    <li>Added new event types <code>RateLimitSmoothingUp</code> and
    <code>RateLimitSmoothingDown</code> <br>to the enum list.<br>
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6347/files#diff-78828969c0c04cc1a776dfc93a8bad3c499a8c83e6169f83e96d090bed3e7dd0">+2/-0</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
    
    Co-authored-by: Tit Petric <[email protected]>
    (cherry picked from commit b780c8f)
    @tykbot

    tykbot Bot commented Jun 14, 2024

    Copy link
    Copy Markdown

    @titpetric Succesfully merged PR

    buger added a commit that referenced this pull request Jun 14, 2024
    …k-api-gateway (#6347)
    
    [TT-12365] Add new events to validate in x-tyk-api-gateway (#6347)
    
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Added new event types `RateLimitSmoothingUp` and
    `RateLimitSmoothingDown` to the `x-tyk-api-gateway` schema.
    
    
    ___
    
    
    
    ### **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>x-tyk-api-gateway.json</strong><dd><code>Add new event
    types to the x-tyk-api-gateway schema</code>&nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; </dd></summary>
    <hr>
    
    apidef/oas/schema/x-tyk-api-gateway.json
    <li>Added new event types <code>RateLimitSmoothingUp</code> and
    <code>RateLimitSmoothingDown</code> <br>to the enum list.<br>
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6347/files#diff-78828969c0c04cc1a776dfc93a8bad3c499a8c83e6169f83e96d090bed3e7dd0">+2/-0</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
    
    Co-authored-by: Tit Petric <[email protected]>
    buger added a commit that referenced this pull request Jun 14, 2024
    …tyk-api-gateway (#6347)
    
    [TT-12365] Add new events to validate in x-tyk-api-gateway (#6347)
    
    ### **PR Type**
    enhancement
    
    
    ___
    
    ### **Description**
    - Added new event types `RateLimitSmoothingUp` and
    `RateLimitSmoothingDown` to the `x-tyk-api-gateway` schema.
    
    
    ___
    
    
    
    ### **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>x-tyk-api-gateway.json</strong><dd><code>Add new event
    types to the x-tyk-api-gateway schema</code>&nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; </dd></summary>
    <hr>
    
    apidef/oas/schema/x-tyk-api-gateway.json
    <li>Added new event types <code>RateLimitSmoothingUp</code> and
    <code>RateLimitSmoothingDown</code> <br>to the enum list.<br>
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6347/files#diff-78828969c0c04cc1a776dfc93a8bad3c499a8c83e6169f83e96d090bed3e7dd0">+2/-0</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
    
    Co-authored-by: Tit Petric <[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.

    2 participants