feat(sdk): automated oas update

Kong · Sep 20, 2024 · e1b4922 · e1b4922
1 parent 52acdf8
commit e1b4922
Show file tree

Hide file tree

Showing 10 changed files with 291 additions and 63 deletions.
diff --git a/api-specs/Konnect/control-planes-config/control-planes-config.yaml b/api-specs/Konnect/control-planes-config/control-planes-config.yaml
diff --git a/api-specs/Konnect/v0/yaml/mesh-control-planes.yaml b/api-specs/Konnect/v0/yaml/mesh-control-planes.yaml
@@ -427,7 +427,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true

diff --git a/api-specs/Konnect/v1/yaml/ksearch.yaml b/api-specs/Konnect/v1/yaml/ksearch.yaml
@@ -354,7 +354,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true

diff --git a/api-specs/Konnect/v2/yaml/api-products.yaml b/api-specs/Konnect/v2/yaml/api-products.yaml
@@ -843,13 +843,19 @@ components:
           description: API product document title
           type: string
           example: API Product Document
+        created_at:
+          $ref: '#/components/schemas/CreatedAt'
+        updated_at:
+          $ref: '#/components/schemas/UpdatedAt'
       additionalProperties: false
       required:
         - id
         - parent_document_id
         - slug
         - title
         - status
+        - created_at
+        - updated_at
       title: API Product Document Summary
     APIProductDocument:
       description: an api product document
@@ -1628,7 +1634,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true
@@ -1817,13 +1823,19 @@ components:
               metadata:
                 author: John Doe
               children: []
+        created_at:
+          $ref: '#/components/schemas/CreatedAt'
+        updated_at:
+          $ref: '#/components/schemas/UpdatedAt'
       required:
         - id
         - title
         - slug
         - metadata
         - children
         - status
+        - created_at
+        - updated_at
       title: DocumentTree
     ChildNode:
       type: object
@@ -2308,6 +2320,8 @@ components:
             slug: api-product-document
             status: published
             title: API Product Document
+            created_at: '2022-11-04T20:10:06.927Z'
+            updated_at: '2022-11-04T20:10:06.927Z'
             metadata: {}
             children:
               - children: []
@@ -2317,6 +2331,8 @@ components:
                 slug: api-product-document-child
                 status: published
                 title: API Product Document Child
+                created_at: '2022-11-04T20:10:06.927Z'
+                updated_at: '2022-11-04T20:10:06.927Z'
         meta:
           page:
             number: 1
@@ -2330,6 +2346,8 @@ components:
             slug: api-product-document
             status: published
             title: API Product Document
+            created_at: '2022-11-04T20:10:06.927Z'
+            updated_at: '2022-11-04T20:10:06.927Z'
         meta:
           page:
             number: 1
@@ -2451,8 +2469,9 @@ components:
         invalid_parameters:
           - field: sort
             rule: enum
-            choices: []
-            reason: '"sort" field must contain any of: []'
+            choices:
+              - name
+            reason: '"sort" field must contain any of: [name]'
     InvalidSortQueryNameBadRequestExample:
       value:
         status: 400

diff --git a/api-specs/Konnect/v2/yaml/application-auth-strategies.yaml b/api-specs/Konnect/v2/yaml/application-auth-strategies.yaml
@@ -1611,7 +1611,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true

diff --git a/api-specs/Konnect/v2/yaml/audit-logs.yaml b/api-specs/Konnect/v2/yaml/audit-logs.yaml
@@ -304,7 +304,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true

diff --git a/api-specs/Konnect/v2/yaml/control-planes.yaml b/api-specs/Konnect/v2/yaml/control-planes.yaml
@@ -188,6 +188,27 @@ paths:
           $ref: '#/components/responses/ServiceUnavailable'
       tags:
         - Control Plane Groups
+    put:
+      operationId: put-control-planes-id-group-memberships
+      summary: Upsert Control Plane Group Members
+      description: Adds one or more control planes as a member of a control plane group.
+      requestBody:
+        $ref: '#/components/requestBodies/GroupMemebershipUpsert'
+      responses:
+        '204':
+          description: No Content
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '503':
+          $ref: '#/components/responses/ServiceUnavailable'
+      tags:
+        - Control Plane Groups
   '/control-planes/{id}/group-memberships/add':
     parameters:
       - name: id
@@ -758,6 +779,7 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/ProxyURL'
+      format: set
       example:
         - host: example.com
           port: 443
@@ -942,7 +964,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true
@@ -1336,6 +1358,19 @@ components:
                   - id: 778a0474-687d-41af-8e51-a0488d790586
                   - id: fa85f8e8-2e5a-496e-b6d0-4e534eaab459
       description: Request body for removing a list of child control planes from a control plane group membership.
+    GroupMemebershipUpsert:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/GroupMembership'
+          examples:
+            Example 1:
+              value:
+                members:
+                  - id: 1beb9ad3-d21b-4090-b6e3-574784d1166d
+                  - id: 778a0474-687d-41af-8e51-a0488d790586
+                  - id: fa85f8e8-2e5a-496e-b6d0-4e534eaab459
+      description: Request body for upserting a list of child control planes to a control plane group membership.
   responses:
     RetrieveControlPlaneResponse:
       description: A response to retrieving a single control plane.

diff --git a/api-specs/Konnect/v2/yaml/portal-management.yaml b/api-specs/Konnect/v2/yaml/portal-management.yaml
@@ -2691,6 +2691,7 @@ components:
             portal:
               id: 95606071-49c7-4c2e-ae49-8a86d72a8110
             dcr_provider: null
+            granted_scopes: null
             developer:
               id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
               name: Jane Dev
@@ -2708,6 +2709,8 @@ components:
               id: 95606071-49c7-4c2e-ae49-8a86d72a8110
             dcr_provider:
               id: 7ea06071-49c7-4c2e-ae49-8a86d72a8110
+            granted_scopes:
+              - openid
             developer:
               id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
               name: John Dev
@@ -2998,6 +3001,12 @@ components:
             - email
         auth_strategy:
           $ref: '#/components/schemas/AuthStrategy'
+        granted_scopes:
+          description: List of granted scopes for the application. Null if application type does not support returning granted scopes.
+          type: array
+          items:
+            type: string
+          nullable: true
       example:
         id: b15e2460-ba40-431d-9df0-4957fcffacda
         labels:
@@ -3009,6 +3018,7 @@ components:
         portal:
           id: 95606071-49c7-4c2e-ae49-8a86d72a8110
         dcr_provider: null
+        granted_scopes: null
         developer:
           id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
           name: Jane Dev
@@ -3028,6 +3038,7 @@ components:
         - portal
         - developer
         - labels
+        - granted_scopes
       title: Application
     ApplicationRegistration:
       description: A application's registration for a specific version of a product.
@@ -3094,10 +3105,11 @@ components:
             - id
             - name
         granted_scopes:
-          description: List of granted scopes for the registration. Null if application type does not support returning granted scopes.
+          description: 'Cached list of granted scopes for the registration. Identical for all registrations of an applications, use `/portals/{portalId}/applications/{applicationId}` to get up to date granted scopes from the IDP. Null if application type does not support returning granted scopes.'
           type: array
           items:
             type: string
+          deprecated: true
           nullable: true
       example:
         id: c300cc33-2d33-4754-b086-a98e0fcd36fb
@@ -4470,7 +4482,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true
@@ -5382,6 +5394,7 @@ components:
             portal:
               id: 95606071-49c7-4c2e-ae49-8a86d72a8110
             dcr_provider: null
+            granted_scopes: null
             developer:
               id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
               name: Jane Dev
@@ -5399,6 +5412,8 @@ components:
               id: 95606071-49c7-4c2e-ae49-8a86d72a8110
             dcr_provider:
               id: 7ea06071-49c7-4c2e-ae49-8a86d72a8110
+            granted_scopes:
+              - openid
             developer:
               id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
               name: John Dev
@@ -5417,6 +5432,7 @@ components:
         portal:
           id: 95606071-49c7-4c2e-ae49-8a86d72a8110
         dcr_provider: null
+        granted_scopes: null
         developer:
           id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
           name: Jane Dev
@@ -5436,6 +5452,8 @@ components:
           id: 95606071-49c7-4c2e-ae49-8a86d72a8110
         dcr_provider:
           id: 7ea06071-49c7-4c2e-ae49-8a86d72a8110
+        granted_scopes:
+          - openid
         developer:
           id: 9cd9feff-b4da-4a9f-ba49-cbe83c75ff22
           name: John Dev