feat(sdk): automated oas update

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

Hide file tree

Showing 10 changed files with 141 additions and 14 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
@@ -3076,7 +3076,7 @@ components:
         type: string
         format: uuid
         example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
-      description: The UUID of your control plane. This variable is available in the Konnect manager
+      description: The UUID of your control plane. This variable is available in the Konnect manager.
     pagination-size:
       description: Number of resources to be returned.
       in: query
@@ -4270,7 +4270,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true

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
@@ -758,6 +758,7 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/ProxyURL'
+      format: set
       example:
         - host: example.com
           port: 443
@@ -942,7 +943,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true

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

diff --git a/api-specs/Konnect/v3/yaml/identity.yaml b/api-specs/Konnect/v3/yaml/identity.yaml
@@ -1144,6 +1144,33 @@ paths:
           $ref: '#/components/responses/IdentityNotFound'
       tags:
         - System Accounts - Team Membership
+  /users/me:
+    get:
+      operationId: get-users-me
+      summary: Retrieve My User Account
+      description: Returns the user account for the user identified in the token of the request.
+      responses:
+        '200':
+          $ref: '#/components/responses/UserSingle'
+        '401':
+          $ref: '#/components/responses/IdentityUnauthenticated'
+      security:
+        - personalAccessToken: []
+        - konnectAccessToken: []
+      tags:
+        - Me
+  /organizations/me:
+    get:
+      operationId: get-organizations-me
+      summary: Retrieve My Organization
+      description: Returns the organization of the user identified in the token of the request.
+      responses:
+        '200':
+          $ref: '#/components/responses/MeOrganization'
+        '401':
+          $ref: '#/components/responses/IdentityUnauthenticated'
+      tags:
+        - Me
   '/authenticate/{organizationLoginPath}':
     get:
       operationId: authenticate-sso
@@ -1642,7 +1669,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true
@@ -3637,6 +3664,66 @@ components:
                 expires_at: '2019-08-24T14:15:22Z'
                 last_used_at: '2019-08-24T14:15:22Z'
                 token: npat_12345678901234567890123456789012345678901234567890
+    MeOrganization:
+      description: Me Organization
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              id:
+                description: UUID of the organization.
+                type: string
+                format: uuid
+                readOnly: true
+              name:
+                description: Name of the organization.
+                type: string
+              owner_id:
+                description: Owner ID of the organization.
+                type: string
+              login_path:
+                description: Path to organization-specific login when single sign on (SSO) is enabled. Blank otherwise.
+                type: string
+              created_at:
+                description: Date the organization was created.
+                type: string
+                format: date-time
+                readOnly: true
+              updated_at:
+                description: Date the organization was last updated.
+                type: string
+                format: date-time
+                readOnly: true
+              state:
+                description: State of the organization
+                type: string
+                enum:
+                  - active
+                  - inactive
+              retention_period_days:
+                description: The number of days an organization spends inactive before being deleted.
+                type: integer
+            example:
+              id: d99c041a-c7cf-46a2-bf3a-44bb5f75400e
+              name: string
+              owner_id: 1c9c3848-5897-4f2c-beed-df6f3e3adb37
+              created_at: '2023-01-23T17:22:52.150Z'
+              updated_at: '2023-01-23T17:22:52.150Z'
+              state: active
+              retention_period_days: 90
+            title: Me Organization Response
+          examples:
+            Example:
+              value:
+                created_at: '2023-01-18T11:35:45.130Z'
+                id: 023bfa42-3513-4cbf-b059-a9ddb4ea995d
+                name: Acme Co.
+                owner_id: e02c829c-0e2d-44b5-9057-07714ea613a3
+                login_path: acme
+                updated_at: '2023-01-23T17:22:52.150Z'
+                state: active
+                retention_period_days: 90
     IdPConfiguration:
       description: A get action response of the IdP configuration.
       content:
@@ -3679,6 +3766,7 @@ tags:
   - name: System Accounts - Access Tokens
   - name: System Accounts - Roles
   - name: System Accounts - Team Membership
+  - name: Me
   - name: Authentication
   - name: Impersonation Settings
 security:

diff --git a/api-specs/portal.yaml b/api-specs/portal.yaml
@@ -2119,7 +2119,7 @@ components:
         choices:
           type: array
           items: {}
-          minimum: 1
+          minItems: 1
           nullable: false
           readOnly: true
           uniqueItems: true
@@ -3411,6 +3411,7 @@ components:
           type: array
           items:
             type: string
+          deprecated: true
       additionalProperties: false
       required:
         - id