chore(openapi): update kafka-mgmt/v1 OpenAPI document (#634)

Co-authored-by: app-services-ci <[email protected]>
redhat-developer · Jan 20, 2023 · 177b525 · 177b525
1 parent f6201fb
commit 177b525
Showing 1 changed file with 158 additions and 3 deletions.
diff --git a/.openapi/kas-fleet-manager.yaml b/.openapi/kas-fleet-manager.yaml
@@ -967,7 +967,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/EnterpriseClusterRegistrationResponse'
+                $ref: '#/components/schemas/EnterpriseClusterWithAddonParameters'
           description: Enterprise cluster registered
         "400":
           content:
@@ -1100,6 +1100,128 @@ paths:
           description: Unexpected error occurred
       security:
         - Bearer: [ ]
+    get:
+      tags:
+        - enterprise-dataplane-clusters
+      operationId: getEnterpriseClusterById
+      description: Returns enterprise data plane cluster by ID
+      parameters:
+        - in: path
+          name: id
+          description: ID of the enterprise data plane cluster
+          schema:
+            type: string
+          required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnterpriseCluster'
+              examples:
+                EnterpriseClusterExample:
+                  $ref: '#/components/examples/EnterpriseClusterExample'
+          description: Found enterprise data plane cluster with provided ID
+        "401":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                401Example:
+                  $ref: '#/components/examples/401Example'
+          description: Auth token is invalid
+        "403":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                403Example:
+                  $ref: '#/components/examples/403Example'
+          description: User not authorized to access the service
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                404Example:
+                  $ref: '#/components/examples/404Example'
+          description: No Enterprise data plane cluster with specified ID exists
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                500Example:
+                  $ref: '#/components/examples/500Example'
+          description: Unexpected error occurred
+      security:
+        - Bearer: [ ]
+
+  /api/kafkas_mgmt/v1/clusters/{id}/addon_parameters:
+    get:
+      tags:
+        - enterprise-dataplane-clusters
+      operationId: getEnterpriseClusterWithAddonParameters
+      description: Returns enterprise data plane cluster by ID along with its addon parameters
+      parameters:
+        - in: path
+          name: id
+          description: ID of the enterprise data plane cluster
+          schema:
+            type: string
+          required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnterpriseClusterWithAddonParameters'
+              examples:
+                EnterpriseClusterWithAddonsExample:
+                  $ref: '#/components/examples/EnterpriseClusterWithAddonParametersExample'
+          description: Returns the enterprise data plane cluster with addon parameters for an existing enterprise data plane cluster with provided ID
+        "401":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                401Example:
+                  $ref: '#/components/examples/401Example'
+          description: Auth token is invalid
+        "403":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                403Example:
+                  $ref: '#/components/examples/403Example'
+          description: User not authorized to access the service
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                404Example:
+                  $ref: '#/components/examples/404Example'
+          description: No Enterprise data plane cluster with specified ID exists
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                500Example:
+                  $ref: '#/components/examples/500Example'
+          description: Unexpected error occurred
+      security:
+        - Bearer: [ ]
 
 components:
   schemas:
@@ -1818,8 +1940,8 @@ components:
             The node count value has to be a multiple of 3 with a minimum of 3 nodes.
           type: integer
           format: int32  
-    EnterpriseClusterRegistrationResponse:
-      description: Enterprise cluster registration endpoint response
+    EnterpriseClusterWithAddonParameters:
+      description: Enterprise cluster with addon parameters
       allOf:
         - $ref: "#/components/schemas/ObjectReference"
         - type: object
@@ -2028,13 +2150,46 @@ components:
         name: "test_kafka"
         plan: "standard.x1"
     EnterpriseClusterExample:
+      value:
+        id: "abcd1234ascd3456fdks9485lskd030h"
+        kind: "cluster"
+        href: "/api/kafkas_mgmr/v1/clusters/abcd1234ascd3456fdks9485lskd030h"
+        status: "ready"
+        cluster_id: "abcd1234ascd3456fdks9485lskd030h"
+    EnterpriseClusterWithAddonParametersExample:
       value:
         id: "abcd1234ascd3456fdks9485lskd030h"
         kind: "cluster"
         href: "/api/kafkas_mgmr/v1/clusters/abcd1234ascd3456fdks9485lskd030h"
         status: "ready"
         cluster_id: "abcd1234ascd3456fdks9485lskd030h"
         access_kafkas_via_private_network: true
+        fleetshard_parameters: [
+            {
+                id: "sso-auth-server-url",
+                value: "http://someurl/auth/realms/rhoas"
+            },
+            {
+                id: "sso-client-id",
+                value: "kas-fleetshard-agent-1234abcd1234abcd1234abcd1234abcd"
+            },
+            {
+                id: "sso-secret",
+                value: "some-secret"
+            },
+            {
+                id: "cluster-id",
+                value: "1234abcd1234abcd1234abcd1234abcd"
+            },
+            {
+                id: "poll-interval",
+                value: "15s"
+            },
+            {
+                id: "resync-interval",
+                value: "60s"
+            }
+        ]
     KafkaRequestExample:
       value:
         id: "1iSY6RQ3JKI8Q0OTmjQFd3ocFRg"