Files
moby/client/node_inspect.go
Poyraz Küçükarslan 44e1ccd0a3 client: add missing doc comments to config, secret, and node types
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>
2026-03-14 11:21:58 +01:00

43 lines
1001 B
Go

package client
import (
"bytes"
"context"
"encoding/json"
"io"
"github.com/moby/moby/api/types/swarm"
)
// NodeInspectOptions holds parameters to inspect nodes with.
type NodeInspectOptions struct{}
// NodeInspectResult holds the result of [Client.NodeInspect].
type NodeInspectResult struct {
Node swarm.Node
Raw json.RawMessage
}
// NodeInspect returns the node information.
func (cli *Client) NodeInspect(ctx context.Context, nodeID string, options NodeInspectOptions) (NodeInspectResult, error) {
nodeID, err := trimID("node", nodeID)
if err != nil {
return NodeInspectResult{}, err
}
resp, err := cli.get(ctx, "/nodes/"+nodeID, nil, nil)
defer ensureReaderClosed(resp)
if err != nil {
return NodeInspectResult{}, err
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return NodeInspectResult{}, err
}
var response swarm.Node
rdr := bytes.NewReader(body)
err = json.NewDecoder(rdr).Decode(&response)
return NodeInspectResult{Node: response, Raw: body}, err
}