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.

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

[19.03 backport] Swagger Updates #41248

Merged
merged 9 commits into from
Jul 27, 2020
1,302 changes: 962 additions & 340 deletions api/swagger.yaml

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion api/types/container/container_top.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ package container // import "github.com/docker/docker/api/types/container"
// swagger:model ContainerTopOKBody
type ContainerTopOKBody struct {

// Each process running in the container, where each is process is an array of values corresponding to the titles
// Each process running in the container, where each is process
// is an array of values corresponding to the titles.
//
// Required: true
Processes [][]string `json:"Processes"`

Expand Down
5 changes: 4 additions & 1 deletion api/types/volume.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,13 @@ type Volume struct {
Name string `json:"Name"`

// The driver specific options used when creating the volume.
//
// Required: true
Options map[string]string `json:"Options"`

// The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.
// The level at which the volume exists. Either `global` for cluster-wide,
// or `local` for machine level.
//
// Required: true
Scope string `json:"Scope"`

Expand Down
5 changes: 4 additions & 1 deletion api/types/volume/volume_create.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ type VolumeCreateBody struct {
// Required: true
Driver string `json:"Driver"`

// A mapping of driver options and values. These options are passed directly to the driver and are driver specific.
// A mapping of driver options and values. These options are
// passed directly to the driver and are driver specific.
//
// Required: true
DriverOpts map[string]string `json:"DriverOpts"`

Expand All @@ -24,6 +26,7 @@ type VolumeCreateBody struct {
Labels map[string]string `json:"Labels"`

// The new volume's name. If not specified, Docker generates a name.
//
// Required: true
Name string `json:"Name"`
}
3 changes: 2 additions & 1 deletion api/types/volume/volume_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ type VolumeListOKBody struct {
// Required: true
Volumes []*types.Volume `json:"Volumes"`

// Warnings that occurred when fetching the list of volumes
// Warnings that occurred when fetching the list of volumes.
//
// Required: true
Warnings []string `json:"Warnings"`
}