From bb02481289dc54b1ca8646b53d7618a21ed2dc00 Mon Sep 17 00:00:00 2001 From: Rohit Jnagal Date: Tue, 6 Jan 2015 22:51:52 +0000 Subject: [PATCH] Update API doc with new machine API output. --- docs/api.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index b4c02242..961a7ea3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -64,11 +64,15 @@ The actual object is the marshalled JSON of the `ContainerInfo` struct found in The resource name for machine information is as follows: -`/api/v1.0/machine` +`/api/vX.Y/machine` This resource is read-only. The machine information is returned as a JSON object containing: - Number of schedulable logical CPU cores - Memory capacity (in bytes) +- Maximum supported CPU frequency (in kHz) +- Available filesystems: major, minor numbers and capacity (in bytes) +- Network devices: mac addresses, MTU, and speed (if available) +- Machine topology: Nodes, cores, threads, per-node memory, and caches The actual object is the marshalled JSON of the `MachineInfo` struct found in [info/machine.go](info/machine.go)