|
1 | 1 | openapi: 3.0.3 |
2 | 2 | info: |
3 | 3 | title: Portal API |
4 | | - version: 3.2.0 |
| 4 | + version: 3.3.0 |
5 | 5 | description: Portal API |
6 | 6 | contact: |
7 | 7 | name: Kong |
8 | 8 | 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' |
11 | 11 | servers: |
12 | 12 | - url: 'https://custom.example.com' |
13 | 13 | description: Production |
@@ -868,6 +868,18 @@ paths: |
868 | 868 | $ref: '#/components/responses/Gone' |
869 | 869 | tags: |
870 | 870 | - 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 |
871 | 883 | /api/v3/pages: |
872 | 884 | get: |
873 | 885 | operationId: list-portal-pages |
@@ -3759,6 +3771,17 @@ components: |
3759 | 3771 | nullable: true |
3760 | 3772 | additionalProperties: false |
3761 | 3773 | 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 |
3762 | 3785 | PageId: |
3763 | 3786 | description: The unique identifier of the page |
3764 | 3787 | type: string |
@@ -4017,6 +4040,120 @@ components: |
4017 | 4040 | required: |
4018 | 4041 | - title |
4019 | 4042 | - 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 |
4020 | 4157 | CreateApiRegistrationPayload: |
4021 | 4158 | description: The payload to create a registration. |
4022 | 4159 | type: object |
@@ -5368,6 +5505,12 @@ components: |
5368 | 5505 | application/json: |
5369 | 5506 | schema: |
5370 | 5507 | $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' |
5371 | 5514 | CreateAPIRegistration: |
5372 | 5515 | description: Registration creation response. |
5373 | 5516 | content: |
|
0 commit comments