Skip to content

Commit

Permalink
[TT-12635] Update swagger.yml with ExtendedPathsSet.RateLimitMeta (#6417
Browse files Browse the repository at this point in the history
)

### **User description**
https://tyktech.atlassian.net/browse/TT-12635


___

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


___

### **Description**
- Updated the API version in `swagger.yml` from 5.4.0 to 5.5.0.
- Added a new `RateLimitMeta` object definition to configure rate limits
per API path.
- Included a `rate_limit` property in the `ExtendedPathsSet` object,
referencing the new `RateLimitMeta`.


___



### **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>Add RateLimitMeta and
update API version</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; </dd></summary>
<hr>

swagger.yml

<li>Updated API version from 5.4.0 to 5.5.0<br> <li> Added
<code>RateLimitMeta</code> object definition<br> <li> Included
<code>rate_limit</code> property in <code>ExtendedPathsSet</code><br>


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6417/files#diff-8f3c4cb253eee09ae2401daa7279a8bbfbfd4168bb579c3ac0ee5c672d63bb2c">+28/-1</a>&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]>
  • Loading branch information
titpetric and Tit Petric authored Jul 22, 2024
1 parent be10f5b commit 1c5a54c
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 6 deletions.
12 changes: 8 additions & 4 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@
/ci/ @TykTechnologies/devops
.github/workflows/release.yml @TykTechnologies/devops

# Core API Squad ownership of plugin compiler and related tests.
# Core API Squad ownership of CI test pipeline and developer tooling.

/smoke-tests/ @TykTechnologies/core-api-squad
/ci/tests/ @TykTechnologies/core-api-squad
/ci/images/plugin-compiler/ @TykTechnologies/core-api-squad
.github/workflows/ci-tests.yml @TykTechnologies/core-api-squad
.github/workflows/release-tests.yml @TykTechnologies/core-api-squad
/.taskfiles/ @TykTechnologies/core-api-squad
/Dockerfile @TykTechnologies/core-api-squad
/docker/ @TykTechnologies/core-api-squad
/Makefile @TykTechnologies/core-api-squad
/Taskfile.yml @TykTechnologies/core-api-squad
/docker-compose.yml @TykTechnologies/core-api-squad

# Core API Squad ownership of plugin compiler and related tests.

/smoke-tests/ @TykTechnologies/core-api-squad
/ci/tests/ @TykTechnologies/core-api-squad
/ci/images/plugin-compiler/ @TykTechnologies/core-api-squad
2 changes: 1 addition & 1 deletion internal/build/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package build
var (
// Version contains the tagged gateway version. It may contain a `rc` suffix,
// which may be delimited with `-rc` or any other suffix. Follows Semver+Tag.
Version = "v5.3.0-dev"
Version = "v5.5.0-dev"

// BuiltBy contains the environment name from the build (goreleaser).
BuiltBy string = "dev"
Expand Down
29 changes: 28 additions & 1 deletion swagger.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: Tyk Gateway API
version: 5.4.0
version: 5.5.0
description: |-
The Tyk Gateway API is the primary means for integrating your application with the Tyk API Gateway system. This API is very small, and has no granular permissions system. It is intended to be used purely for internal automation and integration.
Expand Down Expand Up @@ -2613,6 +2613,28 @@ components:
x-go-name: Events
type: object
x-go-package: github.com/TykTechnologies/tyk/apidef
RateLimitMeta:
properties:
disabled:
type: boolean
x-go-name: Disabled
method:
type: string
x-go-name: Method
path:
type: string
x-go-name: Path
per:
type: number
format: double
x-go-name: Per
rate:
type: number
format: double
x-go-name: Rate
title: RateLimitMeta configures rate limits per API path.
type: object
x-go-package: github.com/TykTechnologies/tyk/apidef
ExtendedPathsSet:
properties:
advance_cache_config:
Expand Down Expand Up @@ -2660,6 +2682,11 @@ components:
$ref: '#/components/schemas/MethodTransformMeta'
type: array
x-go-name: MethodTransforms
rate_limit:
type: array
items:
$ref: '#/components/schemas/RateLimitMeta'
x-go-name: RateLimit
size_limits:
items:
$ref: '#/components/schemas/RequestSizeMeta'
Expand Down

0 comments on commit 1c5a54c

Please sign in to comment.