address review comment, added warning to host replace as well

HewlettPackard · Oct 31, 2023 · 7449e18 · 7449e18
1 parent 1f696f0
commit 7449e18
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 11 deletions.
diff --git a/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml b/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml
@@ -5,7 +5,7 @@ post:
   summary: Reimage Host by ID
   description: >-
     Re-deploys a host to the same machine.
-    Warning, all drives will be erased!
+    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/api/swagger/paths/hosts@{hostId}@replace.yaml b/v1/api/swagger/paths/hosts@{hostId}@replace.yaml
@@ -5,6 +5,7 @@ post:
   summary: Replace Host by ID
   description: >-
     Re-deploys a host with a new machine that satisfies the current host settings.
+    WARNING -- all drives will be erased!
     Only the machine is replaced, IP addresses, volumes, etc are not changed.
     The host must be powered off.  The host must also be in the Ready state or in
     the Failed state and in the Replace or Maintenace workflow.

diff --git a/v1/pkg/client/api/openapi.yaml b/v1/pkg/client/api/openapi.yaml
@@ -1177,7 +1177,7 @@ paths:
     summary: Set a specific host to attempt HDD boot
   /hosts/{hostId}/reimage:
     post:
-      description: Re-deploys a host to the same machine. Warning, all drives will
+      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.
@@ -1227,9 +1227,10 @@ paths:
   /hosts/{hostId}/replace:
     post:
       description: Re-deploys a host with a new machine that satisfies the current
-        host settings. Only the machine is replaced, IP addresses, volumes, etc are
-        not changed. The host must be powered off.  The host must also be in the Ready
-        state or in the Failed state and in the Replace or Maintenace workflow.
+        host settings. WARNING -- all drives will be erased! Only the machine is replaced,
+        IP addresses, volumes, etc are not changed. The host must be powered off.  The
+        host must also be in the Ready state or in the Failed state and in the Replace
+        or Maintenace workflow.
       operationId: replace
       parameters:
       - description: ID of Host to replace

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. 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.
+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
@@ -1657,7 +1657,7 @@ func (a *HostsApiService) Reimage(ctx _context.Context, hostId string) (Host, *_
 
 /*
 Replace Replace Host by ID
-Re-deploys a host with a new machine that satisfies the current host settings. Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.
+Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.
  * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  * @param hostId ID of Host to replace
 @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. 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.
+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
 
@@ -409,7 +409,7 @@ Name | Type | Description  | Notes
 
 Replace Host by ID
 
-Re-deploys a host with a new machine that satisfies the current host settings. Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.
+Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off.  The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.
 
 ### Required Parameters
 

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