Skip to content

Commit 6fe5cf5

Browse files
kong-apiopstomek-labuk
kong-apiops
and
tomek-labuk
authored
Download Plugin Schemas and Metadata for 3.13 (#3544)
Co-authored-by: tomek-labuk <207846229+tomek-labuk@users.noreply.github.com>
1 parent 7680c2b commit 6fe5cf5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+3272
-183
lines changed

‎app/_data/plugins/priorities/3.13.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"ai-aws-guardrails": 781,
66
"ai-azure-content-safety": 774,
77
"ai-gcp-model-armor": 783,
8+
"ai-lakera-guard": 784,
89
"ai-llm-as-judge": 767,
910
"ai-mcp-oauth2": 1015,
1011
"ai-mcp-proxy": 820,

‎app/_data/plugins/referenceable_fields/3.13.json‎

Lines changed: 334 additions & 0 deletions
Large diffs are not rendered by default.

‎app/_schemas/gateway/plugins/3.13/Ace.json‎

Lines changed: 91 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
"config": {
44
"properties": {
55
"anonymous": {
6+
"description": "An optional string (consumer UUID or username) value to use as an `anonymous` consumer if authentication fails. If empty (default null), the request will fail with an authentication failure `4xx`. When set, the plugin will skip ACE processing for requests that are already authenticated by other plugins with higher priority.",
67
"type": "string"
78
},
89
"match_policy": {
910
"default": "if_present",
11+
"description": "Determines how the ACE plugin will behave when a request doesn't match an existing operation from an API or API package in Dev Portal. The `required` setting requires every incoming request to match a defined operation. If a request doesn't match, ACE rejects the request outright with a 404. The `if_present` setting makes the ACE plugin only engage with a request when it matches an operation, allowing a request to still be processed by other plugins with a lower priority than ACE.",
1012
"enum": [
1113
"if_present",
1214
"required"
@@ -17,6 +19,85 @@
1719
"properties": {
1820
"redis": {
1921
"properties": {
22+
"cloud_authentication": {
23+
"description": "Cloud auth related configs for connecting to a Cloud Provider's Redis instance.",
24+
"properties": {
25+
"auth_provider": {
26+
"description": "Auth providers to be used to authenticate to a Cloud Provider's Redis instance. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
27+
"enum": [
28+
"aws",
29+
"azure",
30+
"gcp"
31+
],
32+
"type": "string",
33+
"x-referenceable": true
34+
},
35+
"aws_access_key_id": {
36+
"description": "AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
37+
"type": "string",
38+
"x-encrypted": true,
39+
"x-referenceable": true
40+
},
41+
"aws_assume_role_arn": {
42+
"description": "The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
43+
"type": "string",
44+
"x-encrypted": true,
45+
"x-referenceable": true
46+
},
47+
"aws_cache_name": {
48+
"description": "The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
49+
"type": "string",
50+
"x-referenceable": true
51+
},
52+
"aws_is_serverless": {
53+
"default": true,
54+
"description": "This flag specifies whether the cluster is serverless when auth_provider is set to `aws`.",
55+
"type": "boolean"
56+
},
57+
"aws_region": {
58+
"description": "The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
59+
"type": "string",
60+
"x-referenceable": true
61+
},
62+
"aws_role_session_name": {
63+
"description": "The session name for the temporary credentials when assuming the IAM role. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
64+
"type": "string",
65+
"x-encrypted": true,
66+
"x-referenceable": true
67+
},
68+
"aws_secret_access_key": {
69+
"description": "AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
70+
"type": "string",
71+
"x-encrypted": true,
72+
"x-referenceable": true
73+
},
74+
"azure_client_id": {
75+
"description": "Azure Client ID to be used for authentication when `auth_provider` is set to `azure`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
76+
"type": "string",
77+
"x-encrypted": true,
78+
"x-referenceable": true
79+
},
80+
"azure_client_secret": {
81+
"description": "Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
82+
"type": "string",
83+
"x-encrypted": true,
84+
"x-referenceable": true
85+
},
86+
"azure_tenant_id": {
87+
"description": "Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
88+
"type": "string",
89+
"x-encrypted": true,
90+
"x-referenceable": true
91+
},
92+
"gcp_service_account_json": {
93+
"description": "GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
94+
"type": "string",
95+
"x-encrypted": true,
96+
"x-referenceable": true
97+
}
98+
},
99+
"type": "object"
100+
},
20101
"cluster_max_redirections": {
21102
"default": 5,
22103
"description": "Maximum retry attempts for redirection.",
@@ -63,8 +144,9 @@
63144
},
64145
"host": {
65146
"default": "127.0.0.1",
66-
"description": "A string representing a host name, such as example.com.",
67-
"type": "string"
147+
"description": "A string representing a host name, such as example.com. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
148+
"type": "string",
149+
"x-referenceable": true
68150
},
69151
"keepalive_backlog": {
70152
"description": "Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.",
@@ -87,10 +169,11 @@
87169
},
88170
"port": {
89171
"default": 6379,
90-
"description": "An integer representing a port number between 0 and 65535, inclusive.",
172+
"description": "An integer representing a port number between 0 and 65535, inclusive. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
91173
"maximum": 65535,
92174
"minimum": 0,
93-
"type": "integer"
175+
"type": "integer",
176+
"x-referenceable": true
94177
},
95178
"read_timeout": {
96179
"default": 2000,
@@ -153,8 +236,9 @@
153236
"x-referenceable": true
154237
},
155238
"server_name": {
156-
"description": "A string representing an SNI (server name indication) value for TLS.",
157-
"type": "string"
239+
"description": "A string representing an SNI (server name indication) value for TLS. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
240+
"type": "string",
241+
"x-referenceable": true
158242
},
159243
"ssl": {
160244
"default": false,
@@ -175,6 +259,7 @@
175259
"type": "object"
176260
},
177261
"sync_rate": {
262+
"description": "How often to sync counter data to the central data store. A value of 0 results in synchronous behavior (counter synchronization happens in each request's context and contributes directly to the latency of the request). A value greater than 0 results in asynchronous behavior and specifies the interval (in seconds) for synchronizing counters. The minimum allowed interval is 0.02 seconds (20ms). If omitted, the plugin ignores sync behavior entirely and only stores counters in node memory.",
178263
"maximum": 3600,
179264
"minimum": 0,
180265
"type": "number"

‎app/_schemas/gateway/plugins/3.13/Acme.json‎

Lines changed: 89 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@
1212
"description": "The private key associated with the account.",
1313
"properties": {
1414
"key_id": {
15-
"description": "The Key ID.",
16-
"type": "string"
15+
"description": "The Key ID. \nThis field is [encrypted](/gateway/keyring/).",
16+
"type": "string",
17+
"x-encrypted": true
1718
},
1819
"key_set": {
19-
"description": "The ID of the key set to associate the Key ID with.",
20-
"type": "string"
20+
"description": "The name of the key set to associate the Key ID with. \nThis field is [encrypted](/gateway/keyring/).",
21+
"type": "string",
22+
"x-encrypted": true
2123
}
2224
},
2325
"required": [
@@ -132,8 +134,9 @@
132134
"type": "number"
133135
},
134136
"token": {
135-
"description": "Consul ACL token. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
137+
"description": "Consul ACL token. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
136138
"type": "string",
139+
"x-encrypted": true,
137140
"x-referenceable": true
138141
}
139142
},
@@ -145,6 +148,85 @@
145148
},
146149
"redis": {
147150
"properties": {
151+
"cloud_authentication": {
152+
"description": "Cloud auth related configs for connecting to a Cloud Provider's Redis instance.",
153+
"properties": {
154+
"auth_provider": {
155+
"description": "Auth providers to be used to authenticate to a Cloud Provider's Redis instance. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
156+
"enum": [
157+
"aws",
158+
"azure",
159+
"gcp"
160+
],
161+
"type": "string",
162+
"x-referenceable": true
163+
},
164+
"aws_access_key_id": {
165+
"description": "AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
166+
"type": "string",
167+
"x-encrypted": true,
168+
"x-referenceable": true
169+
},
170+
"aws_assume_role_arn": {
171+
"description": "The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
172+
"type": "string",
173+
"x-encrypted": true,
174+
"x-referenceable": true
175+
},
176+
"aws_cache_name": {
177+
"description": "The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
178+
"type": "string",
179+
"x-referenceable": true
180+
},
181+
"aws_is_serverless": {
182+
"default": true,
183+
"description": "This flag specifies whether the cluster is serverless when auth_provider is set to `aws`.",
184+
"type": "boolean"
185+
},
186+
"aws_region": {
187+
"description": "The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
188+
"type": "string",
189+
"x-referenceable": true
190+
},
191+
"aws_role_session_name": {
192+
"description": "The session name for the temporary credentials when assuming the IAM role. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
193+
"type": "string",
194+
"x-encrypted": true,
195+
"x-referenceable": true
196+
},
197+
"aws_secret_access_key": {
198+
"description": "AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
199+
"type": "string",
200+
"x-encrypted": true,
201+
"x-referenceable": true
202+
},
203+
"azure_client_id": {
204+
"description": "Azure Client ID to be used for authentication when `auth_provider` is set to `azure`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
205+
"type": "string",
206+
"x-encrypted": true,
207+
"x-referenceable": true
208+
},
209+
"azure_client_secret": {
210+
"description": "Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
211+
"type": "string",
212+
"x-encrypted": true,
213+
"x-referenceable": true
214+
},
215+
"azure_tenant_id": {
216+
"description": "Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
217+
"type": "string",
218+
"x-encrypted": true,
219+
"x-referenceable": true
220+
},
221+
"gcp_service_account_json": {
222+
"description": "GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
223+
"type": "string",
224+
"x-encrypted": true,
225+
"x-referenceable": true
226+
}
227+
},
228+
"type": "object"
229+
},
148230
"database": {
149231
"default": 0,
150232
"description": "Database to use for the Redis connection when using the `redis` strategy",
@@ -278,8 +360,9 @@
278360
"type": "boolean"
279361
},
280362
"token": {
281-
"description": "Consul ACL token. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
363+
"description": "Consul ACL token. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
282364
"type": "string",
365+
"x-encrypted": true,
283366
"x-referenceable": true
284367
}
285368
},

‎app/_schemas/gateway/plugins/3.13/AiAwsGuardrails.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22
"properties": {
33
"config": {
44
"properties": {
5+
"allow_masking": {
6+
"default": false,
7+
"description": "Allow to masking the request/response instead of blocking it. Streaming will be disabled if this is enabled.",
8+
"type": "boolean"
9+
},
510
"aws_access_key_id": {
6-
"description": "The AWS access key ID to use for authentication \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
11+
"description": "The AWS access key ID to use for authentication \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
712
"type": "string",
13+
"x-encrypted": true,
814
"x-referenceable": true
915
},
1016
"aws_assume_role_arn": {
@@ -20,8 +26,9 @@
2026
"type": "string"
2127
},
2228
"aws_secret_access_key": {
23-
"description": "The AWS secret access key to use for authentication \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
29+
"description": "The AWS secret access key to use for authentication \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).",
2430
"type": "string",
31+
"x-encrypted": true,
2532
"x-referenceable": true
2633
},
2734
"aws_sts_endpoint_url": {

0 commit comments

Comments
 (0)