Remove cordon endpoints from the openapi specifications

storageos · Jan 4, 2022 · 5bb6550 · 5bb6550
1 parent e49e348
commit 5bb6550
Show file tree

Hide file tree

Showing 8 changed files with 6 additions and 417 deletions.
diff --git a/pkg/openapi/README.md b/pkg/openapi/README.md
@@ -67,7 +67,6 @@ Class | Method | HTTP request | Description
 *DefaultApi* | [**RefreshJwt**](docs/DefaultApi.md#refreshjwt) | **Post** /auth/refresh | Refresh the JWT
 *DefaultApi* | [**ResizeVolume**](docs/DefaultApi.md#resizevolume) | **Put** /namespaces/{namespaceID}/volumes/{id}/size | Increase the size of a volume.
 *DefaultApi* | [**SetComputeOnly**](docs/DefaultApi.md#setcomputeonly) | **Put** /nodes/{id}/compute-only | Modify the computeonly behaviour state for a node
-*DefaultApi* | [**SetCordoned**](docs/DefaultApi.md#setcordoned) | **Put** /nodes/{id}/cordon | Modify the cordoned state for a node
 *DefaultApi* | [**SetFailureMode**](docs/DefaultApi.md#setfailuremode) | **Put** /namespaces/{namespaceID}/volumes/{id}/failure-mode | Set the failure mode of the volume.
 *DefaultApi* | [**SetPlacementStrategy**](docs/DefaultApi.md#setplacementstrategy) | **Put** /namespaces/{namespaceID}/volumes/{id}/placement-strategy | Sets the placement strategy of the volume.
 *DefaultApi* | [**SetReplicas**](docs/DefaultApi.md#setreplicas) | **Put** /namespaces/{namespaceID}/volumes/{id}/replicas | Set the number of replicas to maintain for the volume.
@@ -126,7 +125,6 @@ Class | Method | HTTP request | Description
  - [ReplicaHealth](docs/ReplicaHealth.md)
  - [ResizeVolumeRequest](docs/ResizeVolumeRequest.md)
  - [SetComputeOnlyNodeData](docs/SetComputeOnlyNodeData.md)
- - [SetCordonedNodeData](docs/SetCordonedNodeData.md)
  - [SetFailureModeIntentRequestData](docs/SetFailureModeIntentRequestData.md)
  - [SetFailureModeRequest](docs/SetFailureModeRequest.md)
  - [SetFailureThresholdRequestData](docs/SetFailureThresholdRequestData.md)

diff --git a/pkg/openapi/api/openapi.yaml b/pkg/openapi/api/openapi.yaml
@@ -1998,127 +1998,6 @@ paths:
       security:
       - jwt: []
       summary: Modify the computeonly behaviour state for a node
-  /nodes/{id}/cordon:
-    put:
-      description: |
-        Set the cordoned state for the node corresponding  to id given by the request.
-      operationId: setCordoned
-      parameters:
-      - description: ID of a Node
-        explode: false
-        in: path
-        name: id
-        required: true
-        schema:
-          $ref: '#/components/schemas/NodeID'
-        style: simple
-      - description: |
-          If set to true this value indicates that the user wants to ignore entity version constraints, thereby "forcing" the operation.
-        explode: true
-        in: query
-        name: ignore-version
-        required: false
-        schema:
-          $ref: '#/components/schemas/IgnoreVersion'
-        style: form
-      requestBody:
-        $ref: '#/components/requestBodies/SetCordonedNodeData'
-        content:
-          application/json:
-            schema:
-              example:
-                cordoned: true
-                version: NDI0MjQyNDI0MjQyNDI0MjQy
-              properties:
-                cordoned:
-                  description: |
-                    Marks the node's desired cordoned state state.  A cordoned node will not have new volume deployments scheduled on it.
-                  example: true
-                  type: boolean
-                version:
-                  description: |
-                    An opaque representation of an entity version at the time it was obtained from the API.
-                    All operations that mutate the entity must include this version field in the request unchanged.
-                    The format of this type is undefined and may change but the defined properties will not change.
-                  example: NDI0MjQyNDI0MjQyNDI0MjQy
-                  maxLength: 30
-                  type: string
-              title: SetCordonedNodeData
-              type: object
-        description: Desired cordoned state for the node.
-        required: true
-      responses:
-        "200":
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Node'
-          description: The node was successfully updated
-        "400":
-          content:
-            application/json:
-              example:
-                error: a short description of the validation failure
-              schema:
-                $ref: '#/components/schemas/Error'
-          description: The request does not conform to the API specification.
-        "401":
-          content:
-            application/json:
-              example:
-                error: authentication required
-              schema:
-                $ref: '#/components/schemas/Error'
-          description: |
-            The requested endpoint requires authentication - you must log in first.
-            If attempting to log in, your credentials were not recognised.
-        "403":
-          content:
-            application/json:
-              example:
-                error: unauthorised
-              schema:
-                $ref: '#/components/schemas/Error'
-          description: |
-            The authenticated user does not have permission to perform the requested action.
-        "404":
-          content:
-            application/json:
-              example:
-                error: not found
-              schema:
-                $ref: '#/components/schemas/Error'
-          description: |
-            A referenced resource does not exist.
-        "412":
-          content:
-            application/json:
-              example:
-                error: attempting to write stale object
-              schema:
-                $ref: '#/components/schemas/Error'
-          description: |
-            The entity to be wrote has been concurrently updated by another request - the submitted entity data has been replaced.
-            The caller should fetch the entity again, check the actions are still required and resubmit the request with the new entity version field.
-        "500":
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-          description: |
-            The request caused an internal server error and should be retried.
-            Check the health of the node/cluster and if the error persists, contact support.
-        "503":
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-          description: |
-            The server is currently unable to handle the request due to a temporary store failure.
-            Check the health of the node/cluster and if the error persists, contact support.
-      security:
-      - jwt: []
-      summary: Modify the cordoned state for a node
   /policies:
     get:
       description: Fetch the list of policy groups in the cluster.
@@ -5033,12 +4912,6 @@ components:
           schema:
             $ref: '#/components/schemas/SetComputeOnlyNodeData'
       required: true
-    SetCordonedNodeData:
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/SetCordonedNodeData'
-      required: true
     CreateVolumeData:
       content:
         application/json:
@@ -5992,9 +5865,14 @@ components:
       - $ref: '#/components/schemas/ReplicaDeploymentInfo_allOf'
     Node:
       example:
-        cordonedAt: 2019-03-29T23:13:13Z
+        createdAt: 2019-03-10T13:42:42Z
         gossipEndpoint: '["192.0.2.1:5711"]'
+        ioEndpoint: '["192.0.2.1:5703"]'
+        name: db1.lcy.storageos.network
         health: online
+        id: c5666b58-b805-4215-ab4a-cb094948ccc6
+        supervisorEndpoint: '["192.0.2.1:5704"]'
+        clusteringEndpoint: '["192.0.2.1:5710"]'
         version: NDI0MjQyNDI0MjQyNDI0MjQy
         capacity:
           total: 42
@@ -6003,13 +5881,6 @@ components:
         labels:
           env: prod
           rack: db-1
-        createdAt: 2019-03-10T13:42:42Z
-        ioEndpoint: '["192.0.2.1:5703"]'
-        name: db1.lcy.storageos.network
-        cordoned: false
-        id: c5666b58-b805-4215-ab4a-cb094948ccc6
-        supervisorEndpoint: '["192.0.2.1:5704"]'
-        clusteringEndpoint: '["192.0.2.1:5710"]'
         updatedAt: 2019-03-29T23:13:13Z
       properties:
         id:
@@ -6057,22 +5928,6 @@ components:
           example: '["192.0.2.1:5710"]'
           readOnly: true
           type: string
-        cordoned:
-          default: false
-          description: |
-            Cordoned describes the cordoned state of the node.
-            A cordoned node will not have new volume deployments scheduled on it
-          readOnly: true
-          type: boolean
-        cordonedAt:
-          description: |
-            The time the node has been cordoned. This field's purpose is informative only.
-
-            String format is RFC3339.
-          example: 2019-03-29T23:13:13Z
-          format: date-time
-          readOnly: true
-          type: string
         labels:
           additionalProperties:
             type: string
@@ -6616,26 +6471,6 @@ components:
           type: string
       title: SetComputeOnlyNodeData
       type: object
-    SetCordonedNodeData:
-      example:
-        cordoned: true
-        version: NDI0MjQyNDI0MjQyNDI0MjQy
-      properties:
-        cordoned:
-          description: |
-            Marks the node's desired cordoned state state.  A cordoned node will not have new volume deployments scheduled on it.
-          example: true
-          type: boolean
-        version:
-          description: |
-            An opaque representation of an entity version at the time it was obtained from the API.
-            All operations that mutate the entity must include this version field in the request unchanged.
-            The format of this type is undefined and may change but the defined properties will not change.
-          example: NDI0MjQyNDI0MjQyNDI0MjQy
-          maxLength: 30
-          type: string
-      title: SetCordonedNodeData
-      type: object
     _policies_specs:
       properties:
         namespaceID: