Skip to content

Commit afc6613

Browse files
authored
feat(sdk): automated oas update (#4492)
Co-authored-by: kong[bot] <123129154+kong[bot]@users.noreply.github.com>
1 parent d15711f commit afc6613

File tree

3 files changed

+512
-17
lines changed

3 files changed

+512
-17
lines changed

api-specs/konnect/dev-portal/v3/openapi.yaml

Lines changed: 146 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
openapi: 3.0.3
22
info:
33
title: Portal API
4-
version: 3.2.0
4+
version: 3.3.0
55
description: Portal API
66
contact:
77
name: Kong
88
url: 'https://cloud.konghq.com'
9-
x-oas-source: kong/platform-api@0e77dc57fc4df0691cacc2945820eb1f19a60fa2
10-
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/0e77dc57fc4df0691cacc2945820eb1f19a60fa2'
9+
x-oas-source: kong/platform-api@b14ed6a374c9334393d0dc1936514787a83e8c87
10+
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/b14ed6a374c9334393d0dc1936514787a83e8c87'
1111
servers:
1212
- url: 'https://custom.example.com'
1313
description: Production
@@ -868,6 +868,18 @@ paths:
868868
$ref: '#/components/responses/Gone'
869869
tags:
870870
- Developer
871+
/api/v3/integrations:
872+
get:
873+
operationId: get-portal-integrations
874+
summary: Get Portal Integration Configurations
875+
description: Returns the portal's integration configurations.
876+
responses:
877+
'200':
878+
$ref: '#/components/responses/PortalIntegrationsResponse'
879+
security:
880+
- {}
881+
tags:
882+
- Portal
871883
/api/v3/pages:
872884
get:
873885
operationId: list-portal-pages
@@ -3759,6 +3771,17 @@ components:
37593771
nullable: true
37603772
additionalProperties: false
37613773
title: PortalCustomization
3774+
PortalIntegrations:
3775+
description: Configuration data for Dev Portal integrations
3776+
type: object
3777+
properties:
3778+
google_tag_manager:
3779+
$ref: '#/components/schemas/GoogleTagManagerIntegration'
3780+
google_analytics_4:
3781+
$ref: '#/components/schemas/GoogleAnalytics4Integration'
3782+
default: {}
3783+
additionalProperties: false
3784+
title: Portal Integrations
37623785
PageId:
37633786
description: The unique identifier of the page
37643787
type: string
@@ -4017,6 +4040,120 @@ components:
40174040
required:
40184041
- title
40194042
- items
4043+
GoogleTagManagerIntegration:
4044+
description: Google Tag Manager integration configuration
4045+
type: object
4046+
properties:
4047+
enabled:
4048+
description: Whether the integration is enabled
4049+
type: boolean
4050+
type:
4051+
description: The type of the integration for categorization
4052+
type: string
4053+
enum:
4054+
- tracking
4055+
config_data:
4056+
description: Configuration data for the Google Tag Manager integration
4057+
type: object
4058+
additionalProperties: false
4059+
properties:
4060+
id:
4061+
description: The Google Tag Manager container ID
4062+
type: string
4063+
example: GTM-XXXXXX
4064+
maxLength: 20
4065+
minLength: 5
4066+
pattern: '^GTM-[A-Za-z0-9]+$'
4067+
x-validation-message: 'must be a valid GTM container ID (format: GTM-XXXXXX)'
4068+
l:
4069+
description: Optional dataLayer variable name
4070+
type: string
4071+
example: myNewName
4072+
maxLength: 100
4073+
nullable: true
4074+
preview:
4075+
description: Preview environment name
4076+
type: string
4077+
example: preview
4078+
maxLength: 100
4079+
nullable: true
4080+
cookies_win:
4081+
description: Forces GTM cookies to take precedence when true
4082+
type: boolean
4083+
nullable: true
4084+
debug:
4085+
description: Enables debug mode when true
4086+
type: boolean
4087+
nullable: true
4088+
npa:
4089+
description: No Personal Advertising - disables advertising features when true
4090+
type: boolean
4091+
nullable: true
4092+
data_layer:
4093+
description: Custom dataLayer name (alternative to "l" property)
4094+
type: string
4095+
example: myNewName
4096+
maxLength: 100
4097+
nullable: true
4098+
env_name:
4099+
description: Environment name for environment-specific container
4100+
type: string
4101+
example: production
4102+
maxLength: 100
4103+
nullable: true
4104+
auth_referrer_policy:
4105+
description: Referrer policy for analytics requests
4106+
type: string
4107+
example: no-referrer
4108+
maxLength: 100
4109+
nullable: true
4110+
required:
4111+
- id
4112+
additionalProperties: false
4113+
nullable: true
4114+
required:
4115+
- enabled
4116+
- type
4117+
- config_data
4118+
GoogleAnalytics4Integration:
4119+
description: Google Analytics integration configuration
4120+
type: object
4121+
properties:
4122+
enabled:
4123+
description: Whether the integration is enabled
4124+
type: boolean
4125+
type:
4126+
description: The type of the integration for categorization
4127+
type: string
4128+
enum:
4129+
- analytics
4130+
config_data:
4131+
description: Configuration data for the Google Analytics integration
4132+
type: object
4133+
additionalProperties: false
4134+
properties:
4135+
id:
4136+
description: The Google Analytics measurement ID
4137+
type: string
4138+
example: G-XXXXXXX
4139+
maxLength: 20
4140+
minLength: 5
4141+
pattern: '^G-[A-Za-z0-9-]+$'
4142+
x-validation-message: 'must be a valid Google Analytics ID (format: G-XXXXXXX)'
4143+
l:
4144+
description: The datalayer's name you want data to be associated with
4145+
type: string
4146+
example: myNewName
4147+
maxLength: 100
4148+
nullable: true
4149+
required:
4150+
- id
4151+
additionalProperties: false
4152+
nullable: true
4153+
required:
4154+
- enabled
4155+
- type
4156+
- config_data
40204157
CreateApiRegistrationPayload:
40214158
description: The payload to create a registration.
40224159
type: object
@@ -5368,6 +5505,12 @@ components:
53685505
application/json:
53695506
schema:
53705507
$ref: '#/components/schemas/PortalCustomization'
5508+
PortalIntegrationsResponse:
5509+
description: Response for portal integration configurations
5510+
content:
5511+
application/json:
5512+
schema:
5513+
$ref: '#/components/schemas/PortalIntegrations'
53715514
CreateAPIRegistration:
53725515
description: Registration creation response.
53735516
content:

api-specs/konnect/event-gateway/v1/openapi.yaml

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ info:
2121
contact:
2222
name: Kong
2323
url: 'https://cloud.konghq.com'
24-
x-oas-source: kong/platform-api@2d934da57b631cf395103da16f430107a7542da5
25-
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/2d934da57b631cf395103da16f430107a7542da5'
24+
x-oas-source: kong/platform-api@c638fa722e06b3a49feecc6be15a5ef679fbd09c
25+
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/c638fa722e06b3a49feecc6be15a5ef679fbd09c'
2626
servers:
2727
- url: 'https://us.api.konghq.com/v1'
2828
description: United-States Production region
@@ -4751,15 +4751,9 @@ components:
47514751
- name
47524752
- value
47534753
EventGatewayPolicyReference:
4754-
description: A reference to an Event Gateway policy.
4755-
type: object
4756-
properties:
4757-
id:
4758-
description: The unique identifier of the policy.
4759-
type: string
4760-
format: uuid
4761-
required:
4762-
- id
4754+
description: The unique identifier of the policy.
4755+
type: string
4756+
format: uuid
47634757
CursorMetaPage:
47644758
type: object
47654759
properties:

0 commit comments

Comments
 (0)