Skip to content

Commit 482f719

Browse files
Download Plugin Schemas and Metadata for 3.14 (#7680)
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
1 parent 6352c11 commit 482f719

10 files changed

Lines changed: 72 additions & 8 deletions

File tree

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,8 @@
497497
"config.redis.username"
498498
],
499499
"http-log": [
500+
"config.headers",
501+
"config.headers.additionalProperties",
500502
"config.http_endpoint"
501503
],
502504
"jwt-signer": [
@@ -699,6 +701,8 @@
699701
],
700702
"opentelemetry": [
701703
"config.access_logs.endpoint",
704+
"config.headers",
705+
"config.headers.additionalProperties",
702706
"config.logs_endpoint",
703707
"config.metrics.endpoint",
704708
"config.traces_endpoint"

‎app/_schemas/gateway/plugins/3.14/Confluent.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,14 @@
178178
],
179179
"type": "object"
180180
},
181+
"identity_pool_id": {
182+
"description": "The Confluent Cloud OAuth identity pool ID, sent as the `Confluent-Identity-Pool-Id` request header. Optional: if omitted, Confluent Cloud automatically maps an identity pool based on the token's claims.",
183+
"type": "string"
184+
},
185+
"logical_cluster_id": {
186+
"description": "The Confluent Cloud Schema Registry cluster ID, sent as the `target-sr-cluster` request header. Confluent Cloud requires this when `mode` is 'oauth2'.",
187+
"type": "string"
188+
},
181189
"mode": {
182190
"default": "none",
183191
"description": "Authentication mode to use with the schema registry.",

‎app/_schemas/gateway/plugins/3.14/ConfluentConsume.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,14 @@
147147
],
148148
"type": "object"
149149
},
150+
"identity_pool_id": {
151+
"description": "The Confluent Cloud OAuth identity pool ID, sent as the `Confluent-Identity-Pool-Id` request header. Optional: if omitted, Confluent Cloud automatically maps an identity pool based on the token's claims.",
152+
"type": "string"
153+
},
154+
"logical_cluster_id": {
155+
"description": "The Confluent Cloud Schema Registry cluster ID, sent as the `target-sr-cluster` request header. Confluent Cloud requires this when `mode` is 'oauth2'.",
156+
"type": "string"
157+
},
150158
"mode": {
151159
"default": "none",
152160
"description": "Authentication mode to use with the schema registry.",
@@ -379,6 +387,14 @@
379387
],
380388
"type": "object"
381389
},
390+
"identity_pool_id": {
391+
"description": "The Confluent Cloud OAuth identity pool ID, sent as the `Confluent-Identity-Pool-Id` request header. Optional: if omitted, Confluent Cloud automatically maps an identity pool based on the token's claims.",
392+
"type": "string"
393+
},
394+
"logical_cluster_id": {
395+
"description": "The Confluent Cloud Schema Registry cluster ID, sent as the `target-sr-cluster` request header. Confluent Cloud requires this when `mode` is 'oauth2'.",
396+
"type": "string"
397+
},
382398
"mode": {
383399
"default": "none",
384400
"description": "Authentication mode to use with the schema registry.",

‎app/_schemas/gateway/plugins/3.14/HttpLog.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@
2424
},
2525
"headers": {
2626
"additionalProperties": {
27-
"type": "string"
27+
"description": "\nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
28+
"type": "string",
29+
"x-referenceable": true
2830
},
29-
"description": "An optional table of headers included in the HTTP message to the upstream server. Values are indexed by header name, and each header name accepts a single string.",
31+
"description": "An optional table of headers included in the HTTP message to the upstream server. Values are indexed by header name, and each header name accepts a single string. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
3032
"type": "object"
3133
},
3234
"http_endpoint": {

‎app/_schemas/gateway/plugins/3.14/KafkaConsume.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,14 @@
151151
],
152152
"type": "object"
153153
},
154+
"identity_pool_id": {
155+
"description": "The Confluent Cloud OAuth identity pool ID, sent as the `Confluent-Identity-Pool-Id` request header. Optional: if omitted, Confluent Cloud automatically maps an identity pool based on the token's claims.",
156+
"type": "string"
157+
},
158+
"logical_cluster_id": {
159+
"description": "The Confluent Cloud Schema Registry cluster ID, sent as the `target-sr-cluster` request header. Confluent Cloud requires this when `mode` is 'oauth2'.",
160+
"type": "string"
161+
},
154162
"mode": {
155163
"default": "none",
156164
"description": "Authentication mode to use with the schema registry.",
@@ -386,6 +394,14 @@
386394
],
387395
"type": "object"
388396
},
397+
"identity_pool_id": {
398+
"description": "The Confluent Cloud OAuth identity pool ID, sent as the `Confluent-Identity-Pool-Id` request header. Optional: if omitted, Confluent Cloud automatically maps an identity pool based on the token's claims.",
399+
"type": "string"
400+
},
401+
"logical_cluster_id": {
402+
"description": "The Confluent Cloud Schema Registry cluster ID, sent as the `target-sr-cluster` request header. Confluent Cloud requires this when `mode` is 'oauth2'.",
403+
"type": "string"
404+
},
389405
"mode": {
390406
"default": "none",
391407
"description": "Authentication mode to use with the schema registry.",

‎app/_schemas/gateway/plugins/3.14/KafkaLog.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,14 @@
163163
],
164164
"type": "object"
165165
},
166+
"identity_pool_id": {
167+
"description": "The Confluent Cloud OAuth identity pool ID, sent as the `Confluent-Identity-Pool-Id` request header. Optional: if omitted, Confluent Cloud automatically maps an identity pool based on the token's claims.",
168+
"type": "string"
169+
},
170+
"logical_cluster_id": {
171+
"description": "The Confluent Cloud Schema Registry cluster ID, sent as the `target-sr-cluster` request header. Confluent Cloud requires this when `mode` is 'oauth2'.",
172+
"type": "string"
173+
},
166174
"mode": {
167175
"default": "none",
168176
"description": "Authentication mode to use with the schema registry.",

‎app/_schemas/gateway/plugins/3.14/KafkaUpstream.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,14 @@
191191
],
192192
"type": "object"
193193
},
194+
"identity_pool_id": {
195+
"description": "The Confluent Cloud OAuth identity pool ID, sent as the `Confluent-Identity-Pool-Id` request header. Optional: if omitted, Confluent Cloud automatically maps an identity pool based on the token's claims.",
196+
"type": "string"
197+
},
198+
"logical_cluster_id": {
199+
"description": "The Confluent Cloud Schema Registry cluster ID, sent as the `target-sr-cluster` request header. Confluent Cloud requires this when `mode` is 'oauth2'.",
200+
"type": "string"
201+
},
194202
"mode": {
195203
"default": "none",
196204
"description": "Authentication mode to use with the schema registry.",

‎app/_schemas/gateway/plugins/3.14/KonnectApplicationAuth.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,7 +1023,7 @@
10231023
},
10241024
"ignore_signature": {
10251025
"default": [],
1026-
"description": "Skip the token signature verification on certain grants: - `password`: OAuth password grant - `client_credentials`: OAuth client credentials grant - `authorization_code`: authorization code flow - `refresh_token`: OAuth refresh token grant - `session`: session cookie authentication - `introspection`: OAuth introspection - `userinfo`: OpenID Connect user info endpoint authentication.",
1026+
"description": "Skip the token signature verification on certain grants. This is insecure and logs a warning; use it only for providers that publish no verification key. Grants: - `password`: OAuth password grant - `client_credentials`: OAuth client credentials grant - `authorization_code`: authorization code flow - `refresh_token`: OAuth refresh token grant - `session`: session cookie authentication - `introspection`: OAuth introspection - `userinfo`: OpenID Connect user info endpoint authentication.",
10271027
"items": {
10281028
"enum": [
10291029
"authorization_code",
@@ -2368,7 +2368,7 @@
23682368
},
23692369
"verify_signature": {
23702370
"default": true,
2371-
"description": "Verify signature of tokens.",
2371+
"description": "Verify the cryptographic signature of tokens. Disabling this skips verification for every token source, including tokens presented directly by clients (bearer); this is insecure for that path. To trust only tokens fetched from the identity provider for specific grants, use `ignore_signature` instead, which never affects bearer tokens.",
23722372
"type": "boolean"
23732373
}
23742374
},

‎app/_schemas/gateway/plugins/3.14/OpenidConnect.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -955,7 +955,7 @@
955955
},
956956
"ignore_signature": {
957957
"default": [],
958-
"description": "Skip the token signature verification on certain grants: - `password`: OAuth password grant - `client_credentials`: OAuth client credentials grant - `authorization_code`: authorization code flow - `refresh_token`: OAuth refresh token grant - `session`: session cookie authentication - `introspection`: OAuth introspection - `userinfo`: OpenID Connect user info endpoint authentication.",
958+
"description": "Skip the token signature verification on certain grants. This is insecure and logs a warning; use it only for providers that publish no verification key. Grants: - `password`: OAuth password grant - `client_credentials`: OAuth client credentials grant - `authorization_code`: authorization code flow - `refresh_token`: OAuth refresh token grant - `session`: session cookie authentication - `introspection`: OAuth introspection - `userinfo`: OpenID Connect user info endpoint authentication.",
959959
"items": {
960960
"enum": [
961961
"authorization_code",
@@ -2300,7 +2300,7 @@
23002300
},
23012301
"verify_signature": {
23022302
"default": true,
2303-
"description": "Verify signature of tokens.",
2303+
"description": "Verify the cryptographic signature of tokens. Disabling this skips verification for every token source, including tokens presented directly by clients (bearer); this is insecure for that path. To trust only tokens fetched from the identity provider for specific grants, use `ignore_signature` instead, which never affects bearer tokens.",
23042304
"type": "boolean"
23052305
}
23062306
},

‎app/_schemas/gateway/plugins/3.14/Opentelemetry.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,11 @@
5454
},
5555
"headers": {
5656
"additionalProperties": {
57-
"type": "string"
57+
"description": "\nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
58+
"type": "string",
59+
"x-referenceable": true
5860
},
59-
"description": "The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.",
61+
"description": "The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).",
6062
"type": "object"
6163
},
6264
"http_response_header_for_traceid": {

0 commit comments

Comments
 (0)