mirror of
https://github.com/moby/moby.git
synced 2026-06-30 19:58:03 +00:00
44e1ccd0a3
Add missing Go doc comments to the exported option and result types in config_remove.go, config_update.go, secret_remove.go, secret_update.go, node_inspect.go, node_list.go, node_remove.go, and node_update.go. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Poyraz Küçükarslan <83272398+PoyrazK@users.noreply.github.com>
32 lines
693 B
Go
32 lines
693 B
Go
package client
|
|
|
|
import (
|
|
"context"
|
|
"net/url"
|
|
)
|
|
|
|
// NodeRemoveOptions holds parameters to remove nodes with.
|
|
type NodeRemoveOptions struct {
|
|
Force bool
|
|
}
|
|
|
|
// NodeRemoveResult holds the result of [Client.NodeRemove].
|
|
type NodeRemoveResult struct{}
|
|
|
|
// NodeRemove removes a Node.
|
|
func (cli *Client) NodeRemove(ctx context.Context, nodeID string, options NodeRemoveOptions) (NodeRemoveResult, error) {
|
|
nodeID, err := trimID("node", nodeID)
|
|
if err != nil {
|
|
return NodeRemoveResult{}, err
|
|
}
|
|
|
|
query := url.Values{}
|
|
if options.Force {
|
|
query.Set("force", "1")
|
|
}
|
|
|
|
resp, err := cli.delete(ctx, "/nodes/"+nodeID, query, nil)
|
|
defer ensureReaderClosed(resp)
|
|
return NodeRemoveResult{}, err
|
|
}
|