DE19361:Host Reimage API doc should warn of erasing disk

HewlettPackard · Oct 31, 2023 · 1f696f0 · 1f696f0
1 parent 468b1ad
commit 1f696f0
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 6 deletions.
diff --git a/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml b/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml
@@ -5,6 +5,7 @@ post:
   summary: Reimage Host by ID
   description: >-
     Re-deploys a host to the same machine.
+    Warning, all drives will be erased!
     Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed.
     The host must be powered off.  The host must also be in the Ready state.
   operationId: reimage

diff --git a/v1/pkg/client/api/openapi.yaml b/v1/pkg/client/api/openapi.yaml
@@ -1177,9 +1177,10 @@ paths:
     summary: Set a specific host to attempt HDD boot
   /hosts/{hostId}/reimage:
     post:
-      description: Re-deploys a host to the same machine. Only the Host OS is reinstalled,
-        IP addresses, volumes, etc are not changed. The host must be powered off.  The
-        host must also be in the Ready state.
+      description: Re-deploys a host to the same machine. Warning, all drives will
+        be erased! Only the Host OS is reinstalled, IP addresses, volumes, etc are
+        not changed. The host must be powered off.  The host must also be in the Ready
+        state.
       operationId: reimage
       parameters:
       - description: ID of Host to reimage

diff --git a/v1/pkg/client/api_hosts.go b/v1/pkg/client/api_hosts.go
@@ -1506,7 +1506,7 @@ func (a *HostsApiService) PowerReset(ctx _context.Context, hostId string) (Host,
 
 /*
 Reimage Reimage Host by ID
-Re-deploys a host to the same machine. Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state.
+Re-deploys a host to the same machine. Warning, all drives will be erased! Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state.
  * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  * @param hostId ID of Host to reimage
 @return Host

diff --git a/v1/pkg/client/docs/HostsApi.md b/v1/pkg/client/docs/HostsApi.md
@@ -375,7 +375,7 @@ Name | Type | Description  | Notes
 
 Reimage Host by ID
 
-Re-deploys a host to the same machine. Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state.
+Re-deploys a host to the same machine. Warning, all drives will be erased! Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state.
 
 ### Required Parameters
 

diff --git a/v1/pkg/client/interface_hosts.go b/v1/pkg/client/interface_hosts.go