Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DE19361: Host Reimage API doc should warn of erasing disk #99

Merged
merged 5 commits into from
Oct 31, 2023
Merged

DE19361: Host Reimage API doc should warn of erasing disk #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f132b9
[auto generated] Checking in generated offline HTML doc
ron-saito Oct 31, 2023
1f696f0
DE19361:Host Reimage API doc should warn of erasing disk
ron-saito Oct 31, 2023
7449e18
address review comment, added warning to host replace as well
ron-saito Oct 31, 2023
85a90d9
Merge branch 'cytoe/DE19361' of github.com:hewlettpackard/hpegl-metal…
ron-saito Oct 31, 2023
6dc347f
[auto generated] Checking in generated offline HTML doc
ron-saito Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions v1/api/swagger/paths/hosts@{hostId}@reimage.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions v1/api/swagger/paths/hosts@{hostId}@replace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions v1/html/index.html
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions v1/pkg/client/api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -1226,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
Expand Down
4 changes: 2 additions & 2 deletions v1/pkg/client/api_hosts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions v1/pkg/client/docs/HostsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions v1/pkg/client/interface_hosts.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.