HYPERFLEET-1075 - docs: Clarify force-delete is

database-only

Author: pnguyen44

schemas/core/openapi.yaml

@@ -245,8 +245,8 @@ paths:
       operationId: forceDeleteCluster
       summary: Force-delete a cluster
       description: |-
-        Permanently removes a cluster that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+        Permanently removes the cluster record from the database for a cluster stuck in Finalizing state.
+        This is a database-only operation. Requires a reason for audit purposes.
       parameters:
         - name: cluster_id
           in: path
@@ -535,8 +535,8 @@ paths:
       operationId: forceDeleteNodePool
       summary: Force-delete a nodepool
       description: |-
-        Permanently removes a nodepool that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+        Permanently removes the nodepool record from the database for a nodepool stuck in Finalizing state.
+        This is a database-only operation. Requires a reason for audit purposes.
       parameters:
         - name: cluster_id
           in: path

schemas/core/swagger.yaml

@@ -327,9 +327,11 @@ paths:
         - BearerAuth: []
       tags:
         - Clusters
-      description: |-
-        Permanently removes a cluster that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+      description: >-
+        Permanently removes the cluster record from the database for a cluster
+        stuck in Finalizing state.
+
+        This is a database-only operation. Requires a reason for audit purposes.
       operationId: forceDeleteCluster
       summary: Force-delete a cluster
   '/api/hyperfleet/v1/clusters/{cluster_id}/nodepools':
@@ -654,9 +656,11 @@ paths:
         - BearerAuth: []
       tags:
         - NodePools
-      description: |-
-        Permanently removes a nodepool that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+      description: >-
+        Permanently removes the nodepool record from the database for a nodepool
+        stuck in Finalizing state.
+
+        This is a database-only operation. Requires a reason for audit purposes.
       operationId: forceDeleteNodePool
       summary: Force-delete a nodepool
   '/api/hyperfleet/v1/clusters/{cluster_id}/nodepools/{nodepool_id}/statuses':

schemas/gcp/openapi.yaml

@@ -264,8 +264,8 @@ paths:
       operationId: forceDeleteCluster
       summary: Force-delete a cluster
       description: |-
-        Permanently removes a cluster that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+        Permanently removes the cluster record from the database for a cluster stuck in Finalizing state.
+        This is a database-only operation. Requires a reason for audit purposes.
       parameters:
         - name: cluster_id
           in: path
@@ -573,8 +573,8 @@ paths:
       operationId: forceDeleteNodePool
       summary: Force-delete a nodepool
       description: |-
-        Permanently removes a nodepool that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+        Permanently removes the nodepool record from the database for a nodepool stuck in Finalizing state.
+        This is a database-only operation. Requires a reason for audit purposes.
       parameters:
         - name: cluster_id
           in: path

schemas/gcp/swagger.yaml

@@ -347,9 +347,11 @@ paths:
         - BearerAuth: []
       tags:
         - Clusters
-      description: |-
-        Permanently removes a cluster that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+      description: >-
+        Permanently removes the cluster record from the database for a cluster
+        stuck in Finalizing state.
+
+        This is a database-only operation. Requires a reason for audit purposes.
       operationId: forceDeleteCluster
       summary: Force-delete a cluster
   '/api/hyperfleet/v1/clusters/{cluster_id}/nodepools':
@@ -693,9 +695,11 @@ paths:
         - BearerAuth: []
       tags:
         - NodePools
-      description: |-
-        Permanently removes a nodepool that is stuck in Finalizing state.
-        Requires a reason for audit purposes.
+      description: >-
+        Permanently removes the nodepool record from the database for a nodepool
+        stuck in Finalizing state.
+
+        This is a database-only operation. Requires a reason for audit purposes.
       operationId: forceDeleteNodePool
       summary: Force-delete a nodepool
   '/api/hyperfleet/v1/clusters/{cluster_id}/nodepools/{nodepool_id}/statuses':

services/clusters.tsp

@@ -91,8 +91,8 @@ interface Clusters {
     | BadRequestResponse;
 
   /**
-   * Permanently removes a cluster that is stuck in Finalizing state.
-   * Requires a reason for audit purposes.
+   * Permanently removes the cluster record from the database for a cluster stuck in Finalizing state.
+   * This is a database-only operation. Requires a reason for audit purposes.
    */
   @route("/{cluster_id}/force-delete")
   @post

services/nodepools.tsp

@@ -96,8 +96,8 @@ interface NodePools {
       | BadRequestResponse;
 
     /**
-     * Permanently removes a nodepool that is stuck in Finalizing state.
-     * Requires a reason for audit purposes.
+     * Permanently removes the nodepool record from the database for a nodepool stuck in Finalizing state.
+     * This is a database-only operation. Requires a reason for audit purposes.
      */
     @route("/clusters/{cluster_id}/nodepools/{nodepool_id}/force-delete")
     @post