Fix documentation of RequestOptions.IdType

rhcarvalho · rhcarvalho · commit 8e7af74d9795 · 2021-08-02T17:23:16.000+02:00
The only valid options are "name" (default) or "docker", while "dockerid" and "dockeralias" fail with an 'unknown type' error. Reference: https://github.com/google/cadvisor/blob/20e306ab0398f00daaafeda2444b9ec157636f74/cmd/internal/api/versions.go#L531-L540
diff --git a/info/v2/container.go b/info/v2/container.go
@@ -263,7 +263,7 @@ type FsInfo struct {
 }
 
 type RequestOptions struct {
-	// Type of container identifier specified - "name", "dockerid", dockeralias"
+	// Type of container identifier specified - TypeName (default) or TypeDocker
 	IdType string `json:"type"`
 	// Number of stats to return
 	Count int `json:"count"`

Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ type FsInfo struct {`
`263`	`263`	`}`
`264`	`264`
`265`	`265`	`type RequestOptions struct {`
`266`		`- // Type of container identifier specified - "name", "dockerid", dockeralias"`
	`266`	`+ // Type of container identifier specified - TypeName (default) or TypeDocker`
`267`	`267`	IdType string `json:"type"`
`268`	`268`	`// Number of stats to return`
`269`	`269`	Count int `json:"count"`