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

Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>

Author: app-services-ci

.openapi/kas-fleet-manager.yaml

@@ -2,8 +2,8 @@ openapi: 3.0.0 # need this as first line to allow some IDEs to know this is an o
 # All endpoints defined here will be discoverable by all users. If there is a need to keep some endpoints "private", add them to the "managed-services-api-private.yaml" file
 info:
   title: Kafka Service Fleet Manager
-  version: 1.1.1
-  description: Kafka Service Fleet Manager is a Rest API to manage Kakfa instances and connectors.
+  version: 1.1.2
+  description: Kafka Service Fleet Manager is a Rest API to manage Kafka instances.
 servers:
   - url: https://api.openshift.com
     description: Main (production) server
@@ -88,7 +88,7 @@ paths:
               examples:
                 404Example:
                   $ref: '#/components/examples/404Example'
-          description: No Kakfa request with specified ID exists
+          description: No Kafka request with specified ID exists
         "500":
           content:
             application/json:
@@ -100,7 +100,7 @@ paths:
           description: Unexpected error occurred
       security:
         - Bearer: []
-      summary: Returns a Kakfa request by ID
+      summary: Returns a Kafka request by ID
     delete:
       operationId: deleteKafkaById
       parameters:
@@ -154,7 +154,7 @@ paths:
               examples:
                 404DeleteExample:
                   $ref: '#/components/examples/404DeleteExample'
-          description: No Kakfa request with specified ID exists
+          description: No Kafka request with specified ID exists
         "500":
           content:
             application/json:
@@ -164,7 +164,7 @@ paths:
                 500DeleteExample:
                   $ref: '#/components/examples/500DeleteExample'
           description: Unexpected error occurred
-      summary: Deletes a Kakfa request by ID
+      summary: Deletes a Kafka request by ID
       security:
         - Bearer: []
     parameters:
@@ -229,6 +229,8 @@ paths:
                   $ref: '#/components/examples/403Example'
                 403MaxAllowedInstanceReachedExample:
                   $ref: '#/components/examples/403MaxAllowedInstanceReachedExample'
+                403TermsNotAcceptedExample:
+                  $ref: '#/components/examples/403TermsNotAcceptedExample'
           description: User forbidden either because the user is not authorized to access the service or because the maximum number of instances that can be created by this user has been reached.
         "404":
           content:
@@ -259,7 +261,7 @@ paths:
           description: An unexpected error occurred while creating the Kafka request
       security:
         - Bearer: []
-      summary: Creates a Kakfa request
+      summary: Creates a Kafka request
     get:
       summary: Returns a list of Kafka requests
       operationId: getKafkas
@@ -593,7 +595,7 @@ paths:
   #
   /api/kafkas_mgmt/v1/kafkas/{id}/metrics/query_range:
     get:
-      summary: Returns metrics with timeseries range query by Kakfa ID
+      summary: Returns metrics with timeseries range query by Kafka ID
       operationId: getMetricsByRangeQuery
       security:
         - Bearer: []
@@ -629,7 +631,7 @@ paths:
         - $ref: "#/components/parameters/filters"
   /api/kafkas_mgmt/v1/kafkas/{id}/metrics/query:
     get:
-      summary: Returns metrics with instant query by Kakfa ID
+      summary: Returns metrics with instant query by Kafka ID
       operationId: getMetricsByInstantQuery
       security:
         - Bearer: []
@@ -717,20 +719,20 @@ components:
         - type: object
           properties:
             status:
+              description: "Values: [accepted, preparing, provisioning, ready, failed, deprovision, deleting] "
               type: string
             cloud_provider:
+              description: "Name of Cloud used to deploy. For example AWS"
               type: string
             multi_az:
               type: boolean
             region:
+              description: "Values will be regions of specific cloud provider. For example: us-east-1 for AWS"
               type: string
             owner:
               type: string
             name:
               type: string
-            bootstrapServerHost:
-              type: string
-              deprecated: true
             bootstrap_server_host:
               type: string
             created_at:
@@ -788,13 +790,13 @@ components:
       type: object
       properties:
         kafkas:
-          description: The Kakfa resource api status
+          description: The Kafka resource api status
           type: object
           required:
             - max_capacity_reached
           properties:
             max_capacity_reached:
-              description: Indicates whether we have reached Kakfa maximum capacity
+              description: Indicates whether we have reached Kafka maximum capacity
               type: boolean
     KafkaRequestPayload:
       description: Schema for the request body sent to /kafkas POST
@@ -901,14 +903,8 @@ components:
             description:
               description: ''
               type: string
-            clientID:
-              type: string
-              deprecated: true
             client_id:
               type: string
-            clientSecret:
-              type: string
-              deprecated: true
             client_secret:
               type: string
             owner:
@@ -941,10 +937,6 @@ components:
             id:
               description: 'server generated unique id of the service account'
               type: string
-            clientID:
-              description: 'client id of the service account'
-              type: string
-              deprecated: true
             client_id:
               description: 'client id of the service account'
               type: string
@@ -1012,17 +1004,9 @@ components:
     values:
       type: object
       properties:
-        Timestamp:
-          type: integer
-          format: int64
-          deprecated: true
         timestamp:
           type: integer
           format: int64
-        Value:
-          type: number
-          format: double
-          deprecated: true
         value:
           type: number
           format: double
@@ -1053,17 +1037,9 @@ components:
           type: object
           additionalProperties:
             type: string
-        Timestamp:
-          type: integer
-          format: int64
-          deprecated: true
         timestamp:
           type: integer
           format: int64
-        Value:
-          type: number
-          format: double
-          deprecated: true
         value:
           type: number
           format: double
@@ -1110,7 +1086,7 @@ components:
     filters:
       name: filters
       in: query
-      description: List of metrics to fetch. Fetch all metrics when empty. List entries are Kakfa internal metric names.
+      description: List of metrics to fetch. Fetch all metrics when empty. List entries are Kafka internal metric names.
       schema:
         type: array
         items:
@@ -1141,13 +1117,13 @@ components:
         Specifies the order by criteria. The syntax of this parameter is
         similar to the syntax of the `order by` clause of an SQL statement.
         Each query can be ordered by any of the `kafkaRequests` fields.
-        For example, to return all Kakfa instances ordered by their name, use the following syntax:
+        For example, to return all Kafka instances ordered by their name, use the following syntax:
 
         ```sql
         name asc
         ```
 
-        To return all Kakfa instances ordered by their name _and_ created date, use the following syntax:
+        To return all Kafka instances ordered by their name _and_ created date, use the following syntax:
 
         ```sql
         name asc, created_at asc
@@ -1175,19 +1151,19 @@ components:
 
         Examples:
 
-        To return a Kakfa instance with the name `my-kafka` and the region `aws`, use the following syntax:
+        To return a Kafka instance with the name `my-kafka` and the region `aws`, use the following syntax:
 
         ```
         name = my-kafka and cloud_provider = aws
         ```[p-]
 
-        To return a Kakfa instance with a name that starts with `my`, use the following syntax:
+        To return a Kafka instance with a name that starts with `my`, use the following syntax:
 
         ```
         name like my%25
         ```
 
-        If the parameter isn't provided, or if the value is empty, then all the Kakfa instances
+        If the parameter isn't provided, or if the value is empty, then all the Kafka instances
         that the user has permission to see are returned.
 
         Note. If the query is invalid, an error is returned.
@@ -1246,7 +1222,7 @@ components:
         bootstrap_server_host: "serviceapi-1isy6rq3jki8q0otmjqfd3ocfrg.apps.mk-bttg0jn170hp.x5u8.s1.devshift.org"
         created_at: "2020-10-05T12:51:24.053142Z"
         updated_at: "2020-10-05T12:56:36.362208Z"
-        failed_reason: "a reason the Kakfa request creation failed"
+        failed_reason: "a reason the Kafka request creation failed"
     CloudProviderExample:
       value:
         kind: "CloudProvider"
@@ -1338,7 +1314,7 @@ components:
         kind: "Error"
         href: "/api/kafkas_mgmt/v1/errors/23"
         code: "KAFKAS-MGMT-23"
-        reason: "Failed to parse search query: Unable to list Kakfa requests for api_kafka_service: KAFKAS-MGMT-23: Failed to parse search query: Unsupported column name for search: 'id'. Supported column names are: region, name, cloud_provider, name, status. Query invalid: id = 123"
+        reason: "Failed to parse search query: Unable to list Kafka requests for api_kafka_service: KAFKAS-MGMT-23: Failed to parse search query: Unsupported column name for search: 'id'. Supported column names are: region, name, cloud_provider, name, status. Query invalid: id = 123"
         operation_id: "1lWDGuybIrEnxrAem724gqkkiDv"
     404Example:
       value:
@@ -1379,6 +1355,14 @@ components:
         code: "KAFKAS-MGMT-5"
         reason: "User 'foo-bar' has reached a maximum number of 6 allowed instances."
         operation_id: "1lY3UiEkxnXBpVPeI2oNejd3XB"
+    403TermsNotAcceptedExample:
+      value:
+        id: "12"
+        kind: "Error"
+        href: "/api/kafkas_mgmt/v1/errors/12"
+        code: "KAFKAS-MGMT-12"
+        reason: "Required terms have not been accepted"
+        operation_id: "kXCzWPeI2oXBpVPeI2LvF9jMQY"
     409NameConflictExample:
       value:
         id: "36"
@@ -1405,4 +1389,4 @@ components:
           for cluster id: 1g5d88q0lrcdv4g7alb7slfgnj3dhbsj%!(EXTRA *errors.Error=identifier
           is '404', code is 'CLUSTERS-MGMT-404' and operation identifier is '1g5or50viu07oealuehrkc26dgftj1ac':
           Cluster '1g5d88q0lrcdv4g7alb7slfgnj3dhbsj' not found)"
-        operation_id: "1iYTsWry6nsqb2sNmFj5bXpD7Ca"
+        operation_id: "1iYTsWry6nsqb2sNmFj5bXpD7Ca"