diff --git a/_vendor/github.com/docker/cli/docs/reference/dockerd.md b/_vendor/github.com/docker/cli/docs/reference/dockerd.md index 1dcb191626..61a342c655 100644 --- a/_vendor/github.com/docker/cli/docs/reference/dockerd.md +++ b/_vendor/github.com/docker/cli/docs/reference/dockerd.md @@ -25,6 +25,7 @@ A self-sufficient runtime for containers. Options: --add-runtime runtime Register an additional OCI compatible runtime (default []) --allow-direct-routing Allow remote access to published ports on container IP addresses + --apparmor-profile string Path to AppArmor profile template --authorization-plugin list Authorization plugins to load --bip string IPv4 address for the default bridge --bip6 string IPv6 address for the default bridge @@ -51,6 +52,7 @@ Options: --default-network-opt mapmap Default network options (default map[]) --default-runtime string Default OCI runtime for containers (default "runc") --default-shm-size bytes Default shm size for containers (default 64MiB) + --default-stop-timeout int Set the default container stop timeout in seconds (0 to terminate immediately) (default 10) --default-ulimit ulimit Default ulimits for containers (default []) --dns list DNS server to use --dns-opt list DNS options to use @@ -758,6 +760,18 @@ This only adds the proxy and authentication to the Docker daemon's requests. To use the proxy when building images and running containers, see [Configure Docker to use a proxy server](https://docs.docker.com/engine/cli/proxy/) +### Default container stop timeout + +The `--default-stop-timeout` flag sets the number of seconds to wait for a +container to stop when the container doesn't have a `--stop-timeout` configured. +The default is `10` seconds on Linux and `30` seconds on Windows. A value of `0` +doesn't wait before forcefully terminating the container. Negative values are +invalid. + +You can also configure the timeout with the `default-stop-timeout` option in the +[daemon configuration file](#daemon-configuration-file). You can reload this +option without restarting the daemon. + ### Default `ulimit` settings The `--default-ulimit` flag lets you set the default `ulimit` options to use for @@ -793,6 +807,24 @@ allow the request for it to complete. For information about how to create an authorization plugin, refer to the [authorization plugin](https://docs.docker.com/engine/extend/plugins_authorization/) section. +### Configure the default AppArmor profile + +The `--apparmor-profile` option sets the path to an AppArmor profile definition +for Docker's default `docker-default` container profile. This option is only +supported on Linux hosts. The file can be a static profile or a Go template. + +The equivalent `daemon.json` configuration is: + +```json +{ + "apparmor-profile": "/etc/docker/apparmor/docker-default" +} +``` + +Restart the daemon to apply changes. For template values, safe file placement, +security considerations, and verification, see +[Customize the default AppArmor profile](https://docs.docker.com/engine/security/apparmor/#customize-the-default-profile). + ### Daemon user namespace options The Linux kernel @@ -1066,6 +1098,7 @@ The following is a full example of the allowed configuration options on Linux: ```json { "allow-direct-routing": false, + "apparmor-profile": "", "authorization-plugins": [], "bip": "", "bip6": "", @@ -1104,6 +1137,7 @@ The following is a full example of the allowed configuration options on Linux: "default-network-opts": {}, "default-runtime": "runc", "default-shm-size": "64M", + "default-stop-timeout": 10, "default-ulimits": { "nofile": { "Hard": 64000, @@ -1225,6 +1259,7 @@ The following is a full example of the allowed configuration options on Windows: "debug": true, "default-network-opts": {}, "default-runtime": "", + "default-stop-timeout": 30, "default-ulimits": {}, "dns": [], "dns-opts": [], @@ -1317,6 +1352,7 @@ The list of currently supported options that can be reconfigured is this: | `max-concurrent-uploads` | Configures the max concurrent uploads for each push. | | `max-download-attempts` | Configures the max download attempts for each pull. | | `default-runtime` | Configures the runtime to be used if not is specified at container creation. | +| `default-stop-timeout` | Configures the timeout for stopping containers that have no container-specific timeout. | | `runtimes` | Configures the list of available OCI runtimes that can be used to run containers. | | `authorization-plugin` | Specifies the authorization plugins to use. | | `insecure-registries` | Specifies a list of registries that the daemon should consider insecure. | diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose.md index d80bb86ec6..50ebfba473 100644 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose.md +++ b/_vendor/github.com/docker/compose/v5/docs/reference/compose.md @@ -28,7 +28,7 @@ Define and run multi-container applications with Docker | [`logs`](compose_logs.md) | View output from containers | | [`ls`](compose_ls.md) | List running compose projects | | [`pause`](compose_pause.md) | Pause services | -| [`port`](compose_port.md) | Print the public port for a port binding | +| [`port`](compose_port.md) | List port mappings or print the public port for a specific mapping for the service | | [`ps`](compose_ps.md) | List containers | | [`publish`](compose_publish.md) | Publish compose application | | [`pull`](compose_pull.md) | Pull service images | diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_publish.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_publish.md deleted file mode 100644 index 6e77d71453..0000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_alpha_publish.md +++ /dev/null @@ -1,18 +0,0 @@ -# docker compose alpha publish - - -Publish compose application - -### Options - -| Name | Type | Default | Description | -|:--------------------------|:---------|:--------|:-------------------------------------------------------------------------------| -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--oci-version` | `string` | | OCI image/artifact specification version (automatically determined by default) | -| `--resolve-image-digests` | `bool` | | Pin image tags to digests | -| `--with-env` | `bool` | | Include environment variables in the published OCI artifact | -| `-y`, `--yes` | `bool` | | Assume "yes" as answer to all prompts | - - - - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/compose_port.md b/_vendor/github.com/docker/compose/v5/docs/reference/compose_port.md index bbbfbf1561..a0b828a10e 100644 --- a/_vendor/github.com/docker/compose/v5/docs/reference/compose_port.md +++ b/_vendor/github.com/docker/compose/v5/docs/reference/compose_port.md @@ -1,7 +1,7 @@ # docker compose port -Prints the public port for a port binding +List port mappings or print the public port for a specific mapping for the service ### Options @@ -16,4 +16,4 @@ Prints the public port for a port binding ## Description -Prints the public port for a port binding +List port mappings or print the public port for a specific mapping for the service diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha.yaml b/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha.yaml index e6b6b6e6b6..370e89670f 100644 --- a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha.yaml +++ b/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha.yaml @@ -5,11 +5,9 @@ pname: docker compose plink: docker_compose.yaml cname: - docker compose alpha generate - - docker compose alpha publish - docker compose alpha viz clink: - docker_compose_alpha_generate.yaml - - docker_compose_alpha_publish.yaml - docker_compose_alpha_viz.yaml inherited_options: - option: dry-run diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_publish.yaml b/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_publish.yaml deleted file mode 100644 index 9059cbf486..0000000000 --- a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_alpha_publish.yaml +++ /dev/null @@ -1,86 +0,0 @@ -command: docker compose alpha publish -short: Publish compose application -long: Publish compose application -usage: docker compose alpha publish [OPTIONS] REPOSITORY[:TAG] -pname: docker compose alpha -plink: docker_compose_alpha.yaml -options: - - option: app - value_type: bool - default_value: "false" - description: Published compose application (includes referenced images) - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: insecure-registry - value_type: bool - default_value: "false" - description: Use insecure registry - deprecated: false - hidden: true - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: oci-version - value_type: string - description: | - OCI image/artifact specification version (automatically determined by default) - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: resolve-image-digests - value_type: bool - default_value: "false" - description: Pin image tags to digests - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: with-env - value_type: bool - default_value: "false" - description: Include environment variables in the published OCI artifact - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: "yes" - shorthand: "y" - value_type: bool - default_value: "false" - description: Assume "yes" as answer to all prompts - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -inherited_options: - - option: dry-run - value_type: bool - default_value: "false" - description: Execute command in dry run mode - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -hidden: true -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_port.yaml b/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_port.yaml index 8a07f31ea5..88acd4be6d 100644 --- a/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_port.yaml +++ b/_vendor/github.com/docker/compose/v5/docs/reference/docker_compose_port.yaml @@ -1,7 +1,9 @@ command: docker compose port -short: Print the public port for a port binding -long: Prints the public port for a port binding -usage: docker compose port [OPTIONS] SERVICE PRIVATE_PORT +short: | + List port mappings or print the public port for a specific mapping for the service +long: | + List port mappings or print the public port for a specific mapping for the service +usage: docker compose port [OPTIONS] SERVICE [PRIVATE_PORT] pname: docker compose plink: docker_compose.yaml options: diff --git a/_vendor/github.com/moby/moby/api/docs/v1.25.yaml b/_vendor/github.com/moby/moby/api/docs/v1.25.yaml index 096e25ec77..ba97ed5add 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.25.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.25.yaml @@ -685,7 +685,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -2291,7 +2291,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -2576,7 +2576,7 @@ paths: - `health`=(`starting`|`healthy`|`unhealthy`|`none`) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -2707,11 +2707,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -2870,7 +2870,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -2890,26 +2890,26 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 406: + "406": description: "impossible to attach" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -2922,7 +2922,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3165,14 +3165,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3194,7 +3194,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3241,14 +3241,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3273,23 +3273,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3346,7 +3346,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -3371,14 +3371,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3397,16 +3397,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3428,7 +3428,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3522,14 +3522,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3553,18 +3553,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -3590,24 +3590,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3621,26 +3621,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3654,22 +3656,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3683,6 +3687,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -3690,16 +3696,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3714,6 +3720,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -3723,7 +3731,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -3732,14 +3740,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3780,20 +3788,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3808,6 +3816,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -3818,16 +3828,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3837,6 +3847,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -3844,16 +3856,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3863,6 +3875,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -3948,22 +3962,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4013,22 +4027,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4060,7 +4074,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -4070,14 +4084,14 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4093,20 +4107,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4126,6 +4140,8 @@ paths: description: "If the container is running, kill it before removing it." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -4133,24 +4149,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveHead" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4173,20 +4189,20 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4213,27 +4229,27 @@ paths: - "application/x-tar" - "application/octet-stream" responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4274,7 +4290,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4288,7 +4304,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4301,7 +4317,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -4336,7 +4352,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4477,9 +4493,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -4510,9 +4526,9 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4528,13 +4544,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4574,7 +4590,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -4654,14 +4670,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4680,7 +4696,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4710,11 +4726,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4738,13 +4754,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4786,21 +4802,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4830,7 +4846,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4841,15 +4857,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4878,7 +4894,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4912,7 +4928,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4954,7 +4970,7 @@ paths: (or `0`), all unused images are pruned. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4968,7 +4984,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4981,7 +4997,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -4999,9 +5015,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5019,7 +5035,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5218,7 +5234,7 @@ paths: - "State" - "Healthy" SystemTime: "2015-03-10T11:11:23.730591467-07:00" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5231,7 +5247,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5268,7 +5284,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5281,12 +5297,12 @@ paths: produces: - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" example: "OK" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5300,18 +5316,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5373,7 +5389,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5413,7 +5429,7 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5446,7 +5462,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5525,7 +5541,7 @@ paths: UsageData: Size: 0 RefCount: 0 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5561,12 +5577,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5590,20 +5606,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -5620,9 +5637,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5649,22 +5666,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5735,13 +5752,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -5772,17 +5789,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5811,7 +5828,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5855,11 +5872,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5877,7 +5894,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -5911,7 +5928,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5940,11 +5957,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5989,15 +6006,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6014,17 +6031,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6039,6 +6056,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -6055,7 +6074,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6069,7 +6088,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6081,7 +6100,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6138,7 +6157,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6163,11 +6182,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" @@ -6183,13 +6202,13 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6199,6 +6218,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -6210,7 +6231,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -6223,19 +6244,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6312,17 +6333,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6358,17 +6379,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6408,7 +6429,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6418,7 +6439,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6430,7 +6451,7 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6476,7 +6497,7 @@ paths: Description: "command line arguments" Settable: null Value: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6487,7 +6508,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6516,7 +6537,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6538,9 +6559,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6600,15 +6621,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6624,15 +6645,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6653,9 +6674,9 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6676,9 +6697,9 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6696,9 +6717,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6714,6 +6735,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -6728,13 +6751,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6759,29 +6782,31 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6804,15 +6829,15 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6827,13 +6852,13 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6854,13 +6879,13 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6886,7 +6911,7 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: allOf: @@ -6928,7 +6953,7 @@ paths: UpdatedAt: "2016-08-15T16:32:09.623207604Z" Version: Index: 51 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6941,21 +6966,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 406: + "406": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6994,17 +7019,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7054,13 +7079,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7076,17 +7101,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7125,7 +7150,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7135,7 +7160,7 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7161,9 +7186,9 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7173,13 +7198,13 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7203,7 +7228,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7217,19 +7242,19 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "server error or node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7300,15 +7325,15 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7323,13 +7348,13 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7347,15 +7372,15 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ImageDeleteResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7406,8 +7431,8 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "X-Registry-Auth" in: "header" @@ -7427,23 +7452,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7499,7 +7524,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7617,7 +7642,7 @@ paths: Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7642,15 +7667,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7668,7 +7693,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7682,7 +7707,7 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7704,7 +7729,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7714,15 +7739,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 406: + "406": description: "server error or node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7746,7 +7771,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -7758,15 +7783,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 406: + "406": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7783,13 +7808,13 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.26.yaml b/_vendor/github.com/moby/moby/api/docs/v1.26.yaml index 0861a08d4f..0bd9c7ec75 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.26.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.26.yaml @@ -685,7 +685,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -2295,7 +2295,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -2580,7 +2580,7 @@ paths: - `health`=(`starting`|`healthy`|`unhealthy`|`none`) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -2711,11 +2711,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -2874,7 +2874,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -2894,26 +2894,26 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 406: + "406": description: "impossible to attach" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -2926,7 +2926,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3170,14 +3170,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3199,7 +3199,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3246,14 +3246,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3278,23 +3278,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3351,7 +3351,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -3376,14 +3376,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3402,16 +3402,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3433,7 +3433,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3527,14 +3527,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3558,18 +3558,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -3595,24 +3595,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3626,26 +3626,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3659,22 +3661,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3688,6 +3692,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -3695,16 +3701,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3719,6 +3725,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -3728,7 +3736,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -3737,14 +3745,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3786,20 +3794,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3814,6 +3822,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -3824,16 +3834,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3843,6 +3853,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -3850,16 +3862,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3869,6 +3881,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -3954,22 +3968,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4019,22 +4033,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4066,7 +4080,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -4076,14 +4090,14 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4099,20 +4113,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4132,6 +4146,8 @@ paths: description: "If the container is running, kill it before removing it." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -4139,24 +4155,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveHead" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4179,20 +4195,20 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4219,27 +4235,27 @@ paths: - "application/x-tar" - "application/octet-stream" responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4280,7 +4296,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4294,7 +4310,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4307,7 +4323,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -4342,7 +4358,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4483,9 +4499,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -4516,13 +4532,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4538,13 +4554,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4584,7 +4600,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -4664,14 +4680,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4690,7 +4706,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4720,11 +4736,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4748,13 +4764,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4796,21 +4812,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4840,7 +4856,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4851,15 +4867,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4888,7 +4904,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4922,7 +4938,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4964,7 +4980,7 @@ paths: (or `0`), all unused images are pruned. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4978,7 +4994,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4991,7 +5007,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -5009,9 +5025,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5029,7 +5045,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5229,7 +5245,7 @@ paths: - "State" - "Healthy" SystemTime: "2015-03-10T11:11:23.730591467-07:00" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5242,7 +5258,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5279,7 +5295,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5292,12 +5308,12 @@ paths: produces: - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" example: "OK" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5311,18 +5327,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5384,7 +5400,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5424,7 +5440,7 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5457,7 +5473,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5536,7 +5552,7 @@ paths: UsageData: Size: 0 RefCount: 0 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5572,12 +5588,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5601,20 +5617,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -5631,9 +5648,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5660,22 +5677,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5746,13 +5763,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -5783,17 +5800,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5822,7 +5839,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5866,11 +5883,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5888,7 +5905,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -5922,7 +5939,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5951,11 +5968,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6000,15 +6017,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6025,17 +6042,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6050,6 +6067,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -6066,7 +6085,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6080,7 +6099,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6092,7 +6111,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6149,7 +6168,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6174,11 +6193,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" @@ -6194,13 +6213,13 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6210,6 +6229,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -6221,7 +6242,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -6234,19 +6255,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6323,17 +6344,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6369,17 +6390,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6419,7 +6440,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6429,7 +6450,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6441,7 +6462,7 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6487,7 +6508,7 @@ paths: Description: "command line arguments" Settable: null Value: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6498,7 +6519,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6527,7 +6548,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6549,9 +6570,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6611,15 +6632,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6635,15 +6656,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6664,9 +6685,9 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6687,9 +6708,9 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6705,13 +6726,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6762,6 +6783,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -6770,9 +6793,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6788,6 +6811,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -6802,13 +6827,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6833,29 +6858,31 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6878,15 +6905,15 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6901,13 +6928,13 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6928,13 +6955,13 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6960,7 +6987,7 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: allOf: @@ -7002,7 +7029,7 @@ paths: UpdatedAt: "2016-08-15T16:32:09.623207604Z" Version: Index: 51 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7015,21 +7042,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 406: + "406": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7068,17 +7095,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7128,13 +7155,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7150,17 +7177,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7199,7 +7226,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7209,7 +7236,7 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7235,9 +7262,9 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7247,13 +7274,13 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7277,7 +7304,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7291,19 +7318,19 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "server error or node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7374,15 +7401,15 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7397,13 +7424,13 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7421,15 +7448,15 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ImageDeleteResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7480,8 +7507,8 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "X-Registry-Auth" in: "header" @@ -7501,23 +7528,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7573,7 +7600,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7691,7 +7718,7 @@ paths: Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7716,15 +7743,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7742,7 +7769,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7756,7 +7783,7 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7778,7 +7805,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7788,15 +7815,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 406: + "406": description: "server error or node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7820,7 +7847,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -7832,15 +7859,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 406: + "406": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7857,13 +7884,13 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7879,13 +7906,13 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.27.yaml b/_vendor/github.com/moby/moby/api/docs/v1.27.yaml index 7c2321c63e..dbb7461383 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.27.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.27.yaml @@ -720,7 +720,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -2371,7 +2371,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -2647,7 +2647,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -2778,11 +2778,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -2941,7 +2941,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -2961,26 +2961,26 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 406: + "406": description: "impossible to attach" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -2993,7 +2993,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3236,14 +3236,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3265,7 +3265,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3312,14 +3312,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3344,23 +3344,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3417,7 +3417,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -3442,14 +3442,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3468,16 +3468,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3505,7 +3505,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3601,14 +3601,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3632,18 +3632,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -3669,24 +3669,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3700,26 +3700,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3733,22 +3735,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3762,6 +3766,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -3769,16 +3775,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3793,6 +3799,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -3802,7 +3810,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -3811,14 +3819,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3860,20 +3868,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3888,6 +3896,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -3898,16 +3908,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3917,6 +3927,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -3924,16 +3936,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3943,6 +3955,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -4028,22 +4042,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4093,22 +4107,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4140,7 +4154,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -4150,14 +4164,14 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4173,27 +4187,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or use -f" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4218,6 +4232,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -4225,24 +4241,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveHead" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4265,20 +4281,20 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4305,27 +4321,27 @@ paths: - "application/x-tar" - "application/octet-stream" responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4358,7 +4374,7 @@ paths: - "application/json" operationId: "ContainerPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4372,7 +4388,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4385,7 +4401,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -4420,7 +4436,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4560,9 +4576,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -4593,13 +4609,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4615,13 +4631,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4661,7 +4677,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -4741,14 +4757,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4767,7 +4783,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4797,11 +4813,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4825,13 +4841,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4873,21 +4889,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4917,7 +4933,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4928,15 +4944,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4965,7 +4981,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -4999,7 +5015,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5040,7 +5056,7 @@ paths: (or `0`), all unused images are pruned. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5054,7 +5070,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5067,7 +5083,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -5085,9 +5101,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5105,7 +5121,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5305,7 +5321,7 @@ paths: - "State" - "Healthy" SystemTime: "2015-03-10T11:11:23.730591467-07:00" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5318,7 +5334,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5355,7 +5371,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5368,12 +5384,12 @@ paths: produces: - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" example: "OK" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5387,18 +5403,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5460,7 +5476,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5500,11 +5516,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5538,7 +5554,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5617,7 +5633,7 @@ paths: UsageData: Size: 0 RefCount: 0 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5653,12 +5669,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5682,20 +5698,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -5712,9 +5729,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5741,22 +5758,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5827,13 +5844,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -5864,17 +5881,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5903,7 +5920,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5947,11 +5964,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5969,7 +5986,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -6003,7 +6020,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6033,11 +6050,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6082,15 +6099,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6107,17 +6124,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6132,6 +6149,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -6140,7 +6159,7 @@ paths: - "application/json" operationId: "VolumePrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6154,7 +6173,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6166,7 +6185,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6226,7 +6245,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6251,11 +6270,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" @@ -6271,13 +6290,13 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6287,6 +6306,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -6298,7 +6319,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -6311,19 +6332,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6404,17 +6425,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6450,17 +6471,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6492,7 +6513,7 @@ paths: - "application/json" operationId: "NetworkPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6502,7 +6523,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6514,7 +6535,7 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6560,7 +6581,7 @@ paths: Description: "command line arguments" Settable: null Value: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6571,7 +6592,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6600,7 +6621,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6622,9 +6643,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6684,15 +6705,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6708,15 +6729,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6737,13 +6758,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6764,13 +6785,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6786,13 +6807,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6843,6 +6864,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -6851,9 +6874,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6869,6 +6892,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -6883,13 +6908,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6914,33 +6939,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -6963,19 +6990,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -6990,17 +7017,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7021,17 +7048,17 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7057,7 +7084,7 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: allOf: @@ -7099,15 +7126,15 @@ paths: UpdatedAt: "2016-08-15T16:32:09.623207604Z" Version: Index: 51 - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7120,21 +7147,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7173,17 +7200,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7233,13 +7260,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7255,17 +7282,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7304,7 +7331,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7314,11 +7341,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7344,13 +7371,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7360,17 +7387,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7394,7 +7421,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7408,23 +7435,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7495,19 +7522,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7522,17 +7549,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7550,23 +7577,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ImageDeleteResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7617,8 +7644,8 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "X-Registry-Auth" in: "header" @@ -7638,27 +7665,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7714,7 +7741,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7831,11 +7858,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7860,19 +7887,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7890,7 +7917,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7904,11 +7931,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7930,7 +7957,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7940,15 +7967,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7972,7 +7999,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -7984,15 +8011,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8009,17 +8036,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8035,17 +8062,17 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.28.yaml b/_vendor/github.com/moby/moby/api/docs/v1.28.yaml index 5efb26afbc..fd68b8545a 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.28.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.28.yaml @@ -726,7 +726,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -2451,7 +2451,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -2736,7 +2736,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -2867,11 +2867,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3030,7 +3030,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -3050,26 +3050,26 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 406: + "406": description: "impossible to attach" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3082,7 +3082,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3325,14 +3325,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3354,7 +3354,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3401,14 +3401,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3433,23 +3433,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3506,7 +3506,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -3533,14 +3533,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3559,16 +3559,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3596,7 +3596,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3692,14 +3692,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3723,18 +3723,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -3760,24 +3760,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3791,26 +3791,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3824,22 +3826,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3853,6 +3857,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -3860,16 +3866,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3884,6 +3890,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -3893,7 +3901,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -3902,14 +3910,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3950,20 +3958,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3978,6 +3986,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -3988,16 +3998,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4007,6 +4017,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -4014,16 +4026,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4033,6 +4045,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -4118,22 +4132,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4183,22 +4197,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4230,7 +4244,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -4240,14 +4254,14 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4263,27 +4277,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4308,6 +4322,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -4315,24 +4331,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4352,22 +4368,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4392,27 +4409,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4454,7 +4471,7 @@ paths: - `until=` Prune containers created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4468,7 +4485,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4481,7 +4498,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -4516,7 +4533,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4660,9 +4677,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -4693,13 +4710,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4715,13 +4732,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4761,7 +4778,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -4842,14 +4859,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4867,7 +4884,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -4897,11 +4914,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4925,13 +4942,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4973,21 +4990,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5018,7 +5035,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -5029,15 +5046,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5066,7 +5083,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -5100,7 +5117,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5142,7 +5159,7 @@ paths: - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5156,7 +5173,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5169,7 +5186,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -5187,9 +5204,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5207,7 +5224,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5406,7 +5423,7 @@ paths: - "State" - "Healthy" SystemTime: "2015-03-10T11:11:23.730591467-07:00" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5418,7 +5435,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5455,7 +5472,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5465,9 +5482,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -5479,7 +5497,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5493,18 +5511,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5566,7 +5584,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5606,11 +5624,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5644,7 +5662,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5723,7 +5741,7 @@ paths: UsageData: Size: 0 RefCount: 0 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5759,12 +5777,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5788,20 +5806,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -5818,9 +5837,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5847,22 +5866,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5933,13 +5952,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -5970,17 +5989,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6009,7 +6028,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6053,11 +6072,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6075,7 +6094,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -6109,7 +6128,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6139,11 +6158,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6188,15 +6207,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6213,17 +6232,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6238,6 +6257,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -6254,7 +6275,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6268,7 +6289,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6280,7 +6301,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6340,7 +6361,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6365,11 +6386,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" @@ -6390,13 +6411,13 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6406,6 +6427,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -6417,7 +6440,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -6430,19 +6453,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6523,17 +6546,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6569,17 +6592,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6618,7 +6641,7 @@ paths: - `until=` Prune networks created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6628,7 +6651,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6640,7 +6663,7 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6686,7 +6709,7 @@ paths: Description: "command line arguments" Settable: null Value: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6706,7 +6729,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6735,7 +6758,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6757,9 +6780,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6819,15 +6842,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6843,15 +6866,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6872,13 +6895,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6899,13 +6922,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6927,13 +6950,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6984,6 +7007,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -6992,9 +7017,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7010,6 +7035,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -7024,13 +7051,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7055,33 +7082,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7104,19 +7133,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7131,17 +7160,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7162,17 +7191,17 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7198,7 +7227,7 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: allOf: @@ -7240,15 +7269,15 @@ paths: UpdatedAt: "2016-08-15T16:32:09.623207604Z" Version: Index: 51 - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7261,21 +7290,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7314,17 +7343,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7374,13 +7403,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7396,17 +7425,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7445,7 +7474,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7455,11 +7484,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7485,13 +7514,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7501,17 +7530,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7535,7 +7564,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7549,23 +7578,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7644,19 +7673,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7671,17 +7700,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7699,23 +7728,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7774,15 +7803,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -7801,27 +7830,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7877,7 +7906,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7994,11 +8023,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8023,19 +8052,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8053,7 +8082,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8067,11 +8096,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8093,7 +8122,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8103,15 +8132,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8135,7 +8164,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -8147,15 +8176,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8172,17 +8201,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8198,17 +8227,17 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.29.yaml b/_vendor/github.com/moby/moby/api/docs/v1.29.yaml index 8eab227d6a..5a8888a80a 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.29.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.29.yaml @@ -732,7 +732,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -2484,7 +2484,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -2769,7 +2769,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -2900,11 +2900,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3063,7 +3063,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -3083,26 +3083,26 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 406: + "406": description: "impossible to attach" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3115,7 +3115,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3358,14 +3358,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3387,7 +3387,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3434,14 +3434,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3466,23 +3466,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3539,7 +3539,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -3566,14 +3566,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3592,16 +3592,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3629,7 +3629,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3725,14 +3725,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3756,18 +3756,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -3793,24 +3793,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3824,26 +3824,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3857,22 +3859,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3886,6 +3890,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -3893,16 +3899,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3917,6 +3923,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -3926,7 +3934,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -3935,14 +3943,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3983,20 +3991,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4011,6 +4019,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -4021,16 +4031,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4040,6 +4050,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -4047,16 +4059,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4066,6 +4078,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -4151,22 +4165,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4216,22 +4230,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4263,7 +4277,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -4273,14 +4287,14 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4296,27 +4310,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4341,6 +4355,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -4348,24 +4364,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4385,22 +4401,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4425,27 +4442,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4487,7 +4504,7 @@ paths: - `until=` Prune containers created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4501,7 +4518,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4514,7 +4531,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -4549,7 +4566,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4693,9 +4710,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -4726,13 +4743,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4748,13 +4765,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4794,7 +4811,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -4875,14 +4892,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4900,7 +4917,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -4930,11 +4947,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4958,13 +4975,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5006,21 +5023,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5051,7 +5068,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -5062,15 +5079,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5099,7 +5116,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -5133,7 +5150,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5175,7 +5192,7 @@ paths: - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5189,7 +5206,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5202,7 +5219,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -5220,9 +5237,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5240,7 +5257,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5439,7 +5456,7 @@ paths: - "State" - "Healthy" SystemTime: "2015-03-10T11:11:23.730591467-07:00" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5451,7 +5468,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5488,7 +5505,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5498,9 +5515,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -5512,7 +5530,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5526,18 +5544,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5599,7 +5617,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5639,11 +5657,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5677,7 +5695,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5756,7 +5774,7 @@ paths: UsageData: Size: 0 RefCount: 0 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5792,12 +5810,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5821,20 +5839,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -5851,9 +5870,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5880,22 +5899,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5966,13 +5985,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -6003,17 +6022,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6042,7 +6061,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6086,11 +6105,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6108,7 +6127,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -6142,7 +6161,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6172,11 +6191,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6221,15 +6240,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6246,17 +6265,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6271,6 +6290,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -6287,7 +6308,7 @@ paths: Available filters: type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6301,7 +6322,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6313,7 +6334,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6376,7 +6397,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6402,11 +6423,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" @@ -6427,13 +6448,13 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6443,6 +6464,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -6454,7 +6477,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -6467,19 +6490,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6564,17 +6587,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6610,17 +6633,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6659,7 +6682,7 @@ paths: - `until=` Prune networks created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6669,7 +6692,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6681,7 +6704,7 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6727,7 +6750,7 @@ paths: Description: "command line arguments" Settable: null Value: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6747,7 +6770,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6776,7 +6799,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6798,9 +6821,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6860,15 +6883,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6884,15 +6907,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6913,13 +6936,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6940,13 +6963,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6968,13 +6991,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7025,6 +7048,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -7033,9 +7058,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7051,6 +7076,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -7065,13 +7092,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7096,33 +7123,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7145,19 +7174,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7172,17 +7201,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7203,17 +7232,17 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7239,7 +7268,7 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: allOf: @@ -7281,15 +7310,15 @@ paths: UpdatedAt: "2016-08-15T16:32:09.623207604Z" Version: Index: 51 - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7302,21 +7331,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7355,17 +7384,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7415,13 +7444,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7437,17 +7466,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7486,7 +7515,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7496,11 +7525,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7526,13 +7555,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7542,17 +7571,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7577,7 +7606,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7591,23 +7620,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7687,19 +7716,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7719,17 +7748,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7747,23 +7776,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7822,15 +7851,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -7849,27 +7878,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7925,7 +7954,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8042,11 +8071,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8071,19 +8100,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8106,27 +8135,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8181,7 +8210,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8195,11 +8224,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8224,7 +8253,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8234,15 +8263,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8266,7 +8295,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -8278,15 +8307,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8303,17 +8332,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8329,17 +8358,17 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.30.yaml b/_vendor/github.com/moby/moby/api/docs/v1.30.yaml index 31b2f598ca..16b01b6aa2 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.30.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.30.yaml @@ -733,7 +733,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -2664,7 +2664,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -2981,7 +2981,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -3112,11 +3112,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3275,7 +3275,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -3295,26 +3295,26 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 406: + "406": description: "impossible to attach" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3327,7 +3327,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3583,14 +3583,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3612,7 +3612,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3659,14 +3659,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3691,23 +3691,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3764,7 +3764,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -3791,14 +3791,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3817,16 +3817,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3854,7 +3854,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3950,14 +3950,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3981,18 +3981,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -4018,24 +4018,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4049,26 +4049,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4082,22 +4084,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4111,6 +4115,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -4118,16 +4124,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4142,6 +4148,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -4151,7 +4159,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -4160,14 +4168,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4209,20 +4217,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4237,6 +4245,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -4247,16 +4257,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4266,6 +4276,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -4273,16 +4285,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4292,6 +4304,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -4377,22 +4391,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4442,22 +4456,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4489,7 +4503,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -4499,18 +4513,18 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4538,27 +4552,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4583,6 +4597,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -4590,24 +4606,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4627,22 +4643,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4667,27 +4684,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4730,7 +4747,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4744,7 +4761,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4757,7 +4774,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -4792,7 +4809,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4936,9 +4953,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -4969,13 +4986,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4991,13 +5008,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5037,7 +5054,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -5118,14 +5135,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5143,7 +5160,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -5173,11 +5190,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5201,13 +5218,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5249,21 +5266,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5294,7 +5311,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -5305,15 +5322,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5342,7 +5359,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -5376,7 +5393,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5419,7 +5436,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5433,7 +5450,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5446,7 +5463,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -5464,9 +5481,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5484,7 +5501,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5688,7 +5705,7 @@ paths: - "State" - "Healthy" SystemTime: "2015-03-10T11:11:23.730591467-07:00" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5700,7 +5717,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5737,7 +5754,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5747,9 +5764,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -5761,7 +5779,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5775,18 +5793,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5854,7 +5872,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5894,11 +5912,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5933,7 +5951,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6012,7 +6030,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6048,12 +6066,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6077,20 +6095,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -6107,9 +6126,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6136,22 +6155,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6222,13 +6241,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -6259,17 +6278,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6298,7 +6317,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6342,11 +6361,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6364,7 +6383,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -6398,7 +6417,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6428,11 +6447,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6477,15 +6496,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6502,17 +6521,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6527,6 +6546,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -6544,7 +6565,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6558,7 +6579,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6575,7 +6596,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6632,7 +6653,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6658,15 +6679,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6687,17 +6708,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6707,6 +6728,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -6718,7 +6741,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -6731,19 +6754,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6828,17 +6851,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6874,17 +6897,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6924,7 +6947,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6934,7 +6957,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6946,13 +6969,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6972,7 +6995,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7001,7 +7024,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7023,9 +7046,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7085,15 +7108,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7109,15 +7132,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7138,13 +7161,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7165,13 +7188,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7193,13 +7216,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7250,6 +7273,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -7258,9 +7283,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7276,6 +7301,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -7290,13 +7317,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7321,33 +7348,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7370,19 +7399,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7397,17 +7426,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7428,21 +7457,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7468,7 +7497,7 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: allOf: @@ -7525,15 +7554,15 @@ paths: -----END CERTIFICATE----- CertIssuerSubject: "MBMxETAPBgNVBAMTCHN3YXJtLWNh" CertIssuerPublicKey: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7546,21 +7575,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7609,17 +7638,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7681,13 +7710,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7703,17 +7732,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7752,7 +7781,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7762,11 +7791,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7792,13 +7821,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7808,17 +7837,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7843,7 +7872,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7857,23 +7886,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7962,19 +7991,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7994,17 +8023,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8022,23 +8051,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8097,15 +8126,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -8124,27 +8153,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8200,7 +8229,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8317,11 +8346,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8346,19 +8375,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8381,27 +8410,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8456,7 +8485,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8470,11 +8499,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8499,7 +8528,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8509,15 +8538,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8541,7 +8570,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -8554,15 +8583,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8579,17 +8608,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8605,21 +8634,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8648,7 +8677,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8662,11 +8691,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8690,7 +8719,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8700,15 +8729,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8732,7 +8761,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -8745,15 +8774,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8770,17 +8799,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8796,21 +8825,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8840,7 +8869,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -8901,14 +8930,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.31.yaml b/_vendor/github.com/moby/moby/api/docs/v1.31.yaml index d38fe037a4..f458ef9cf7 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.31.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.31.yaml @@ -733,7 +733,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -2693,7 +2693,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -3054,7 +3054,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -3185,11 +3185,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3348,7 +3348,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -3368,26 +3368,26 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 406: + "406": description: "impossible to attach" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3400,7 +3400,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3656,14 +3656,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3685,7 +3685,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -3732,14 +3732,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3764,23 +3764,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3837,7 +3837,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -3864,14 +3864,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3890,16 +3890,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -3927,7 +3927,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4023,14 +4023,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4054,18 +4054,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -4091,24 +4091,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4122,26 +4122,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4155,22 +4157,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4184,6 +4188,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -4191,16 +4197,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4215,6 +4221,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -4224,7 +4232,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -4233,14 +4241,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4282,20 +4290,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4310,6 +4318,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -4320,16 +4330,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4339,6 +4349,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -4346,16 +4358,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4365,6 +4377,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -4450,22 +4464,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4515,22 +4529,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4562,7 +4576,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -4572,18 +4586,18 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4611,27 +4625,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4656,6 +4670,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -4663,24 +4679,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4700,22 +4716,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4740,27 +4757,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4803,7 +4820,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -4817,7 +4834,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4830,7 +4847,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -4865,7 +4882,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5009,9 +5026,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -5042,13 +5059,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5060,7 +5077,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5069,7 +5086,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5085,13 +5102,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5131,7 +5148,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -5212,14 +5229,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5237,7 +5254,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -5267,11 +5284,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5295,13 +5312,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5343,21 +5360,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5388,7 +5405,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -5399,15 +5416,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5436,7 +5453,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -5470,7 +5487,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5513,7 +5530,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5527,7 +5544,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5540,7 +5557,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -5558,9 +5575,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5578,7 +5595,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -5782,7 +5799,7 @@ paths: - "State" - "Healthy" SystemTime: "2015-03-10T11:11:23.730591467-07:00" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5794,7 +5811,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5831,7 +5848,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5841,9 +5858,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -5855,7 +5873,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5869,18 +5887,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5950,7 +5968,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5990,11 +6008,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6029,7 +6047,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6108,7 +6126,7 @@ paths: UsageData: Size: 0 RefCount: 0 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6144,12 +6162,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6173,20 +6191,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -6203,9 +6222,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6232,22 +6251,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6318,13 +6337,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -6355,17 +6374,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6394,7 +6413,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6438,11 +6457,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6460,7 +6479,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -6495,7 +6514,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6525,11 +6544,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6574,15 +6593,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6599,17 +6618,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6624,6 +6643,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -6641,7 +6662,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6655,7 +6676,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6672,7 +6693,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6729,7 +6750,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6755,15 +6776,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6788,17 +6809,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6808,6 +6829,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -6819,7 +6842,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -6832,19 +6855,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6929,17 +6952,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6975,17 +6998,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7025,7 +7048,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7035,7 +7058,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7047,13 +7070,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7073,7 +7096,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7102,7 +7125,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7124,9 +7147,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7186,15 +7209,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7210,15 +7233,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7239,13 +7262,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7266,13 +7289,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7294,13 +7317,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7351,6 +7374,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -7359,9 +7384,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7377,6 +7402,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -7391,13 +7418,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7422,33 +7449,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7471,19 +7500,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7498,17 +7527,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7529,21 +7558,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7569,7 +7598,7 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: allOf: @@ -7626,15 +7655,15 @@ paths: -----END CERTIFICATE----- CertIssuerSubject: "MBMxETAPBgNVBAMTCHN3YXJtLWNh" CertIssuerPublicKey: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7647,21 +7676,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7710,17 +7739,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7782,13 +7811,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7804,17 +7833,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7853,7 +7882,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7863,11 +7892,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7893,13 +7922,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7909,17 +7938,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -7944,7 +7973,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -7958,23 +7987,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8063,19 +8092,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8095,17 +8124,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8123,23 +8152,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8198,15 +8227,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -8225,27 +8254,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8301,7 +8330,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8418,11 +8447,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8447,19 +8476,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8482,27 +8511,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8557,7 +8586,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8587,11 +8616,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8616,7 +8645,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8626,15 +8655,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8663,7 +8692,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -8684,15 +8713,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8709,17 +8738,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8735,21 +8764,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8778,7 +8807,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8792,11 +8821,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8820,7 +8849,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8830,15 +8859,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8862,7 +8891,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -8875,15 +8904,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8900,17 +8929,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8926,21 +8955,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8970,7 +8999,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -9031,14 +9060,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9081,13 +9110,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.32.yaml b/_vendor/github.com/moby/moby/api/docs/v1.32.yaml index fbad3ad5cd..833beeb598 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.32.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.32.yaml @@ -799,7 +799,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -3164,7 +3164,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -4170,7 +4170,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -4268,7 +4267,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -4399,11 +4398,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4562,7 +4561,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -4582,22 +4581,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4610,7 +4609,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4863,14 +4862,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4892,7 +4891,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4939,14 +4938,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4971,23 +4970,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5044,7 +5043,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -5071,14 +5070,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5097,16 +5096,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5134,7 +5133,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5230,14 +5229,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5261,18 +5260,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -5298,24 +5297,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5329,26 +5328,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5362,22 +5363,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5391,6 +5394,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -5398,16 +5403,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5422,6 +5427,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -5431,7 +5438,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -5440,14 +5447,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5488,20 +5495,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5516,6 +5523,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -5526,16 +5535,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5545,6 +5554,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -5552,16 +5563,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5571,6 +5582,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -5656,22 +5669,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5721,22 +5734,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5768,7 +5781,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -5778,18 +5791,18 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5817,27 +5830,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5862,6 +5875,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -5869,24 +5884,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5906,22 +5921,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5946,27 +5962,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6009,7 +6025,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6023,7 +6039,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6036,7 +6052,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -6071,7 +6087,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6215,9 +6231,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -6248,13 +6264,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6266,7 +6282,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6275,7 +6291,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6291,13 +6307,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6342,7 +6358,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -6423,14 +6439,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6448,7 +6464,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -6478,11 +6494,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6506,13 +6522,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6554,21 +6570,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6599,7 +6615,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -6610,15 +6626,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6647,7 +6663,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6681,7 +6697,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6724,7 +6740,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6738,7 +6754,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6751,7 +6767,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -6769,9 +6785,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6789,11 +6805,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6805,7 +6821,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6842,7 +6858,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6852,9 +6868,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -6866,7 +6883,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6880,18 +6897,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6961,7 +6978,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7001,11 +7018,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7040,7 +7057,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7119,7 +7136,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7155,12 +7172,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7184,20 +7201,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -7214,9 +7232,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7243,22 +7261,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7329,13 +7347,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -7366,17 +7384,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7405,7 +7423,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7449,11 +7467,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7471,7 +7489,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -7506,7 +7524,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7536,11 +7554,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7585,15 +7603,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7610,17 +7628,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7635,6 +7653,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -7652,7 +7672,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7666,7 +7686,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7683,7 +7703,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -7740,7 +7760,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7766,15 +7786,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7799,17 +7819,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7819,6 +7839,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -7830,7 +7852,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -7843,19 +7865,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7940,17 +7962,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7986,17 +8008,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8036,7 +8058,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8046,7 +8068,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8058,13 +8080,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8084,7 +8106,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8113,7 +8135,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8135,9 +8157,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8197,15 +8219,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8221,15 +8243,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8250,13 +8272,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8277,13 +8299,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8305,13 +8327,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8362,6 +8384,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -8370,9 +8394,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8388,6 +8412,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -8402,13 +8428,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8433,33 +8459,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8482,19 +8510,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8509,17 +8537,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8540,21 +8568,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8580,19 +8608,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8605,21 +8633,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8668,17 +8696,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8740,13 +8768,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8762,17 +8790,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8811,7 +8839,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8821,11 +8849,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8851,13 +8879,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8867,17 +8895,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8902,7 +8930,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8916,23 +8944,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9021,19 +9049,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9053,17 +9081,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9081,23 +9109,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9156,15 +9184,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -9183,27 +9211,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9259,7 +9287,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9376,11 +9404,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9405,19 +9433,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9440,27 +9468,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9515,7 +9543,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9545,11 +9573,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9574,7 +9602,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9584,15 +9612,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9621,7 +9649,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -9642,15 +9670,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9667,17 +9695,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9693,21 +9721,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9736,7 +9764,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9750,11 +9778,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9778,7 +9806,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9788,15 +9816,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9820,7 +9848,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -9833,15 +9861,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9858,17 +9886,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9884,21 +9912,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9928,7 +9956,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -9989,14 +10017,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10039,13 +10067,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.33.yaml b/_vendor/github.com/moby/moby/api/docs/v1.33.yaml index 3f738469d0..480e5a52bc 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.33.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.33.yaml @@ -803,7 +803,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -3168,7 +3168,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -4174,7 +4174,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -4272,7 +4271,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -4403,11 +4402,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4566,7 +4565,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -4586,22 +4585,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4614,7 +4613,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4867,14 +4866,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4896,7 +4895,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4943,14 +4942,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4975,23 +4974,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5048,7 +5047,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -5075,14 +5074,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5101,16 +5100,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5138,7 +5137,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5234,14 +5233,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5265,18 +5264,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -5302,24 +5301,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5333,26 +5332,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5366,22 +5367,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5395,6 +5398,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -5402,16 +5407,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5426,6 +5431,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -5435,7 +5442,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -5444,14 +5451,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5492,20 +5499,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5520,6 +5527,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -5530,16 +5539,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5549,6 +5558,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -5556,16 +5567,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5575,6 +5586,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -5660,22 +5673,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5725,22 +5738,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5772,7 +5785,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -5782,18 +5795,18 @@ paths: description: "Exit code of the container" type: "integer" x-nullable: false - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5821,27 +5834,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5866,6 +5879,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -5873,24 +5888,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5910,22 +5925,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5950,27 +5966,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6013,7 +6029,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6027,7 +6043,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6040,7 +6056,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -6075,7 +6091,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6219,9 +6235,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -6252,13 +6268,13 @@ paths: Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. type: "string" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6270,7 +6286,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6279,7 +6295,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6295,13 +6311,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6346,7 +6362,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -6427,14 +6443,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6452,7 +6468,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -6482,11 +6498,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6510,13 +6526,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6558,21 +6574,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6603,7 +6619,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -6614,15 +6630,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6651,7 +6667,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6685,7 +6701,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6728,7 +6744,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6742,7 +6758,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6755,7 +6771,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -6773,9 +6789,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6793,11 +6809,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6809,7 +6825,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6846,7 +6862,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6856,9 +6872,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -6870,7 +6887,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6884,18 +6901,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6965,7 +6982,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7005,11 +7022,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7048,7 +7065,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7127,7 +7144,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7163,12 +7180,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7192,20 +7209,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -7222,9 +7240,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7251,22 +7269,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7337,13 +7355,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -7374,17 +7392,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7413,7 +7431,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7457,11 +7475,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7479,7 +7497,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -7514,7 +7532,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7544,11 +7562,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7593,15 +7611,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7618,17 +7636,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7643,6 +7661,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -7660,7 +7680,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7674,7 +7694,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7691,7 +7711,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -7748,7 +7768,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7774,15 +7794,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7807,17 +7827,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7827,6 +7847,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -7838,7 +7860,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -7851,19 +7873,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7948,17 +7970,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7994,17 +8016,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8044,7 +8066,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8054,7 +8076,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8066,13 +8088,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8092,7 +8114,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8121,7 +8143,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8143,9 +8165,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8205,15 +8227,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8229,15 +8251,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8258,13 +8280,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8285,13 +8307,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8313,13 +8335,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8370,6 +8392,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -8378,9 +8402,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8396,6 +8420,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -8410,13 +8436,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8441,33 +8467,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8490,19 +8518,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8517,17 +8545,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8548,21 +8576,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8588,19 +8616,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8613,21 +8641,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8676,17 +8704,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8748,13 +8776,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8770,17 +8798,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8819,7 +8847,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8829,11 +8857,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8859,13 +8887,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8875,17 +8903,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8910,7 +8938,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8924,23 +8952,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9029,19 +9057,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9061,17 +9089,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9089,23 +9117,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9164,15 +9192,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -9191,27 +9219,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9267,7 +9295,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9384,11 +9412,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9413,19 +9441,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9448,27 +9476,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9523,7 +9551,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9553,11 +9581,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9582,7 +9610,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9592,15 +9620,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9629,7 +9657,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -9650,15 +9678,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9675,17 +9703,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9701,21 +9729,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9744,7 +9772,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9758,11 +9786,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9786,7 +9814,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9796,15 +9824,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9828,7 +9856,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -9841,15 +9869,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9866,17 +9894,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9892,21 +9920,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9936,7 +9964,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -9997,14 +10025,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10047,13 +10075,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.34.yaml b/_vendor/github.com/moby/moby/api/docs/v1.34.yaml index d0bcbaef99..fb15fcf37c 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.34.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.34.yaml @@ -813,7 +813,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -3196,7 +3196,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -4202,7 +4202,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -4300,7 +4299,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -4431,11 +4430,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4594,7 +4593,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -4614,22 +4613,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4642,7 +4641,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4895,14 +4894,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4924,7 +4923,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4971,14 +4970,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5003,23 +5002,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5076,7 +5075,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -5103,14 +5102,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5129,16 +5128,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5166,7 +5165,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5262,14 +5261,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5293,18 +5292,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -5330,24 +5329,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5361,26 +5360,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5394,22 +5395,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5423,6 +5426,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -5430,16 +5435,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5454,6 +5459,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -5463,7 +5470,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -5472,14 +5479,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5520,20 +5527,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5548,6 +5555,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -5558,16 +5567,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5577,6 +5586,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -5584,16 +5595,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5603,6 +5614,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -5688,22 +5701,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5753,22 +5766,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5800,7 +5813,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -5817,18 +5830,18 @@ paths: Message: description: "Details of an error" type: "string" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5856,27 +5869,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5901,6 +5914,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -5908,24 +5923,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5945,22 +5960,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5985,27 +6001,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6048,7 +6064,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6062,7 +6078,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6075,7 +6091,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -6110,7 +6126,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6254,9 +6270,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -6292,13 +6308,13 @@ paths: type: "string" default: "" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6310,7 +6326,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6319,7 +6335,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6335,13 +6351,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6386,7 +6402,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -6467,14 +6483,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6492,7 +6508,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -6522,11 +6538,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6550,13 +6566,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6598,21 +6614,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6643,7 +6659,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -6654,15 +6670,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6691,7 +6707,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6725,7 +6741,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6768,7 +6784,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6782,7 +6798,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6795,7 +6811,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -6813,9 +6829,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6833,11 +6849,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6849,7 +6865,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6886,7 +6902,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6896,9 +6912,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -6910,7 +6927,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6924,18 +6941,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7005,7 +7022,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7045,11 +7062,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7088,7 +7105,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7167,7 +7184,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7203,12 +7220,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7232,20 +7249,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -7262,9 +7280,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7291,22 +7309,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7377,13 +7395,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -7414,17 +7432,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7453,7 +7471,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7497,11 +7515,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7519,7 +7537,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -7554,7 +7572,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7584,11 +7602,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7633,15 +7651,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7658,17 +7676,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7683,6 +7701,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -7700,7 +7720,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7714,7 +7734,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7731,7 +7751,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -7788,7 +7808,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7814,15 +7834,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7847,17 +7867,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7867,6 +7887,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -7878,7 +7900,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -7891,19 +7913,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7988,17 +8010,17 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8034,17 +8056,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8084,7 +8106,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8094,7 +8116,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8106,13 +8128,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8132,7 +8154,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8161,7 +8183,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8183,9 +8205,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8245,15 +8267,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8269,15 +8291,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8298,13 +8320,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8325,13 +8347,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8353,13 +8375,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8410,6 +8432,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -8418,9 +8442,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8436,6 +8460,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -8450,13 +8476,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8481,33 +8507,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8530,19 +8558,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8557,17 +8585,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8588,21 +8616,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8628,19 +8656,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8653,21 +8681,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8716,17 +8744,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8788,13 +8816,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8810,17 +8838,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8859,7 +8887,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8869,11 +8897,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8899,13 +8927,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8915,17 +8943,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8950,7 +8978,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8964,23 +8992,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9069,19 +9097,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9101,17 +9129,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9129,23 +9157,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9204,15 +9232,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -9231,27 +9259,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9307,7 +9335,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9424,11 +9452,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9453,19 +9481,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9488,27 +9516,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9563,7 +9591,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9593,11 +9621,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9622,7 +9650,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9632,15 +9660,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9669,7 +9697,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -9690,15 +9718,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9715,17 +9743,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9741,21 +9769,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9784,7 +9812,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9798,11 +9826,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9826,7 +9854,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9836,15 +9864,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9868,7 +9896,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -9881,15 +9909,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9906,17 +9934,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9932,21 +9960,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9976,7 +10004,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -10037,14 +10065,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10087,13 +10115,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.35.yaml b/_vendor/github.com/moby/moby/api/docs/v1.35.yaml index f1b8285ca5..5543fb1f71 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.35.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.35.yaml @@ -814,7 +814,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -3200,7 +3200,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -4206,7 +4206,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -4304,7 +4303,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -4435,11 +4434,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4598,7 +4597,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -4618,22 +4617,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4646,7 +4645,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4899,14 +4898,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4928,7 +4927,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4975,14 +4974,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5007,23 +5006,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5085,7 +5084,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -5112,14 +5111,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5138,16 +5137,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5175,7 +5174,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5271,14 +5270,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5302,18 +5301,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -5339,24 +5338,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5370,26 +5369,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5403,22 +5404,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5432,6 +5435,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -5439,16 +5444,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5463,6 +5468,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -5472,7 +5479,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -5481,14 +5488,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5529,20 +5536,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5557,6 +5564,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -5567,16 +5576,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5586,6 +5595,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -5593,16 +5604,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5612,6 +5623,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -5697,22 +5710,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5762,22 +5775,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5809,7 +5822,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -5826,18 +5839,18 @@ paths: Message: description: "Details of an error" type: "string" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5865,27 +5878,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5910,6 +5923,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -5917,24 +5932,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5954,22 +5969,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5994,27 +6010,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6057,7 +6073,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6071,7 +6087,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6084,7 +6100,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -6119,7 +6135,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6263,9 +6279,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -6301,13 +6317,13 @@ paths: type: "string" default: "" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6319,7 +6335,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6328,7 +6344,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6344,13 +6360,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6395,7 +6411,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -6476,14 +6492,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6501,7 +6517,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -6531,11 +6547,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6559,13 +6575,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6607,21 +6623,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6652,7 +6668,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -6663,15 +6679,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6700,7 +6716,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6734,7 +6750,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6777,7 +6793,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6791,7 +6807,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6804,7 +6820,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -6822,9 +6838,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6842,11 +6858,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6858,7 +6874,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6917,7 +6933,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6927,9 +6943,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -6941,7 +6958,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6955,18 +6972,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7036,7 +7053,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7076,11 +7093,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7119,7 +7136,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7198,7 +7215,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7234,12 +7251,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7263,20 +7280,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -7293,9 +7311,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7322,22 +7340,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7411,13 +7429,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -7448,17 +7466,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7487,7 +7505,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7531,11 +7549,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7553,7 +7571,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -7588,7 +7606,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7618,11 +7636,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7667,15 +7685,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7692,17 +7710,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7717,6 +7735,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -7734,7 +7754,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7748,7 +7768,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7765,7 +7785,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -7822,7 +7842,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7848,15 +7868,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7881,17 +7901,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7901,6 +7921,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -7912,7 +7934,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -7925,19 +7947,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8022,17 +8044,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8068,17 +8090,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8118,7 +8140,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8128,7 +8150,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8140,13 +8162,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8166,7 +8188,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8195,7 +8217,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8217,9 +8239,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8279,15 +8301,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8303,15 +8325,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8332,13 +8354,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8359,13 +8381,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8387,13 +8409,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8444,6 +8466,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -8452,9 +8476,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8470,6 +8494,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -8484,13 +8510,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8515,33 +8541,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8564,19 +8592,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8591,17 +8619,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8622,21 +8650,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8662,19 +8690,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8687,21 +8715,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8750,17 +8778,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8822,13 +8850,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8844,17 +8872,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8893,7 +8921,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8903,11 +8931,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8933,13 +8961,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8949,17 +8977,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8984,7 +9012,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -8998,23 +9026,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9103,19 +9131,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9135,17 +9163,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9163,23 +9191,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9238,15 +9266,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -9265,27 +9293,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9341,7 +9369,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9458,11 +9486,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9487,19 +9515,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9522,27 +9550,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9597,7 +9625,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9627,11 +9655,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9656,7 +9684,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9666,15 +9694,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9703,7 +9731,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -9724,15 +9752,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9749,17 +9777,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9775,21 +9803,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9818,7 +9846,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9832,11 +9860,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9860,7 +9888,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9870,15 +9898,15 @@ paths: type: "string" example: ID: "ktnbjxoalbkvbvedmg1urrz8h" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9902,7 +9930,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -9915,15 +9943,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9940,17 +9968,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9966,21 +9994,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10010,7 +10038,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -10071,14 +10099,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10121,13 +10149,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.36.yaml b/_vendor/github.com/moby/moby/api/docs/v1.36.yaml index 86b5da3940..895e8817fe 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.36.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.36.yaml @@ -818,7 +818,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -3217,7 +3217,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -4227,7 +4227,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -4325,7 +4324,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -4456,11 +4455,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4620,7 +4619,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -4642,22 +4641,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4670,7 +4669,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4925,14 +4924,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4954,7 +4953,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5003,14 +5002,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5035,23 +5034,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5113,7 +5112,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -5142,14 +5141,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5168,16 +5167,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5205,7 +5204,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5301,14 +5300,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5332,18 +5331,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -5369,24 +5368,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5400,26 +5399,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5433,22 +5434,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5462,6 +5465,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -5469,16 +5474,16 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5493,6 +5498,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -5502,7 +5509,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -5513,14 +5520,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5562,20 +5569,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5590,6 +5597,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -5600,16 +5609,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5619,6 +5628,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -5626,16 +5637,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5645,6 +5656,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -5730,22 +5743,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5795,22 +5808,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5842,7 +5855,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -5861,18 +5874,18 @@ paths: Message: description: "Details of an error" type: "string" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5900,27 +5913,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5945,6 +5958,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -5952,24 +5967,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5989,22 +6004,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6029,27 +6045,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6092,7 +6108,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6107,7 +6123,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6120,7 +6136,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -6155,7 +6171,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6299,9 +6315,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -6337,13 +6353,13 @@ paths: type: "string" default: "" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6355,7 +6371,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6365,7 +6381,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6381,13 +6397,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6432,7 +6448,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -6513,14 +6529,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6538,7 +6554,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -6568,11 +6584,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6596,13 +6612,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6644,21 +6660,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6689,7 +6705,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -6700,15 +6716,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6737,7 +6753,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6772,7 +6788,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6815,7 +6831,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6830,7 +6846,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6843,7 +6859,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -6862,9 +6878,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6882,11 +6898,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6898,7 +6914,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6958,7 +6974,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6968,9 +6984,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -6982,7 +6999,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6996,18 +7013,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7077,7 +7094,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7118,11 +7135,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7161,7 +7178,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7241,7 +7258,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7277,12 +7294,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7306,20 +7323,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -7336,9 +7354,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7365,22 +7383,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7454,13 +7472,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -7491,17 +7509,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7530,7 +7548,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7579,11 +7597,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7601,7 +7619,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -7637,7 +7655,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7667,11 +7685,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7716,15 +7734,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7741,17 +7759,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7766,6 +7784,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -7783,7 +7803,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7798,7 +7818,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7815,7 +7835,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -7872,7 +7892,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7898,15 +7918,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7931,17 +7951,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7951,6 +7971,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -7962,7 +7984,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -7976,19 +7998,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8073,17 +8095,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8119,17 +8141,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8169,7 +8191,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8180,7 +8202,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8192,13 +8214,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8218,7 +8240,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8248,7 +8270,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8270,9 +8292,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8332,15 +8354,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8356,15 +8378,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8385,13 +8407,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8412,13 +8434,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8440,13 +8462,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8497,6 +8519,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -8505,9 +8529,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8523,6 +8547,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -8537,13 +8563,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8568,33 +8594,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8617,19 +8645,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8644,17 +8672,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8675,21 +8703,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8715,19 +8743,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8740,21 +8768,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8803,17 +8831,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8875,13 +8903,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8897,17 +8925,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8946,7 +8974,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8957,11 +8985,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8987,13 +9015,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9003,17 +9031,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9038,7 +9066,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9053,23 +9081,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9158,19 +9186,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9190,17 +9218,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9218,23 +9246,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9293,15 +9321,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -9320,27 +9348,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9396,7 +9424,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9513,11 +9541,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9542,19 +9570,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9577,27 +9605,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9652,7 +9680,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9682,11 +9710,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9711,19 +9739,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9752,7 +9780,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -9773,15 +9801,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9798,17 +9826,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9824,21 +9852,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9867,7 +9895,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9881,11 +9909,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9909,19 +9937,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9945,7 +9973,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -9958,15 +9986,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9983,17 +10011,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10009,21 +10037,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10053,7 +10081,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -10115,14 +10143,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10165,13 +10193,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.37.yaml b/_vendor/github.com/moby/moby/api/docs/v1.37.yaml index 7c829b5879..19c36c6383 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.37.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.37.yaml @@ -822,7 +822,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -3223,7 +3223,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -4247,7 +4247,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -4345,7 +4344,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -4476,11 +4475,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4640,7 +4639,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -4662,22 +4661,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4690,7 +4689,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4945,14 +4944,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4974,7 +4973,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5023,14 +5022,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5055,23 +5054,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5133,7 +5132,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -5162,14 +5161,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5188,16 +5187,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5225,7 +5224,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5321,14 +5320,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5352,18 +5351,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -5389,24 +5388,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5420,26 +5419,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5453,22 +5454,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5482,6 +5485,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -5489,23 +5494,23 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5520,6 +5525,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -5529,7 +5536,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -5540,14 +5547,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5589,20 +5596,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5617,6 +5624,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -5627,16 +5636,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5646,6 +5655,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -5653,16 +5664,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5672,6 +5683,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -5757,22 +5770,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5822,22 +5835,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5869,7 +5882,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -5888,18 +5901,18 @@ paths: Message: description: "Details of an error" type: "string" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5927,27 +5940,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5972,6 +5985,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -5979,24 +5994,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6016,22 +6031,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6056,27 +6072,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6119,7 +6135,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6134,7 +6150,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6147,7 +6163,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -6182,7 +6198,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6337,9 +6353,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -6380,13 +6396,13 @@ paths: type: "string" default: "" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6398,7 +6414,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6408,7 +6424,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6424,13 +6440,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6475,7 +6491,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -6556,14 +6572,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6581,7 +6597,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -6611,11 +6627,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6639,13 +6655,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6687,21 +6703,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6732,7 +6748,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -6743,15 +6759,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6780,7 +6796,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6815,7 +6831,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6858,7 +6874,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6873,7 +6889,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6886,7 +6902,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -6905,9 +6921,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6925,11 +6941,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6941,7 +6957,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7001,7 +7017,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7011,9 +7027,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -7025,7 +7042,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7039,18 +7056,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7120,7 +7137,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7161,11 +7178,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7204,7 +7221,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7284,7 +7301,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7320,12 +7337,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7349,20 +7366,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -7379,9 +7397,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7408,22 +7426,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7497,13 +7515,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -7534,17 +7552,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7573,7 +7591,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7622,11 +7640,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7644,7 +7662,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -7680,7 +7698,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7710,11 +7728,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7759,15 +7777,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7784,17 +7802,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7809,6 +7827,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -7826,7 +7846,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7841,7 +7861,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7858,7 +7878,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -7915,7 +7935,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7941,15 +7961,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7974,17 +7994,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7994,6 +8014,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -8005,7 +8027,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -8019,19 +8041,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8116,17 +8138,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8162,17 +8184,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8212,7 +8234,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8223,7 +8245,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8235,13 +8257,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8261,7 +8283,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8291,7 +8313,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8313,9 +8335,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8375,15 +8397,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8399,15 +8421,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8428,13 +8450,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8455,13 +8477,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8483,13 +8505,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8540,6 +8562,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -8548,9 +8572,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8566,6 +8590,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -8580,13 +8606,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8611,33 +8637,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8660,19 +8688,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8687,17 +8715,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8718,21 +8746,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8758,19 +8786,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8783,21 +8811,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8846,17 +8874,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8918,13 +8946,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8940,17 +8968,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8989,7 +9017,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9000,11 +9028,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9030,13 +9058,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9046,17 +9074,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9081,7 +9109,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9096,23 +9124,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9201,19 +9229,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9233,17 +9261,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9261,23 +9289,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9336,15 +9364,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -9363,27 +9391,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9439,7 +9467,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9556,11 +9584,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9585,19 +9613,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9620,27 +9648,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9695,7 +9723,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9725,11 +9753,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9754,19 +9782,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9795,7 +9823,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -9816,15 +9844,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9841,17 +9869,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9867,21 +9895,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9910,7 +9938,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9924,11 +9952,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9952,19 +9980,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9988,7 +10016,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -10001,15 +10029,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10026,17 +10054,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10052,21 +10080,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10096,7 +10124,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -10158,14 +10186,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10208,13 +10236,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.38.yaml b/_vendor/github.com/moby/moby/api/docs/v1.38.yaml index 99fd5951e1..f0b377432c 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.38.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.38.yaml @@ -819,7 +819,7 @@ definitions: SecurityOpt: type: "array" description: "A list of string values to customize labels for MLS - systems, such as SELinux." + systems, such as SELinux." items: type: "string" StorageOpt: @@ -3273,7 +3273,7 @@ definitions: properties: Mode: description: "The mode of resolution to use for internal load balancing - between tasks." + between tasks." type: "string" enum: - "vip" @@ -4293,7 +4293,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -4391,7 +4390,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -4522,11 +4521,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4685,7 +4684,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -4707,22 +4706,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -4735,7 +4734,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -4996,14 +4995,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5025,7 +5024,7 @@ paths: description: "On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows." operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5074,14 +5073,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5106,23 +5105,23 @@ paths: Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5184,7 +5183,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -5213,14 +5212,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5239,16 +5238,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5276,7 +5275,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -5372,14 +5371,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5403,18 +5402,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -5440,24 +5439,24 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" schema: $ref: "#/definitions/ErrorResponse" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5471,26 +5470,28 @@ paths: in: "query" description: "Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`." type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5504,22 +5505,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5533,6 +5536,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -5540,23 +5545,23 @@ paths: description: "Send a POSIX signal to a container, defaulting to killing to the container." operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5571,6 +5576,8 @@ paths: description: "Signal to send to the container as an integer or string (e.g. `SIGINT`)" type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -5580,7 +5587,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -5591,14 +5598,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5639,20 +5646,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5667,6 +5674,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -5677,16 +5686,16 @@ paths: Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5696,6 +5705,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -5703,16 +5714,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5722,6 +5733,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -5807,22 +5820,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5872,22 +5885,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5919,7 +5932,7 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: type: "object" @@ -5938,18 +5951,18 @@ paths: Message: description: "Details of an error" type: "string" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5977,27 +5990,27 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6022,6 +6035,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -6029,24 +6044,24 @@ paths: description: "A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path." operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: type: "string" description: "TODO" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6066,22 +6081,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6106,27 +6122,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6169,7 +6185,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6184,7 +6200,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6197,7 +6213,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" @@ -6232,7 +6248,7 @@ paths: SharedSize: 0 Labels: {} Containers: 5 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6387,9 +6403,9 @@ paths: - name: "networkmode" in: "query" description: "Sets the networking mode for the run commands during - build. Supported standard values are: `bridge`, `host`, `none`, and - `container:`. Any other value is taken as a custom network's - name to which this container should connect to." + build. Supported standard values are: `bridge`, `host`, `none`, and + `container:`. Any other value is taken as a custom network's + name to which this container should connect to." type: "string" - name: "Content-type" in: "header" @@ -6440,13 +6456,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6458,7 +6474,7 @@ paths: - "application/json" operationId: "BuildPrune" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6468,7 +6484,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6484,13 +6500,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6535,7 +6551,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Image" @@ -6616,14 +6632,14 @@ paths: Layers: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6641,7 +6657,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -6671,11 +6687,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6699,13 +6715,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6747,21 +6763,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6792,7 +6808,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -6803,15 +6819,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6840,7 +6856,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -6875,7 +6891,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6918,7 +6934,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -6933,7 +6949,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6946,7 +6962,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -6965,9 +6981,9 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6985,11 +7001,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7001,7 +7017,7 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7061,7 +7077,7 @@ paths: MinAPIVersion: "1.12" BuildTime: "2016-06-14T07:09:13.444803460+00:00" Experimental: true - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7071,9 +7087,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -7085,7 +7102,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7099,18 +7116,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7180,7 +7197,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7221,11 +7238,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7264,7 +7281,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7344,7 +7361,7 @@ paths: UsageData: Size: 10920104 RefCount: 2 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7380,12 +7397,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7409,20 +7426,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -7439,9 +7457,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7468,22 +7486,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7557,13 +7575,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -7594,17 +7612,17 @@ paths: description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance." operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7633,7 +7651,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7682,11 +7700,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7704,7 +7722,7 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: type: "object" @@ -7740,7 +7758,7 @@ paths: o: "size=100m,uid=1000" type: "tmpfs" Warnings: [] - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7770,11 +7788,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7819,15 +7837,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7844,17 +7862,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7869,6 +7887,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: post: @@ -7886,7 +7906,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7901,7 +7921,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7918,7 +7938,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -7975,7 +7995,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8001,15 +8021,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8034,17 +8054,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8054,6 +8074,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -8065,7 +8087,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -8079,19 +8101,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8176,17 +8198,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8222,17 +8244,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8272,7 +8294,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8283,7 +8305,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8295,13 +8317,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8321,7 +8343,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -8351,7 +8373,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8373,9 +8395,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8435,15 +8457,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8459,15 +8481,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8488,13 +8510,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8515,13 +8537,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8543,13 +8565,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8600,6 +8622,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -8608,9 +8632,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8626,6 +8650,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -8640,13 +8666,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8671,33 +8697,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8720,19 +8748,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8747,17 +8775,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8778,21 +8806,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8818,19 +8846,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8843,21 +8871,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8906,17 +8934,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -8978,13 +9006,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9000,17 +9028,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9049,7 +9077,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9060,11 +9088,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9090,13 +9118,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9106,17 +9134,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9141,7 +9169,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -9156,23 +9184,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9261,19 +9289,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9293,17 +9321,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9321,23 +9349,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9396,15 +9424,15 @@ paths: in: "query" type: "string" description: "If the X-Registry-Auth header is not specified, this - parameter indicates where to find registry authorization credentials. The - valid values are `spec` and `previous-spec`." + parameter indicates where to find registry authorization credentials. The + valid values are `spec` and `previous-spec`." default: "spec" - name: "rollback" in: "query" type: "string" description: "Set to this parameter to `previous` to cause a - server-side rollback to the previous service spec. The supplied spec will be - ignored in this case." + server-side rollback to the previous service spec. The supplied spec will be + ignored in this case." - name: "X-Registry-Auth" in: "header" description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" @@ -9423,27 +9451,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9499,7 +9527,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9616,11 +9644,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9645,19 +9673,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9680,27 +9708,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9755,7 +9783,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9785,11 +9813,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9814,19 +9842,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9855,7 +9883,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -9876,15 +9904,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9901,17 +9929,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9927,21 +9955,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9970,7 +9998,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9984,11 +10012,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10012,19 +10040,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10048,7 +10076,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -10061,15 +10089,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10086,17 +10114,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10112,21 +10140,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10156,7 +10184,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -10218,14 +10246,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10268,13 +10296,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.39.yaml b/_vendor/github.com/moby/moby/api/docs/v1.39.yaml index 3200058553..ac1dd19215 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.39.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.39.yaml @@ -1171,10 +1171,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1359,10 +1358,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1527,36 +1525,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1836,11 +1830,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } ImageInspect: description: | @@ -5575,7 +5568,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -5705,7 +5697,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerSummary" @@ -5836,11 +5828,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -5994,7 +5986,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -6016,22 +6008,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6044,7 +6036,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6269,14 +6261,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6300,7 +6292,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6351,14 +6343,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6384,23 +6376,23 @@ paths: `journald` logging driver. operationId: "ContainerLogs" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6464,7 +6456,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -6493,14 +6485,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6519,16 +6511,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6567,7 +6559,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6663,14 +6655,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6696,18 +6688,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -6733,22 +6725,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6765,24 +6757,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6796,22 +6790,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6825,6 +6821,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -6834,23 +6832,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6866,6 +6864,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -6877,7 +6877,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -6888,14 +6888,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6936,20 +6936,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6964,6 +6964,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -6977,16 +6979,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6996,6 +6998,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -7003,16 +7007,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7022,6 +7026,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -7125,22 +7131,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7197,22 +7203,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7247,22 +7253,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7290,20 +7296,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -7312,7 +7318,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7337,6 +7343,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -7347,7 +7355,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -7355,18 +7363,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7386,22 +7394,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7426,27 +7435,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7502,7 +7511,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7517,7 +7526,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7530,13 +7539,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7748,13 +7757,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7793,7 +7802,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7808,7 +7817,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7824,13 +7833,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7883,18 +7892,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7912,7 +7921,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -7942,11 +7951,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7972,13 +7981,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8024,21 +8033,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8069,7 +8078,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -8080,15 +8089,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8117,7 +8126,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -8152,7 +8161,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8195,7 +8204,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8210,7 +8219,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8225,7 +8234,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -8244,13 +8253,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8268,11 +8277,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8284,11 +8293,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8298,9 +8307,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -8315,7 +8325,7 @@ paths: Docker-Experimental: type: "boolean" description: "If the server is running with experimental mode enabled" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8329,18 +8339,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8410,7 +8420,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8451,11 +8461,11 @@ paths: image: "alpine" name: "my-container" time: 1461943101 - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8494,7 +8504,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8601,7 +8611,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8637,12 +8647,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8671,20 +8681,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -8701,9 +8712,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8730,22 +8741,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8830,13 +8841,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -8869,17 +8880,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8908,7 +8919,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8957,11 +8968,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8979,11 +8990,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9013,11 +9024,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9036,15 +9047,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9061,17 +9072,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9086,6 +9097,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -9104,7 +9117,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9119,7 +9132,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9138,7 +9151,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9195,7 +9208,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9224,15 +9237,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9257,17 +9270,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9277,6 +9290,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -9288,7 +9303,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -9302,19 +9317,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9410,17 +9425,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9456,17 +9471,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9508,7 +9523,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9519,7 +9534,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9531,13 +9546,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9560,7 +9575,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9592,7 +9607,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9617,9 +9632,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9686,15 +9701,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9712,15 +9727,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9745,13 +9760,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9774,13 +9789,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9804,13 +9819,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9870,6 +9885,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -9878,9 +9895,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9898,6 +9915,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -9914,13 +9933,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9947,33 +9966,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -9996,19 +10017,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10023,17 +10044,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10054,21 +10075,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10096,19 +10117,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10121,21 +10142,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10215,17 +10236,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10290,13 +10311,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10314,17 +10335,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10365,7 +10386,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10376,11 +10397,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10406,13 +10427,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10422,17 +10443,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10460,7 +10481,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -10475,23 +10496,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10585,19 +10606,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10617,17 +10638,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10645,23 +10666,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10761,27 +10782,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10839,7 +10860,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -10956,11 +10977,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10988,19 +11009,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11025,27 +11046,27 @@ paths: - "application/vnd.docker.raw-stream" - "application/json" responses: - 101: + "101": description: "logs returned as a stream" schema: type: "string" format: "binary" - 200: + "200": description: "logs returned as a string in response body" schema: type: "string" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11103,7 +11124,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11133,11 +11154,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11165,19 +11186,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11206,7 +11227,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -11227,15 +11248,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11252,17 +11273,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11278,21 +11299,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11326,7 +11347,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11340,11 +11361,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11371,19 +11392,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11407,7 +11428,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -11420,15 +11441,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11445,17 +11466,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11471,21 +11492,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11521,7 +11542,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: type: "object" @@ -11585,14 +11606,14 @@ paths: Variant: "" Features: - "" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11638,13 +11659,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.40.yaml b/_vendor/github.com/moby/moby/api/docs/v1.40.yaml index 7e59bcfaf5..9693ebfe59 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.40.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.40.yaml @@ -1234,10 +1234,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1422,10 +1421,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1590,36 +1588,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1899,11 +1893,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } ImageInspect: description: | @@ -5719,7 +5712,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6001,7 +5993,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6134,11 +6126,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6301,7 +6293,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -6323,22 +6315,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6351,7 +6343,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6587,14 +6579,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6618,7 +6610,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6669,14 +6661,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6702,7 +6694,7 @@ paths: `journald` logging driver. operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -6711,14 +6703,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6779,7 +6771,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -6808,14 +6800,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6834,16 +6826,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6882,7 +6874,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6978,14 +6970,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7011,18 +7003,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7048,22 +7040,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7080,24 +7072,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7111,22 +7105,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7140,6 +7136,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -7149,23 +7147,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7181,6 +7179,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -7192,7 +7192,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -7203,14 +7203,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7252,20 +7252,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7280,6 +7280,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -7293,16 +7295,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7312,6 +7314,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -7319,16 +7323,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7338,6 +7342,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -7441,22 +7447,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7513,22 +7519,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7563,22 +7569,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7606,20 +7612,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -7628,7 +7634,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7653,6 +7659,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -7663,7 +7671,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -7671,18 +7679,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7702,22 +7710,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7742,27 +7751,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7818,7 +7827,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -7833,7 +7842,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7846,13 +7855,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8080,13 +8089,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8125,7 +8134,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8140,7 +8149,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8156,13 +8165,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8207,10 +8216,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -8227,18 +8238,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8256,7 +8267,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -8286,11 +8297,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8316,13 +8327,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8368,21 +8379,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8413,7 +8424,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -8424,15 +8435,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8461,7 +8472,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -8496,7 +8507,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8539,7 +8550,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8554,7 +8565,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8569,7 +8580,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -8588,13 +8599,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8612,11 +8623,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8628,11 +8639,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8642,9 +8653,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -8665,7 +8677,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8683,7 +8695,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -8704,7 +8716,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8718,18 +8730,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8799,15 +8811,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8846,7 +8858,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -8953,7 +8965,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8989,12 +9001,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9023,20 +9035,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -9053,9 +9066,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9082,22 +9095,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9183,13 +9196,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -9223,17 +9236,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9262,7 +9275,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9311,11 +9324,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9333,11 +9346,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9367,11 +9380,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9390,15 +9403,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9415,17 +9428,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9440,6 +9453,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -9458,7 +9473,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9473,7 +9488,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9492,7 +9507,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9549,7 +9564,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9582,15 +9597,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9615,17 +9630,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9635,6 +9650,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -9646,7 +9663,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -9660,19 +9677,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9769,17 +9786,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9816,17 +9833,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9869,7 +9886,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9880,7 +9897,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9892,13 +9909,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9921,7 +9938,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -9940,7 +9957,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9965,9 +9982,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10022,15 +10039,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10048,15 +10065,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10081,13 +10098,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10110,13 +10127,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10140,13 +10157,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10194,6 +10211,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -10202,9 +10221,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10222,6 +10241,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -10238,13 +10259,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10271,33 +10292,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10321,19 +10344,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10348,17 +10371,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10379,21 +10402,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10421,19 +10444,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10446,21 +10469,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10549,17 +10572,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10625,13 +10648,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10649,17 +10672,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10700,7 +10723,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10711,11 +10734,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10742,13 +10765,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10758,17 +10781,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10796,7 +10819,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -10811,23 +10834,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10921,19 +10944,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10953,17 +10976,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10981,23 +11004,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11094,23 +11117,23 @@ paths: `json-file` or `journald` logging drivers. operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11165,7 +11188,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11282,11 +11305,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11314,19 +11337,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11348,23 +11371,23 @@ paths: `json-file` or `journald` logging drivers. operationId: "TaskLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11419,7 +11442,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11449,11 +11472,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11481,19 +11504,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11522,7 +11545,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -11543,15 +11566,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11568,17 +11591,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11594,21 +11617,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11642,7 +11665,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11656,11 +11679,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11687,19 +11710,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11723,7 +11746,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -11736,15 +11759,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11761,17 +11784,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11787,21 +11810,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11837,18 +11860,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11891,13 +11914,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.41.yaml b/_vendor/github.com/moby/moby/api/docs/v1.41.yaml index 4829b64200..d77c0a47da 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.41.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.41.yaml @@ -1265,10 +1265,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1453,10 +1452,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1621,36 +1619,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1930,11 +1924,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } ImageInspect: description: | @@ -5973,7 +5966,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6255,7 +6247,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6388,11 +6380,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6577,7 +6569,7 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: type: "object" @@ -6599,22 +6591,22 @@ paths: application/json: Id: "e90e34656806" Warnings: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6627,7 +6619,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6863,14 +6855,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6894,7 +6886,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -6945,14 +6937,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6978,7 +6970,7 @@ paths: `journald` logging driver. operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -6987,14 +6979,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7055,7 +7047,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -7084,14 +7076,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7110,16 +7102,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7164,7 +7156,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7260,14 +7252,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7300,18 +7292,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7337,22 +7329,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7369,24 +7361,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7400,22 +7394,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7429,6 +7425,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -7438,23 +7436,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7470,6 +7468,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -7481,7 +7481,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -7492,14 +7492,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7541,20 +7541,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7569,6 +7569,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -7582,16 +7584,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7601,6 +7603,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -7608,16 +7612,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7627,6 +7631,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -7730,22 +7736,22 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7802,22 +7808,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7852,22 +7858,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7895,20 +7901,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -7917,7 +7923,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7942,6 +7948,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -7952,7 +7960,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -7960,18 +7968,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7991,22 +7999,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8031,27 +8040,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8107,7 +8116,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8122,7 +8131,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8135,13 +8144,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8369,13 +8378,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8414,7 +8423,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8429,7 +8438,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8445,13 +8454,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8496,10 +8505,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -8516,18 +8527,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8545,7 +8556,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -8575,11 +8586,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8605,13 +8616,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8657,21 +8668,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8702,7 +8713,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -8713,15 +8724,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8750,7 +8761,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -8785,7 +8796,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8828,7 +8839,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8843,7 +8854,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8858,7 +8869,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -8877,13 +8888,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8901,11 +8912,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8917,11 +8928,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8931,9 +8942,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -8954,7 +8966,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8972,7 +8984,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -8993,7 +9005,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9007,18 +9019,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9090,15 +9102,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9137,7 +9149,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9244,7 +9256,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9280,12 +9292,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9314,20 +9326,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -9344,9 +9357,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9373,22 +9386,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9474,13 +9487,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -9514,17 +9527,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9553,7 +9566,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9602,11 +9615,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9624,11 +9637,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9658,11 +9671,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9681,15 +9694,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9706,17 +9719,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9731,6 +9744,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -9749,7 +9764,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9764,7 +9779,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9783,7 +9798,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9840,7 +9855,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9873,15 +9888,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9906,17 +9921,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9926,6 +9941,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -9937,7 +9954,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -9951,19 +9968,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10068,17 +10085,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10115,17 +10132,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10168,7 +10185,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10179,7 +10196,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10191,13 +10208,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10220,7 +10237,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -10239,7 +10256,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10264,9 +10281,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10321,15 +10338,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10347,15 +10364,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10380,13 +10397,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10409,13 +10426,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10439,13 +10456,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10493,6 +10510,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -10501,9 +10520,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10521,6 +10540,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -10537,13 +10558,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10570,33 +10591,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10620,19 +10643,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10647,17 +10670,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10678,21 +10701,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10720,19 +10743,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10745,21 +10768,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10848,17 +10871,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10924,13 +10947,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10948,17 +10971,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10999,7 +11022,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -11010,11 +11033,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11041,13 +11064,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11057,17 +11080,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11100,7 +11123,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -11115,23 +11138,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11225,19 +11248,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11257,17 +11280,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11285,23 +11308,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11398,23 +11421,23 @@ paths: `json-file` or `journald` logging drivers. operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11469,7 +11492,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11586,11 +11609,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11618,19 +11641,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11652,23 +11675,23 @@ paths: `json-file` or `journald` logging drivers. operationId: "TaskLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11723,7 +11746,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11753,11 +11776,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11785,19 +11808,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11826,7 +11849,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -11847,15 +11870,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11872,17 +11895,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11898,21 +11921,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11946,7 +11969,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11960,11 +11983,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11991,19 +12014,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12027,7 +12050,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -12040,15 +12063,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12065,17 +12088,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12091,21 +12114,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12141,18 +12164,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12195,13 +12218,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.42.yaml b/_vendor/github.com/moby/moby/api/docs/v1.42.yaml index b677a57506..44042b7a09 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.42.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.42.yaml @@ -1269,10 +1269,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1457,10 +1456,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1625,36 +1623,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1934,11 +1928,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } ImageInspect: description: | @@ -5966,7 +5959,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6487,7 +6479,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6620,11 +6612,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6808,26 +6800,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6840,7 +6832,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7075,14 +7067,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7106,7 +7098,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7157,14 +7149,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7193,7 +7185,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -7202,14 +7194,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7270,7 +7262,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -7299,14 +7291,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7325,16 +7317,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7379,7 +7371,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7475,14 +7467,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7515,18 +7507,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7552,22 +7544,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7584,24 +7576,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7620,22 +7614,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7654,6 +7650,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -7663,23 +7661,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7695,6 +7693,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -7706,7 +7706,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -7717,14 +7717,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7765,20 +7765,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7793,6 +7793,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -7806,16 +7808,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7825,6 +7827,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -7832,16 +7836,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7851,6 +7855,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -7956,22 +7962,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8028,22 +8034,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8093,22 +8099,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8136,20 +8142,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8158,7 +8164,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8183,6 +8189,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8193,7 +8201,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -8201,18 +8209,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8232,22 +8240,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8272,27 +8281,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8348,7 +8357,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8363,7 +8372,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8376,13 +8385,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8615,13 +8624,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8660,7 +8669,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8675,7 +8684,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8691,13 +8700,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8742,10 +8751,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -8777,18 +8788,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8806,7 +8817,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -8836,11 +8847,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8866,13 +8877,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8918,21 +8929,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8963,7 +8974,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -8974,15 +8985,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9011,7 +9022,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9046,7 +9057,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9089,7 +9100,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9104,7 +9115,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9119,7 +9130,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -9138,13 +9149,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9162,11 +9173,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9178,11 +9189,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9192,9 +9203,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9232,7 +9244,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9250,7 +9262,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9278,7 +9290,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9292,18 +9304,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9375,15 +9387,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9422,7 +9434,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9529,7 +9541,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9575,12 +9587,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9609,20 +9621,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -9639,9 +9652,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9668,22 +9681,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9779,13 +9792,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -9829,17 +9842,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9868,7 +9881,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9917,11 +9930,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9939,11 +9952,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9973,11 +9986,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9996,15 +10009,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10023,21 +10036,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10079,17 +10092,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10104,6 +10117,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -10123,7 +10138,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10138,7 +10153,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10157,7 +10172,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10214,7 +10229,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10247,15 +10262,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10280,17 +10295,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10300,6 +10315,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -10311,7 +10328,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -10325,19 +10342,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10442,17 +10459,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10489,17 +10506,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10542,7 +10559,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10553,7 +10570,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10565,13 +10582,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10594,7 +10611,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -10613,7 +10630,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10638,9 +10655,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10695,15 +10712,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10721,15 +10738,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10754,13 +10771,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10783,13 +10800,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10813,13 +10830,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10867,6 +10884,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -10875,9 +10894,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10895,6 +10914,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -10911,13 +10932,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10944,33 +10965,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10994,19 +11017,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11021,17 +11044,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11052,21 +11075,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11094,19 +11117,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11119,21 +11142,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11222,17 +11245,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11298,13 +11321,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11322,17 +11345,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11373,7 +11396,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -11384,11 +11407,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11415,13 +11438,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11431,17 +11454,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11474,7 +11497,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -11489,23 +11512,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11599,19 +11622,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11631,17 +11654,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11659,23 +11682,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11775,23 +11798,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11846,7 +11869,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11963,11 +11986,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11995,19 +12018,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12032,23 +12055,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12103,7 +12126,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12133,11 +12156,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12165,19 +12188,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12206,7 +12229,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -12227,15 +12250,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12252,17 +12275,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12278,21 +12301,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12326,7 +12349,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12340,11 +12363,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12371,19 +12394,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12407,7 +12430,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -12420,15 +12443,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12445,17 +12468,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12471,21 +12494,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12521,18 +12544,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12575,13 +12598,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.43.yaml b/_vendor/github.com/moby/moby/api/docs/v1.43.yaml index 86433d3d4f..9dfea14dc0 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.43.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.43.yaml @@ -1276,10 +1276,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1464,10 +1463,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1632,36 +1630,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1941,11 +1935,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -5999,7 +5992,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6520,7 +6512,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6653,11 +6645,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6841,26 +6833,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6873,7 +6865,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7108,14 +7100,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7139,7 +7131,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7190,14 +7182,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7226,7 +7218,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -7235,14 +7227,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7303,7 +7295,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -7317,14 +7309,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7343,16 +7335,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7397,7 +7389,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7493,14 +7485,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7533,18 +7525,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7570,22 +7562,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7602,24 +7594,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7638,22 +7632,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7672,6 +7668,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -7681,23 +7679,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7713,6 +7711,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -7724,7 +7724,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -7735,14 +7735,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7783,20 +7783,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7811,6 +7811,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -7824,16 +7826,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7843,6 +7845,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -7850,16 +7854,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7869,6 +7873,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -7974,22 +7980,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8046,22 +8052,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8111,22 +8117,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8154,20 +8160,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8176,7 +8182,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8201,6 +8207,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8211,7 +8219,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -8219,18 +8227,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8250,22 +8258,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8290,27 +8299,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8366,7 +8375,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8381,7 +8390,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8394,13 +8403,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8633,13 +8642,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8678,7 +8687,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8693,7 +8702,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8709,13 +8718,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8760,10 +8769,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -8795,18 +8806,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8824,7 +8835,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -8854,11 +8865,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8884,13 +8895,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8936,21 +8947,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8981,7 +8992,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -8992,15 +9003,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9029,7 +9040,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9064,7 +9075,7 @@ paths: is_automated: false name: "vgauthier/sshd" star_count: 0 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9107,7 +9118,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9122,7 +9133,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9137,7 +9148,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -9156,13 +9167,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9180,11 +9191,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9196,11 +9207,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9210,9 +9221,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9250,7 +9262,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9268,7 +9280,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9296,7 +9308,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9310,18 +9322,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9393,15 +9405,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9440,7 +9452,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9547,7 +9559,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9593,12 +9605,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9627,20 +9639,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -9657,9 +9670,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9686,22 +9699,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9797,13 +9810,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -9847,17 +9860,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9886,7 +9899,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9935,11 +9948,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9957,11 +9970,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9991,11 +10004,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10014,15 +10027,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10041,21 +10054,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10097,17 +10110,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10122,6 +10135,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -10141,7 +10156,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10156,7 +10171,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10175,7 +10190,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10232,7 +10247,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10265,15 +10280,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10298,17 +10313,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10318,6 +10333,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -10329,7 +10346,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -10343,19 +10360,19 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10460,17 +10477,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10507,17 +10524,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10560,7 +10577,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10571,7 +10588,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10583,13 +10600,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10612,7 +10629,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -10631,7 +10648,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10656,9 +10673,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10713,15 +10730,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10739,15 +10756,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10772,13 +10789,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10801,13 +10818,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10831,13 +10848,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10885,6 +10902,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -10893,9 +10912,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10913,6 +10932,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -10929,13 +10950,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10962,33 +10983,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11012,19 +11035,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11039,17 +11062,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11070,21 +11093,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11112,19 +11135,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11137,21 +11160,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11240,17 +11263,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11316,13 +11339,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11340,17 +11363,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11391,7 +11414,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -11402,11 +11425,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11433,13 +11456,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11449,17 +11472,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11492,7 +11515,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: type: "object" @@ -11507,23 +11530,23 @@ paths: example: ID: "ak7w3gjqoa3kuz8xcpnyy0pvl" Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11617,19 +11640,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11649,17 +11672,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11677,23 +11700,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11793,23 +11816,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11864,7 +11887,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11981,11 +12004,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12013,19 +12036,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12050,23 +12073,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12121,7 +12144,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12151,11 +12174,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12183,19 +12206,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12224,7 +12247,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -12245,15 +12268,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12270,17 +12293,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12296,21 +12319,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12344,7 +12367,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12358,11 +12381,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12389,19 +12412,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12425,7 +12448,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -12438,15 +12461,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12463,17 +12486,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12489,21 +12512,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12539,18 +12562,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12593,13 +12616,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.44.yaml b/_vendor/github.com/moby/moby/api/docs/v1.44.yaml index 6284820f95..20f3d2830d 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.44.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.44.yaml @@ -1292,10 +1292,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1483,10 +1482,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1651,36 +1649,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1969,11 +1963,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -6138,7 +6131,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6659,7 +6651,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6792,11 +6784,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6981,26 +6973,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7013,7 +7005,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7248,14 +7240,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7279,7 +7271,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7330,14 +7322,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7366,7 +7358,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -7375,14 +7367,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7443,7 +7435,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -7457,14 +7449,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7483,16 +7475,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7537,7 +7529,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7633,14 +7625,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7673,18 +7665,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7710,22 +7702,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7742,24 +7734,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7778,22 +7772,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7812,6 +7808,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -7821,23 +7819,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7853,6 +7851,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -7864,7 +7864,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -7875,14 +7875,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7923,20 +7923,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7951,6 +7951,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -7964,16 +7966,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7983,6 +7985,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -7990,16 +7994,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8009,6 +8013,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8114,22 +8120,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8186,22 +8192,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8251,22 +8257,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8294,20 +8300,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8316,7 +8322,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8341,6 +8347,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8351,7 +8359,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -8359,18 +8367,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8390,22 +8398,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8430,27 +8439,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8506,7 +8515,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8521,7 +8530,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8534,13 +8543,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8774,13 +8783,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8819,7 +8828,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8834,7 +8843,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8850,13 +8859,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8901,10 +8910,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -8936,18 +8947,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8965,7 +8976,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -8995,11 +9006,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9025,13 +9036,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9077,21 +9088,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9122,7 +9133,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -9133,15 +9144,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9170,7 +9181,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9213,7 +9224,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9260,7 +9271,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9275,7 +9286,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9290,7 +9301,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -9309,13 +9320,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9333,11 +9344,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9349,11 +9360,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9363,9 +9374,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9403,7 +9415,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9421,7 +9433,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9449,7 +9461,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9463,18 +9475,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9546,15 +9558,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9593,7 +9605,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9699,7 +9711,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9741,12 +9753,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9775,20 +9787,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -9805,9 +9818,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9834,22 +9847,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9945,13 +9958,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -9995,17 +10008,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10034,7 +10047,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10083,11 +10096,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10105,11 +10118,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10139,11 +10152,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10162,15 +10175,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10189,21 +10202,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10245,17 +10258,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10270,6 +10283,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -10289,7 +10304,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10304,7 +10319,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10323,7 +10338,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10380,7 +10395,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10413,15 +10428,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10446,17 +10461,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10466,6 +10481,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -10477,7 +10494,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -10491,21 +10508,21 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10605,21 +10622,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10657,17 +10674,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10710,7 +10727,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10721,7 +10738,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10733,13 +10750,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10762,7 +10779,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -10781,7 +10798,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10806,9 +10823,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10863,15 +10880,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10889,15 +10906,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10922,13 +10939,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10951,13 +10968,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10981,13 +10998,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11035,6 +11052,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11043,9 +11062,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11063,6 +11082,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11079,13 +11100,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11112,33 +11133,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11162,19 +11185,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11189,17 +11212,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11220,21 +11243,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11262,19 +11285,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11287,21 +11310,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11390,17 +11413,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11466,13 +11489,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11490,17 +11513,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11541,7 +11564,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -11552,11 +11575,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11583,13 +11606,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11599,17 +11622,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11642,27 +11665,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11756,19 +11779,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11788,17 +11811,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11816,23 +11839,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11932,23 +11955,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12003,7 +12026,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12120,11 +12143,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12152,19 +12175,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12189,23 +12212,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12260,7 +12283,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12290,11 +12313,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12322,19 +12345,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12363,7 +12386,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -12384,15 +12407,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12409,17 +12432,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12435,21 +12458,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12483,7 +12506,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12497,11 +12520,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12528,19 +12551,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12564,7 +12587,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -12577,15 +12600,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12602,17 +12625,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12628,21 +12651,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12678,18 +12701,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12732,13 +12755,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.45.yaml b/_vendor/github.com/moby/moby/api/docs/v1.45.yaml index fa5e075907..d6315733b3 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.45.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.45.yaml @@ -1293,10 +1293,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1484,10 +1483,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1652,36 +1650,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1970,11 +1964,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -6124,7 +6117,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6645,7 +6637,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6778,11 +6770,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6967,26 +6959,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -6999,7 +6991,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7234,14 +7226,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7265,7 +7257,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7316,14 +7308,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7352,7 +7344,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -7361,14 +7353,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7429,7 +7421,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -7443,14 +7435,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7469,16 +7461,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7523,7 +7515,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7619,14 +7611,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7659,18 +7651,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7696,22 +7688,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7728,24 +7720,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7764,22 +7758,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7798,6 +7794,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -7807,23 +7805,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7839,6 +7837,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -7850,7 +7850,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -7861,14 +7861,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7909,20 +7909,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7937,6 +7937,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -7950,16 +7952,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7969,6 +7971,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -7976,16 +7980,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7995,6 +7999,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8100,22 +8106,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8172,22 +8178,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8237,22 +8243,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8280,20 +8286,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8302,7 +8308,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8327,6 +8333,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8337,7 +8345,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -8345,18 +8353,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8376,22 +8384,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8416,27 +8425,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8492,7 +8501,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8507,7 +8516,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8520,13 +8529,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8760,13 +8769,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8805,7 +8814,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8820,7 +8829,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8836,13 +8845,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8887,10 +8896,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -8922,18 +8933,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8951,7 +8962,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -8981,11 +8992,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9011,13 +9022,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9063,21 +9074,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9108,7 +9119,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -9119,15 +9130,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9156,7 +9167,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9198,7 +9209,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9240,7 +9251,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9255,7 +9266,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9270,7 +9281,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -9289,13 +9300,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9313,11 +9324,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9329,11 +9340,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9343,9 +9354,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9383,7 +9395,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9401,7 +9413,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9429,7 +9441,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9443,18 +9455,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9526,15 +9538,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9573,7 +9585,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9679,7 +9691,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9721,12 +9733,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9755,20 +9767,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -9785,9 +9798,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9814,22 +9827,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9925,13 +9938,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -9975,17 +9988,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10014,7 +10027,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10063,11 +10076,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10085,11 +10098,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10119,11 +10132,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10142,15 +10155,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10169,21 +10182,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10225,17 +10238,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10250,6 +10263,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -10269,7 +10284,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10284,7 +10299,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10303,7 +10318,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10360,7 +10375,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10393,15 +10408,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10426,17 +10441,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10446,6 +10461,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -10457,7 +10474,7 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "No error" schema: type: "object" @@ -10471,21 +10488,21 @@ paths: example: Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" Warning: "" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10585,21 +10602,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10637,17 +10654,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10690,7 +10707,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10701,7 +10718,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10713,13 +10730,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10742,7 +10759,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -10761,7 +10778,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10786,9 +10803,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10843,15 +10860,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10869,15 +10886,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10902,13 +10919,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10931,13 +10948,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10961,13 +10978,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11015,6 +11032,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11023,9 +11042,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11043,6 +11062,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11059,13 +11080,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11092,33 +11113,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11142,19 +11165,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11169,17 +11192,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11200,21 +11223,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11242,19 +11265,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11267,21 +11290,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11370,17 +11393,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11446,13 +11469,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11470,17 +11493,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11521,7 +11544,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -11532,11 +11555,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11563,13 +11586,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11579,17 +11602,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11622,27 +11645,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11736,19 +11759,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11768,17 +11791,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11796,23 +11819,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11912,23 +11935,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11983,7 +12006,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12100,11 +12123,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12132,19 +12155,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12169,23 +12192,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12240,7 +12263,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12270,11 +12293,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12302,19 +12325,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12343,7 +12366,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -12364,15 +12387,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12389,17 +12412,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12415,21 +12438,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12463,7 +12486,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12477,11 +12500,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12508,19 +12531,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12544,7 +12567,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -12557,15 +12580,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12582,17 +12605,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12608,21 +12631,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12658,18 +12681,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12712,13 +12735,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.46.yaml b/_vendor/github.com/moby/moby/api/docs/v1.46.yaml index 0f5a3962d2..8fc24acb43 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.46.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.46.yaml @@ -1308,10 +1308,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1504,10 +1503,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1679,36 +1677,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1997,11 +1991,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -6235,7 +6228,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6756,7 +6748,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -6899,11 +6891,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7088,26 +7080,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7120,7 +7112,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7355,14 +7347,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7386,7 +7378,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7437,14 +7429,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7473,7 +7465,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -7482,14 +7474,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7550,7 +7542,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -7564,14 +7556,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7590,16 +7582,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7644,7 +7636,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7740,14 +7732,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7780,18 +7772,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7817,22 +7809,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7849,24 +7841,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7885,22 +7879,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7919,6 +7915,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -7928,23 +7926,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7960,6 +7958,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -7971,7 +7971,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -7982,14 +7982,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8030,20 +8030,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8058,6 +8058,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -8071,16 +8073,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8090,6 +8092,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -8097,16 +8101,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8116,6 +8120,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8221,22 +8227,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8293,22 +8299,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8358,22 +8364,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8401,20 +8407,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8423,7 +8429,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8448,6 +8454,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8458,7 +8466,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -8466,18 +8474,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8497,22 +8505,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8537,27 +8546,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8613,7 +8622,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8628,7 +8637,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8641,13 +8650,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8881,13 +8890,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8926,7 +8935,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8941,7 +8950,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8957,13 +8966,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9008,10 +9017,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -9043,18 +9054,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9072,7 +9083,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -9102,11 +9113,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9132,13 +9143,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9197,21 +9208,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9242,7 +9253,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -9253,15 +9264,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9290,7 +9301,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9332,7 +9343,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9374,7 +9385,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9389,7 +9400,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9404,7 +9415,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -9423,13 +9434,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9447,11 +9458,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9463,11 +9474,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9477,9 +9488,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9517,7 +9529,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9535,7 +9547,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9563,7 +9575,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9577,18 +9589,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9660,15 +9672,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9707,7 +9719,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9813,7 +9825,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9855,12 +9867,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9889,20 +9901,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -9919,9 +9932,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9948,22 +9961,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10059,13 +10072,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -10109,17 +10122,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10148,7 +10161,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10197,11 +10210,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10219,11 +10232,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10253,11 +10266,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10276,15 +10289,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10303,21 +10316,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10359,17 +10372,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10384,6 +10397,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -10403,7 +10418,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10418,7 +10433,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10437,7 +10452,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10494,7 +10509,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10527,15 +10542,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10560,17 +10575,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10580,6 +10595,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -10591,25 +10608,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10704,21 +10721,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10756,17 +10773,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10809,7 +10826,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10820,7 +10837,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10832,13 +10849,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10861,7 +10878,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -10880,7 +10897,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10905,9 +10922,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10962,15 +10979,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10988,15 +11005,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11021,13 +11038,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11050,13 +11067,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11080,13 +11097,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11134,6 +11151,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11142,9 +11161,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11162,6 +11181,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11178,13 +11199,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11211,33 +11232,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11261,19 +11284,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11288,17 +11311,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11319,21 +11342,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11361,19 +11384,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11386,21 +11409,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11489,17 +11512,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11565,13 +11588,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11589,17 +11612,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11640,7 +11663,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -11651,11 +11674,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11682,13 +11705,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11698,17 +11721,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11741,27 +11764,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11856,19 +11879,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11888,17 +11911,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11916,23 +11939,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12033,23 +12056,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12104,7 +12127,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12221,11 +12244,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12253,19 +12276,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12290,23 +12313,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12361,7 +12384,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12391,11 +12414,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12423,19 +12446,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12464,7 +12487,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -12485,15 +12508,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12510,17 +12533,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12536,21 +12559,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12584,7 +12607,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12598,11 +12621,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12629,19 +12652,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12665,7 +12688,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -12678,15 +12701,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12703,17 +12726,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12729,21 +12752,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12779,18 +12802,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12833,13 +12856,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.47.yaml b/_vendor/github.com/moby/moby/api/docs/v1.47.yaml index f8bb6689fb..4561a2d254 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.47.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.47.yaml @@ -1308,10 +1308,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1504,10 +1503,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1679,36 +1677,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -1997,11 +1991,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -6257,7 +6250,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -6786,7 +6778,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -6892,7 +6884,7 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -7035,11 +7027,11 @@ paths: GlobalIPv6PrefixLen: 0 MacAddress: "02:42:ac:11:00:05" Mounts: [] - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7224,26 +7216,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7256,7 +7248,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7491,14 +7483,14 @@ paths: Mode: "ro,Z" RW: false Propagation: "" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7522,7 +7514,7 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7573,14 +7565,14 @@ paths: - "pts/0" - "00:00:00" - "sleep 10" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7609,7 +7601,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -7618,14 +7610,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7686,7 +7678,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -7700,14 +7692,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7726,16 +7718,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7780,7 +7772,7 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: type: "object" @@ -7876,14 +7868,14 @@ paths: periods: 0 throttled_periods: 0 throttled_time: 0 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7916,18 +7908,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -7953,22 +7945,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7985,24 +7977,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8021,22 +8015,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8055,6 +8051,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -8064,23 +8062,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8096,6 +8094,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -8107,7 +8107,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: type: "object" @@ -8118,14 +8118,14 @@ paths: type: "array" items: type: "string" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8166,20 +8166,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8194,6 +8194,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -8207,16 +8209,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8226,6 +8228,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -8233,16 +8237,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8252,6 +8256,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8357,22 +8363,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8429,22 +8435,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8494,22 +8500,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8537,20 +8543,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8559,7 +8565,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8584,6 +8590,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8594,7 +8602,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -8602,18 +8610,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8633,22 +8641,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8673,27 +8682,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8749,7 +8758,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -8764,7 +8773,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8777,13 +8786,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9022,13 +9031,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9067,7 +9076,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9082,7 +9091,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9098,13 +9107,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9149,10 +9158,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -9184,18 +9195,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9213,7 +9224,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -9243,11 +9254,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9273,13 +9284,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9338,21 +9349,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9383,7 +9394,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -9394,15 +9405,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9431,7 +9442,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9473,7 +9484,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9515,7 +9526,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9530,7 +9541,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9545,7 +9556,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -9564,13 +9575,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9588,11 +9599,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9604,11 +9615,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9618,9 +9629,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9658,7 +9670,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9676,7 +9688,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -9704,7 +9716,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9718,18 +9730,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9801,15 +9813,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9848,7 +9860,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -9954,7 +9966,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9996,12 +10008,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10030,20 +10042,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" tags: ["Image"] @@ -10060,9 +10073,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10089,22 +10102,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10200,13 +10213,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -10250,17 +10263,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10289,7 +10302,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10338,11 +10351,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10360,11 +10373,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10394,11 +10407,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10417,15 +10430,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10444,21 +10457,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10500,17 +10513,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10525,6 +10538,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -10544,7 +10559,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10559,7 +10574,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10578,7 +10593,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10638,7 +10653,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10671,15 +10686,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10704,17 +10719,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10724,6 +10739,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -10735,25 +10752,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10854,21 +10871,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10906,17 +10923,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10959,7 +10976,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10970,7 +10987,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10982,13 +10999,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11011,7 +11028,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11030,7 +11047,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11055,9 +11072,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11112,15 +11129,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11138,15 +11155,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11171,13 +11188,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11200,13 +11217,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11230,13 +11247,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11284,6 +11301,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11292,9 +11311,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11312,6 +11331,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11328,13 +11349,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11361,33 +11382,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11411,19 +11434,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11438,17 +11461,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11469,21 +11492,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11511,19 +11534,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11536,21 +11559,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11639,17 +11662,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11715,13 +11738,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11739,17 +11762,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11790,7 +11813,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -11801,11 +11824,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11832,13 +11855,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11848,17 +11871,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11891,27 +11914,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12006,19 +12029,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12038,17 +12061,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12066,23 +12089,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12183,23 +12206,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12254,7 +12277,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12371,11 +12394,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12403,19 +12426,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12440,23 +12463,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12511,7 +12534,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12541,11 +12564,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12573,19 +12596,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12614,7 +12637,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -12635,15 +12658,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12660,17 +12683,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12686,21 +12709,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12734,7 +12757,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12748,11 +12771,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12779,19 +12802,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IdResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12815,7 +12838,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -12828,15 +12851,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12853,17 +12876,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12879,21 +12902,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12929,18 +12952,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12983,13 +13006,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.48.yaml b/_vendor/github.com/moby/moby/api/docs/v1.48.yaml index 764585e1ed..21b8aee907 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.48.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.48.yaml @@ -1358,10 +1358,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1554,10 +1553,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1729,36 +1727,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -2047,11 +2041,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -5920,10 +5913,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7295,7 +7287,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -7849,7 +7840,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -7955,17 +7946,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8150,26 +8141,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8182,18 +8173,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8217,18 +8208,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8257,7 +8248,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8266,14 +8257,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8334,7 +8325,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8348,14 +8339,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8374,16 +8365,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8428,18 +8419,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8472,18 +8463,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8509,22 +8500,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8541,24 +8532,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8577,22 +8570,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8611,6 +8606,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -8620,23 +8617,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8652,6 +8649,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -8663,18 +8662,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8715,20 +8714,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8743,6 +8742,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -8756,16 +8757,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8775,6 +8776,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -8782,16 +8785,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8801,6 +8804,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8906,22 +8911,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8978,22 +8983,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9043,22 +9048,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9086,20 +9091,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -9108,7 +9113,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9133,6 +9138,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -9143,7 +9150,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9151,18 +9158,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9182,22 +9189,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9222,27 +9230,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9298,7 +9306,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9313,7 +9321,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9326,13 +9334,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9571,13 +9579,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9635,7 +9643,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9650,7 +9658,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9666,13 +9674,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9723,10 +9731,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -9758,18 +9768,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9793,7 +9803,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -9823,11 +9833,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9867,13 +9877,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9932,21 +9942,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9977,7 +9987,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -9988,15 +9998,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10025,7 +10035,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10067,7 +10077,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10109,7 +10119,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10124,7 +10134,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10139,7 +10149,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -10158,13 +10168,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10182,11 +10192,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10198,11 +10208,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10212,9 +10222,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10252,7 +10263,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10270,7 +10281,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10298,7 +10309,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10312,18 +10323,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10395,15 +10406,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10442,7 +10453,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10548,7 +10559,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10590,12 +10601,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10634,20 +10645,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10674,9 +10686,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10713,22 +10725,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10825,13 +10837,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -10874,17 +10886,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10913,7 +10925,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10962,11 +10974,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10984,11 +10996,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11018,11 +11030,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11041,15 +11053,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11068,21 +11080,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11124,17 +11136,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11149,6 +11161,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11168,7 +11182,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11183,7 +11197,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11202,7 +11216,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11262,7 +11276,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11295,15 +11309,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11328,17 +11342,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11348,6 +11362,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11359,25 +11375,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11476,21 +11492,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11529,17 +11545,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11582,7 +11598,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11593,7 +11609,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11605,13 +11621,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11634,7 +11650,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11653,7 +11669,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11678,9 +11694,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11735,15 +11751,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11761,15 +11777,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11794,13 +11810,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11823,13 +11839,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11853,13 +11869,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11907,6 +11923,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11915,9 +11933,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11935,6 +11953,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11951,13 +11971,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11984,33 +12004,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12034,19 +12056,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12061,17 +12083,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12092,21 +12114,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12134,19 +12156,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12159,21 +12181,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12262,17 +12284,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12338,13 +12360,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12362,17 +12384,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12413,7 +12435,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12424,11 +12446,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12455,13 +12477,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12471,17 +12493,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12514,27 +12536,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12629,19 +12651,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12661,17 +12683,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12689,23 +12711,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12806,23 +12828,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12877,7 +12899,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12994,11 +13016,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13026,19 +13048,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13063,23 +13085,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13134,7 +13156,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13164,11 +13186,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13196,19 +13218,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13237,7 +13259,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13258,15 +13280,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13283,17 +13305,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13309,21 +13331,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13357,7 +13379,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13371,11 +13393,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13402,19 +13424,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13438,7 +13460,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13451,15 +13473,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13476,17 +13498,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13502,21 +13524,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13552,18 +13574,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -13606,13 +13628,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.49.yaml b/_vendor/github.com/moby/moby/api/docs/v1.49.yaml index 64fc50abff..6428d9cc8f 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.49.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.49.yaml @@ -1358,10 +1358,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1554,10 +1553,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1729,36 +1727,32 @@ definitions: "AttachStdin": false "AttachStdout": false "AttachStderr": false - "ExposedPorts": { - "80/tcp": {}, + "ExposedPorts": + "80/tcp": {} "443/tcp": {} - } "Tty": false "OpenStdin": false "StdinOnce": false "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, + "Healthcheck": + "Test": ["string"] + "Interval": 0 + "Timeout": 0 + "Retries": 0 + "StartPeriod": 0 "StartInterval": 0 - } "ArgsEscaped": true "Image": "" - "Volumes": { - "/app/data": {}, + "Volumes": + "/app/data": {} "/app/config": {} - } "WorkingDir": "/public/" "Entrypoint": [] "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", + "Labels": + "com.example.some-label": "some-value" "com.example.some-other-label": "some-other-value" - } "StopSignal": "SIGTERM" "Shell": ["/bin/sh", "-c"] @@ -2047,11 +2041,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -5920,10 +5913,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7295,7 +7287,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -7849,7 +7840,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -7955,17 +7946,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8150,26 +8141,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8182,18 +8173,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8217,18 +8208,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8257,7 +8248,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8266,14 +8257,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8334,7 +8325,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8348,14 +8339,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8374,16 +8365,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8428,18 +8419,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8472,18 +8463,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8509,22 +8500,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8541,24 +8532,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8577,22 +8570,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8611,6 +8606,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -8620,23 +8617,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8652,6 +8649,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -8663,18 +8662,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8715,20 +8714,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8743,6 +8742,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -8756,16 +8757,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8775,6 +8776,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -8782,16 +8785,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8801,6 +8804,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8906,22 +8911,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8978,22 +8983,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9043,22 +9048,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9086,20 +9091,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -9108,7 +9113,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9133,6 +9138,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -9143,7 +9150,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9151,18 +9158,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9182,22 +9189,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9222,27 +9230,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9298,7 +9306,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9313,7 +9321,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9326,13 +9334,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9571,13 +9579,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9635,7 +9643,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9650,7 +9658,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9666,13 +9674,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9723,10 +9731,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -9758,18 +9768,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9814,7 +9824,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -9844,11 +9854,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9888,13 +9898,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9953,21 +9963,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9998,7 +10008,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -10009,15 +10019,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10046,7 +10056,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10088,7 +10098,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10130,7 +10140,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10145,7 +10155,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10160,7 +10170,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -10179,13 +10189,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10203,11 +10213,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10219,11 +10229,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10233,9 +10243,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10273,7 +10284,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10291,7 +10302,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10319,7 +10330,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10333,18 +10344,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10416,15 +10427,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10463,7 +10474,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10569,7 +10580,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10611,12 +10622,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10655,20 +10666,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10695,9 +10707,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10734,22 +10746,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10846,13 +10858,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -10895,17 +10907,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10934,7 +10946,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10983,11 +10995,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11005,11 +11017,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11039,11 +11051,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11062,15 +11074,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11089,21 +11101,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11145,17 +11157,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11170,6 +11182,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11189,7 +11203,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11204,7 +11218,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11223,7 +11237,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11283,7 +11297,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11316,15 +11330,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11349,17 +11363,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11369,6 +11383,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11380,25 +11396,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11497,21 +11513,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11550,17 +11566,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11603,7 +11619,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11614,7 +11630,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11626,13 +11642,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11655,7 +11671,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11674,7 +11690,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11699,9 +11715,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11756,15 +11772,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11782,15 +11798,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11815,13 +11831,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11844,13 +11860,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11874,13 +11890,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11928,6 +11944,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11936,9 +11954,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11956,6 +11974,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11972,13 +11992,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12005,33 +12025,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12055,19 +12077,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12082,17 +12104,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12113,21 +12135,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12155,19 +12177,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12180,21 +12202,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12283,17 +12305,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12359,13 +12381,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12383,17 +12405,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12434,7 +12456,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12445,11 +12467,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12476,13 +12498,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12492,17 +12514,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12535,27 +12557,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12650,19 +12672,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12682,17 +12704,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12710,23 +12732,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12827,23 +12849,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12898,7 +12920,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13015,11 +13037,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13047,19 +13069,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13084,23 +13106,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13155,7 +13177,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13185,11 +13207,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13217,19 +13239,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13258,7 +13280,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13279,15 +13301,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13304,17 +13326,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13330,21 +13352,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13378,7 +13400,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13392,11 +13414,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13423,19 +13445,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13459,7 +13481,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13472,15 +13494,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13497,17 +13519,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13523,21 +13545,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13573,18 +13595,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -13627,13 +13649,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.50.yaml b/_vendor/github.com/moby/moby/api/docs/v1.50.yaml index d22e0ec911..0375f825ab 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.50.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.50.yaml @@ -1358,10 +1358,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1501,10 +1500,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Env: description: | A list of environment variables to set inside the container in the @@ -1874,11 +1872,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -5764,10 +5761,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7125,7 +7121,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -7679,7 +7674,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -7785,17 +7780,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -7980,26 +7975,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8012,18 +8007,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8047,18 +8042,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8087,7 +8082,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8096,14 +8091,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8164,7 +8159,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8178,14 +8173,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8204,16 +8199,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8258,18 +8253,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8302,18 +8297,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8339,22 +8334,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8371,24 +8366,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8407,22 +8404,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8441,6 +8440,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -8450,23 +8451,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8482,6 +8483,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -8493,18 +8496,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8545,20 +8548,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8573,6 +8576,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -8586,16 +8591,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8605,6 +8610,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -8612,16 +8619,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8631,6 +8638,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8736,22 +8745,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8808,22 +8817,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8873,22 +8882,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8916,20 +8925,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8938,7 +8947,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8963,6 +8972,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8973,7 +8984,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -8981,18 +8992,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9012,22 +9023,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9052,27 +9064,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9128,7 +9140,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9143,7 +9155,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9156,13 +9168,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9401,13 +9413,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9465,7 +9477,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9480,7 +9492,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9496,13 +9508,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9553,10 +9565,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -9588,18 +9602,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9644,7 +9658,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -9674,11 +9688,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9718,13 +9732,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9783,21 +9797,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9828,7 +9842,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -9839,15 +9853,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9871,9 +9885,10 @@ paths: in: "query" description: | Select platform-specific content to delete. - Multiple values are accepted. + Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string. type: "array" + collectionFormat: "multi" items: # This should be OCIPlatform # but $ref is not supported for array in query in Swagger 2.0 @@ -9888,7 +9903,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9930,7 +9945,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9972,7 +9987,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9987,7 +10002,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10002,7 +10017,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -10021,13 +10036,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10045,11 +10060,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10061,11 +10076,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10075,9 +10090,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10115,7 +10131,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10133,7 +10149,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10161,7 +10177,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10175,18 +10191,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10258,15 +10274,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10305,7 +10321,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10411,7 +10427,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10453,12 +10469,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10497,20 +10513,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10537,9 +10554,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10576,22 +10593,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10688,13 +10705,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -10737,17 +10754,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10776,7 +10793,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10825,11 +10842,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10847,11 +10864,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10881,11 +10898,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10904,15 +10921,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10931,21 +10948,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -10987,17 +11004,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11012,6 +11029,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11031,7 +11050,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11046,7 +11065,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11065,7 +11084,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11125,7 +11144,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11158,15 +11177,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11191,17 +11210,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11211,6 +11230,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11222,25 +11243,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11339,21 +11360,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11392,17 +11413,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11445,7 +11466,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11456,7 +11477,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11468,13 +11489,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11497,7 +11518,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11516,7 +11537,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11541,9 +11562,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11598,15 +11619,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11624,15 +11645,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11657,13 +11678,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11686,13 +11707,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11716,13 +11737,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11770,6 +11791,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11778,9 +11801,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11798,6 +11821,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11814,13 +11839,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11847,33 +11872,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11897,19 +11924,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11924,17 +11951,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11955,21 +11982,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11997,19 +12024,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12022,21 +12049,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12125,17 +12152,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12201,13 +12228,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12225,17 +12252,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12276,7 +12303,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12287,11 +12314,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12318,13 +12345,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12334,17 +12361,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12377,27 +12404,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12492,19 +12519,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12524,17 +12551,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12552,23 +12579,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12669,23 +12696,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12740,7 +12767,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12857,11 +12884,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12889,19 +12916,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12926,23 +12953,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12997,7 +13024,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13027,11 +13054,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13059,19 +13086,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13100,7 +13127,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13121,15 +13148,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13146,17 +13173,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13172,21 +13199,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13220,7 +13247,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13234,11 +13261,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13265,19 +13292,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13301,7 +13328,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13314,15 +13341,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13339,17 +13366,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13365,21 +13392,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13415,18 +13442,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -13469,13 +13496,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.51.yaml b/_vendor/github.com/moby/moby/api/docs/v1.51.yaml index dc58b8080f..aa1e1cdcfd 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.51.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.51.yaml @@ -1361,10 +1361,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1504,10 +1503,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Env: description: | A list of environment variables to set inside the container in the @@ -1879,11 +1877,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } FilesystemChange: description: | @@ -5783,10 +5780,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7146,7 +7142,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -7700,7 +7695,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -7806,17 +7801,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8001,26 +7996,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8033,18 +8028,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8068,18 +8063,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8108,7 +8103,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8117,14 +8112,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8185,7 +8180,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8199,14 +8194,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8225,16 +8220,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8279,18 +8274,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8323,18 +8318,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8360,22 +8355,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8392,24 +8387,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8428,22 +8425,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8462,6 +8461,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -8471,23 +8472,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8503,6 +8504,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -8514,18 +8517,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8566,20 +8569,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8594,6 +8597,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -8607,16 +8612,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8626,6 +8631,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -8633,16 +8640,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8652,6 +8659,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -8757,22 +8766,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8829,22 +8838,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8894,22 +8903,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8937,20 +8946,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -8959,7 +8968,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8984,6 +8993,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -8994,7 +9005,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9002,18 +9013,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9033,22 +9044,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9073,27 +9085,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9149,7 +9161,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9164,7 +9176,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9177,13 +9189,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9422,13 +9434,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9486,7 +9498,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9501,7 +9513,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9517,13 +9529,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9574,10 +9586,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -9609,18 +9623,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9665,7 +9679,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -9695,11 +9709,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9739,13 +9753,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9804,21 +9818,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9849,7 +9863,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -9860,15 +9874,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9892,9 +9906,10 @@ paths: in: "query" description: | Select platform-specific content to delete. - Multiple values are accepted. + Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string. type: "array" + collectionFormat: "multi" items: # This should be OCIPlatform # but $ref is not supported for array in query in Swagger 2.0 @@ -9909,7 +9924,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -9951,7 +9966,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9993,7 +10008,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10008,7 +10023,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10023,7 +10038,7 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: type: "object" @@ -10042,13 +10057,13 @@ paths: application/json: Status: "Login Succeeded" IdentityToken: "9cbaf023786cd7..." - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10066,11 +10081,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10082,11 +10097,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10096,9 +10111,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10136,7 +10152,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10154,7 +10170,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10182,7 +10198,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10196,18 +10212,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10279,15 +10295,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10326,7 +10342,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10432,7 +10448,7 @@ paths: CreatedAt: "2021-06-28T13:31:03.002625487Z" LastUsedAt: "2021-07-07T22:02:32.773909517Z" UsageCount: 26 - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10474,12 +10490,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10518,20 +10534,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10558,9 +10575,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10597,22 +10614,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10709,13 +10726,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -10758,17 +10775,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10797,7 +10814,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10846,11 +10863,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10868,11 +10885,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10902,11 +10919,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10925,15 +10942,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10952,21 +10969,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11008,17 +11025,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11033,6 +11050,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11052,7 +11071,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11067,7 +11086,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11086,7 +11105,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11146,7 +11165,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11179,15 +11198,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Network" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11212,17 +11231,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11232,6 +11251,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11243,25 +11264,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11360,21 +11381,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11413,17 +11434,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11466,7 +11487,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11477,7 +11498,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11489,13 +11510,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11518,7 +11539,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11537,7 +11558,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11562,9 +11583,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11619,15 +11640,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11645,15 +11666,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11678,13 +11699,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11707,13 +11728,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11737,13 +11758,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11791,6 +11812,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11799,9 +11822,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11819,6 +11842,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11835,13 +11860,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11868,33 +11893,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11918,19 +11945,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11945,17 +11972,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11976,21 +12003,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12018,19 +12045,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12043,21 +12070,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12146,17 +12173,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12222,13 +12249,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12246,17 +12273,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12297,7 +12324,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12308,11 +12335,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12339,13 +12366,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12355,17 +12382,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12398,27 +12425,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12513,19 +12540,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12545,17 +12572,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12573,23 +12600,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12690,23 +12717,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12761,7 +12788,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12878,11 +12905,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12910,19 +12937,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12947,23 +12974,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13018,7 +13045,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13048,11 +13075,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13080,19 +13107,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13121,7 +13148,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13142,15 +13169,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13167,17 +13194,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13193,21 +13220,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13241,7 +13268,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13255,11 +13282,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13286,19 +13313,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13322,7 +13349,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13335,15 +13362,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13360,17 +13387,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13386,21 +13413,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13436,18 +13463,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -13490,13 +13517,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.52.yaml b/_vendor/github.com/moby/moby/api/docs/v1.52.yaml index 0d5abd151f..99413a54fc 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.52.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.52.yaml @@ -1370,10 +1370,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1506,10 +1505,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Env: description: | A list of environment variables to set inside the container in the @@ -1736,11 +1734,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } Storage: description: | @@ -6084,10 +6081,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7436,7 +7432,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -7990,7 +7985,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -8096,17 +8091,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8290,26 +8285,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8322,18 +8317,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8357,18 +8352,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8397,7 +8392,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8406,14 +8401,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8474,7 +8469,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8488,14 +8483,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8514,16 +8509,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8568,18 +8563,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8612,18 +8607,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8649,22 +8644,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8681,24 +8676,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8717,22 +8714,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8751,6 +8750,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -8760,23 +8761,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8792,6 +8793,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -8803,18 +8806,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8855,20 +8858,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8883,6 +8886,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -8896,16 +8901,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8915,6 +8920,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -8922,16 +8929,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8941,6 +8948,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -9046,22 +9055,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9118,22 +9127,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9183,22 +9192,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9226,20 +9235,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -9248,7 +9257,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9273,6 +9282,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -9283,7 +9294,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9291,18 +9302,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9322,22 +9333,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9362,27 +9374,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9438,7 +9450,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9453,7 +9465,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9466,13 +9478,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9711,13 +9723,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9766,7 +9778,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9781,7 +9793,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9797,13 +9809,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9854,10 +9866,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -9889,18 +9903,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9945,7 +9959,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -9975,11 +9989,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10019,13 +10033,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10084,21 +10098,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10129,7 +10143,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -10140,15 +10154,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10172,9 +10186,10 @@ paths: in: "query" description: | Select platform-specific content to delete. - Multiple values are accepted. + Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string. type: "array" + collectionFormat: "multi" items: # This should be OCIPlatform # but $ref is not supported for array in query in Swagger 2.0 @@ -10189,7 +10204,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10231,7 +10246,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10273,7 +10288,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10288,7 +10303,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10303,17 +10318,17 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: $ref: "#/definitions/AuthResponse" - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10331,11 +10346,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10347,11 +10362,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10361,9 +10376,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10401,7 +10417,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10419,7 +10435,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10447,7 +10463,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10461,18 +10477,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10545,15 +10561,15 @@ paths: - "application/x-ndjson" - "application/json-seq" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10592,7 +10608,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10606,7 +10622,7 @@ paths: $ref: "#/definitions/VolumesDiskUsage" BuildCacheUsage: $ref: "#/definitions/BuildCacheDiskUsage" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10654,12 +10670,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10701,20 +10717,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10744,9 +10761,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10786,22 +10803,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10898,13 +10915,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -10947,17 +10964,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10986,7 +11003,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11035,11 +11052,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11057,11 +11074,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11091,11 +11108,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11114,15 +11131,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11141,21 +11158,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11197,17 +11214,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11222,6 +11239,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11241,7 +11260,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11256,7 +11275,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11275,7 +11294,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11335,7 +11354,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11368,15 +11387,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/NetworkInspect" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11401,17 +11420,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11421,6 +11440,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11432,25 +11453,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11549,21 +11570,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11587,17 +11608,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11630,7 +11651,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11641,7 +11662,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11653,13 +11674,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11682,7 +11703,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11701,7 +11722,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11726,9 +11747,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11783,15 +11804,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11809,15 +11830,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11842,13 +11863,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11871,13 +11892,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11901,13 +11922,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11955,6 +11976,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -11963,9 +11986,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11983,6 +12006,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -11999,13 +12024,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12032,33 +12057,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12082,19 +12109,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12109,17 +12136,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12140,21 +12167,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12182,19 +12209,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12207,21 +12234,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12310,17 +12337,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12386,13 +12413,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12410,17 +12437,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12461,7 +12488,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12472,11 +12499,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12503,13 +12530,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12519,17 +12546,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12562,27 +12589,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12677,19 +12704,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12709,17 +12736,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12737,23 +12764,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12854,23 +12881,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12925,7 +12952,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13042,11 +13069,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13074,19 +13101,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13111,23 +13138,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13182,7 +13209,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13212,11 +13239,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13244,19 +13271,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13285,7 +13312,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13306,15 +13333,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13331,17 +13358,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13357,21 +13384,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13405,7 +13432,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13419,11 +13446,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13450,19 +13477,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13486,7 +13513,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13499,15 +13526,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13524,17 +13551,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13550,21 +13577,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13600,18 +13627,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -13654,13 +13681,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.53.yaml b/_vendor/github.com/moby/moby/api/docs/v1.53.yaml index cd91f9f0f0..15ad3ac182 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.53.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.53.yaml @@ -1370,10 +1370,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1506,10 +1505,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Env: description: | A list of environment variables to set inside the container in the @@ -1736,11 +1734,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } Storage: description: | @@ -6330,10 +6327,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7684,7 +7680,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -8238,7 +8233,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -8344,17 +8339,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8538,26 +8533,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8570,18 +8565,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8605,18 +8600,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8645,7 +8640,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8654,14 +8649,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8722,7 +8717,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8736,14 +8731,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8762,16 +8757,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8816,18 +8811,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8860,18 +8855,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8897,22 +8892,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8929,24 +8924,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8965,22 +8962,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8999,6 +8998,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -9008,23 +9009,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9040,6 +9041,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -9051,18 +9054,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9103,20 +9106,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9131,6 +9134,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -9144,16 +9149,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9163,6 +9168,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -9170,16 +9177,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9189,6 +9196,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -9294,22 +9303,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9366,22 +9375,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9431,22 +9440,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9474,20 +9483,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -9496,7 +9505,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9521,6 +9530,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -9531,7 +9542,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9539,18 +9550,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9570,22 +9581,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9610,27 +9622,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9686,7 +9698,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9701,7 +9713,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9714,13 +9726,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9959,13 +9971,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10014,7 +10026,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10029,7 +10041,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10045,13 +10057,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10102,10 +10114,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10137,18 +10151,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10193,7 +10207,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -10223,11 +10237,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10267,13 +10281,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10332,21 +10346,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10377,7 +10391,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -10388,15 +10402,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10420,9 +10434,10 @@ paths: in: "query" description: | Select platform-specific content to delete. - Multiple values are accepted. + Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string. type: "array" + collectionFormat: "multi" items: # This should be OCIPlatform # but $ref is not supported for array in query in Swagger 2.0 @@ -10437,7 +10452,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10479,7 +10494,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10521,7 +10536,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10536,7 +10551,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10551,17 +10566,17 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: $ref: "#/definitions/AuthResponse" - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10579,11 +10594,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10595,11 +10610,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10609,9 +10624,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10649,7 +10665,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10667,7 +10683,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10695,7 +10711,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10709,18 +10725,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10794,15 +10810,15 @@ paths: - "application/x-ndjson" - "application/json-seq" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10841,7 +10857,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10855,7 +10871,7 @@ paths: $ref: "#/definitions/VolumesDiskUsage" BuildCacheUsage: $ref: "#/definitions/BuildCacheDiskUsage" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10903,12 +10919,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10950,20 +10966,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10993,9 +11010,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11035,22 +11052,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11147,13 +11164,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -11196,17 +11213,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11235,7 +11252,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11284,11 +11301,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11306,11 +11323,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11340,11 +11357,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11363,15 +11380,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11390,21 +11407,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11446,17 +11463,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11471,6 +11488,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11490,7 +11509,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11505,7 +11524,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11524,7 +11543,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11584,7 +11603,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11617,15 +11636,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/NetworkInspect" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11650,17 +11669,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11670,6 +11689,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11681,25 +11702,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11798,21 +11819,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11836,17 +11857,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11879,7 +11900,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11890,7 +11911,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11902,13 +11923,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11931,7 +11952,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11950,7 +11971,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11975,9 +11996,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12032,15 +12053,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12058,15 +12079,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12091,13 +12112,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12120,13 +12141,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12150,13 +12171,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12204,6 +12225,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -12212,9 +12235,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12232,6 +12255,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -12248,13 +12273,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12281,33 +12306,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12331,19 +12358,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12358,17 +12385,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12389,21 +12416,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12431,19 +12458,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12456,21 +12483,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12559,17 +12586,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12635,13 +12662,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12659,17 +12686,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12710,7 +12737,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12721,11 +12748,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12752,13 +12779,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12768,17 +12795,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12811,27 +12838,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12926,19 +12953,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12958,17 +12985,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12986,23 +13013,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13103,23 +13130,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13174,7 +13201,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13291,11 +13318,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13323,19 +13350,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13360,23 +13387,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13431,7 +13458,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13461,11 +13488,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13493,19 +13520,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13534,7 +13561,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13555,15 +13582,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13580,17 +13607,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13606,21 +13633,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13654,7 +13681,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13668,11 +13695,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13699,19 +13726,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13735,7 +13762,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13748,15 +13775,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13773,17 +13800,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13799,21 +13826,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13849,18 +13876,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -13906,13 +13933,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.54.yaml b/_vendor/github.com/moby/moby/api/docs/v1.54.yaml index 2d4c6e62a0..b20d578f07 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.54.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.54.yaml @@ -1370,10 +1370,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1506,10 +1505,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Env: description: | A list of environment variables to set inside the container in the @@ -1736,11 +1734,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } Storage: description: | @@ -6330,10 +6327,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7684,7 +7680,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -8238,7 +8233,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -8351,17 +8346,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8545,26 +8540,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8577,18 +8572,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8612,18 +8607,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8652,7 +8647,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8661,14 +8656,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8729,7 +8724,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8743,14 +8738,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8769,16 +8764,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8823,18 +8818,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8867,18 +8862,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8904,22 +8899,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8936,24 +8931,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8972,22 +8969,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9006,6 +9005,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -9015,23 +9016,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9047,6 +9048,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -9058,18 +9061,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9110,20 +9113,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9138,6 +9141,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -9151,16 +9156,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9170,6 +9175,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -9177,16 +9184,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9196,6 +9203,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -9301,22 +9310,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9373,22 +9382,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9438,22 +9447,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9481,20 +9490,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -9503,7 +9512,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9528,6 +9537,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -9538,7 +9549,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9546,18 +9557,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9577,22 +9588,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9617,27 +9629,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9693,7 +9705,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9708,7 +9720,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9721,13 +9733,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9971,13 +9983,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10026,7 +10038,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10041,7 +10053,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10057,13 +10069,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10114,10 +10126,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10149,18 +10163,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10205,7 +10219,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -10235,11 +10249,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10279,13 +10293,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10344,21 +10358,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10389,7 +10403,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -10400,15 +10414,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10432,9 +10446,10 @@ paths: in: "query" description: | Select platform-specific content to delete. - Multiple values are accepted. + Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string. type: "array" + collectionFormat: "multi" items: # This should be OCIPlatform # but $ref is not supported for array in query in Swagger 2.0 @@ -10449,7 +10464,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10491,7 +10506,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10533,7 +10548,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10548,7 +10563,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10563,17 +10578,17 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: $ref: "#/definitions/AuthResponse" - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10591,11 +10606,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10607,11 +10622,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10621,9 +10636,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10661,7 +10677,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10679,7 +10695,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10707,7 +10723,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10721,18 +10737,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10806,15 +10822,15 @@ paths: - "application/x-ndjson" - "application/json-seq" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10853,7 +10869,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10867,7 +10883,7 @@ paths: $ref: "#/definitions/VolumesDiskUsage" BuildCacheUsage: $ref: "#/definitions/BuildCacheDiskUsage" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10915,12 +10931,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10962,20 +10978,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -11005,9 +11022,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11047,22 +11064,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11159,13 +11176,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -11208,17 +11225,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11247,7 +11264,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11296,11 +11313,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11318,11 +11335,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11352,11 +11369,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11375,15 +11392,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11402,21 +11419,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11458,17 +11475,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11483,6 +11500,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11502,7 +11521,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11517,7 +11536,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11536,7 +11555,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11596,7 +11615,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11629,15 +11648,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/NetworkInspect" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11662,17 +11681,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11682,6 +11701,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11693,25 +11714,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11810,21 +11831,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11848,17 +11869,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11891,7 +11912,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11902,7 +11923,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11914,13 +11935,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11943,7 +11964,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -11962,7 +11983,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11987,9 +12008,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12044,15 +12065,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12070,15 +12091,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12103,13 +12124,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12132,13 +12153,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12162,13 +12183,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12216,6 +12237,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -12224,9 +12247,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12244,6 +12267,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -12260,13 +12285,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12293,33 +12318,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12343,19 +12370,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12370,17 +12397,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12401,21 +12428,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12443,19 +12470,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12468,21 +12495,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12571,17 +12598,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12647,13 +12674,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12671,17 +12698,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12722,7 +12749,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12733,11 +12760,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12764,13 +12791,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12780,17 +12807,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12823,27 +12850,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12938,19 +12965,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12970,17 +12997,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12998,23 +13025,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13115,23 +13142,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13186,7 +13213,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13303,11 +13330,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13335,19 +13362,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13372,23 +13399,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13443,7 +13470,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13473,11 +13500,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13505,19 +13532,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13546,7 +13573,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13567,15 +13594,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13592,17 +13619,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13618,21 +13645,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13666,7 +13693,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13680,11 +13707,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13711,19 +13738,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13747,7 +13774,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13760,15 +13787,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13785,17 +13812,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13811,21 +13838,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13861,18 +13888,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -13918,13 +13945,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.55.yaml b/_vendor/github.com/moby/moby/api/docs/v1.55.yaml index 04e71dc43c..fcfd3c627a 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.55.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.55.yaml @@ -1370,10 +1370,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1506,10 +1505,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Env: description: | A list of environment variables to set inside the container in the @@ -1736,11 +1734,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } Storage: description: | @@ -6330,10 +6327,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7684,7 +7680,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -8257,7 +8252,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -8370,17 +8365,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8564,26 +8559,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8596,18 +8591,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8631,18 +8626,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8671,7 +8666,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8680,14 +8675,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8748,7 +8743,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8762,14 +8757,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8788,16 +8783,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8842,18 +8837,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8886,18 +8881,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8923,22 +8918,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8955,24 +8950,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8991,22 +8988,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9025,6 +9024,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -9034,23 +9035,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9066,6 +9067,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -9077,18 +9080,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9129,20 +9132,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9157,6 +9160,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -9170,16 +9175,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9189,6 +9194,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -9196,16 +9203,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9215,6 +9222,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -9320,22 +9329,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9392,22 +9401,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9457,22 +9466,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9500,20 +9509,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -9522,7 +9531,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9547,6 +9556,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -9557,7 +9568,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9565,18 +9576,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9596,22 +9607,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9636,27 +9648,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9712,7 +9724,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9727,7 +9739,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9740,13 +9752,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9990,13 +10002,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10045,7 +10057,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10060,7 +10072,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10076,13 +10088,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10133,10 +10145,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10168,18 +10182,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10232,25 +10246,25 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/AttestationStatement" - 400: + "400": description: "Bad parameter (e.g. malformed `platform` value)" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image, or no manifest found for the requested platform" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" - 501: + "501": description: | The daemon's image backend does not support attestations. This is returned by the legacy (graphdriver) image store, which does @@ -10312,7 +10326,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -10342,11 +10356,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10386,13 +10400,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10451,21 +10465,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10496,7 +10510,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -10507,15 +10521,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10539,9 +10553,10 @@ paths: in: "query" description: | Select platform-specific content to delete. - Multiple values are accepted. + Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string. type: "array" + collectionFormat: "multi" items: # This should be OCIPlatform # but $ref is not supported for array in query in Swagger 2.0 @@ -10556,7 +10571,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10598,7 +10613,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10640,7 +10655,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10655,7 +10670,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10670,17 +10685,17 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: $ref: "#/definitions/AuthResponse" - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10698,11 +10713,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10714,11 +10729,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10728,9 +10743,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10768,7 +10784,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10786,7 +10802,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10814,7 +10830,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10828,18 +10844,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10913,15 +10929,15 @@ paths: - "application/x-ndjson" - "application/json-seq" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10960,7 +10976,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10974,7 +10990,7 @@ paths: $ref: "#/definitions/VolumesDiskUsage" BuildCacheUsage: $ref: "#/definitions/BuildCacheDiskUsage" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11022,12 +11038,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11069,20 +11085,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -11112,9 +11129,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11154,22 +11171,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11266,13 +11283,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -11315,17 +11332,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11354,7 +11371,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11403,11 +11420,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11425,11 +11442,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11459,11 +11476,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11482,15 +11499,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11509,21 +11526,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11565,17 +11582,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11590,6 +11607,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11609,7 +11628,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11624,7 +11643,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11643,7 +11662,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11703,7 +11722,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11736,15 +11755,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/NetworkInspect" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11769,17 +11788,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11789,6 +11808,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11800,25 +11821,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11917,21 +11938,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11955,17 +11976,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11998,7 +12019,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -12009,7 +12030,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12021,13 +12042,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12050,7 +12071,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12069,7 +12090,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12094,9 +12115,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12151,15 +12172,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12177,15 +12198,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12210,13 +12231,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12239,13 +12260,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12269,13 +12290,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12323,6 +12344,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -12331,9 +12354,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12351,6 +12374,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -12367,13 +12392,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12400,33 +12425,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12450,19 +12477,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12477,17 +12504,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12508,21 +12535,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12550,19 +12577,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12575,21 +12602,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12678,17 +12705,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12754,13 +12781,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12778,17 +12805,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12829,7 +12856,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12840,11 +12867,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12871,13 +12898,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12887,17 +12914,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12930,27 +12957,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13045,19 +13072,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13077,17 +13104,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13105,23 +13132,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13222,23 +13249,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13293,7 +13320,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13410,11 +13437,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13442,19 +13469,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13479,23 +13506,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13550,7 +13577,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13580,11 +13607,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13612,19 +13639,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13653,7 +13680,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13674,15 +13701,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13699,17 +13726,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13725,21 +13752,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13773,7 +13800,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13787,11 +13814,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13818,19 +13845,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13854,7 +13881,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13867,15 +13894,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13892,17 +13919,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13918,21 +13945,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13968,18 +13995,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -14025,13 +14052,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/github.com/moby/moby/api/docs/v1.56.yaml b/_vendor/github.com/moby/moby/api/docs/v1.56.yaml index 8ed37b2501..8c4d51989f 100644 --- a/_vendor/github.com/moby/moby/api/docs/v1.56.yaml +++ b/_vendor/github.com/moby/moby/api/docs/v1.56.yaml @@ -1382,10 +1382,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Tty: description: | Attach standard streams to a TTY, including `stdin` if it is not closed. @@ -1518,10 +1517,9 @@ definitions: enum: - {} default: {} - example: { - "80/tcp": {}, + example: + "80/tcp": {} "443/tcp": {} - } Env: description: | A list of environment variables to set inside the container in the @@ -1748,11 +1746,10 @@ definitions: x-nullable: false additionalProperties: type: "string" - example: { - "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", - "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + example: + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged" + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff" "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" - } Storage: description: | @@ -6353,10 +6350,9 @@ definitions: items: $ref: "#/definitions/ContainerBlkioStatEntry" example: - io_service_bytes_recursive: [ - {"major": 254, "minor": 0, "op": "read", "value": 7593984}, - {"major": 254, "minor": 0, "op": "write", "value": 100} - ] + io_service_bytes_recursive: + - {"major": 254, "minor": 0, "op": "read", "value": 7593984} + - {"major": 254, "minor": 0, "op": "write", "value": 100} io_serviced_recursive: null io_queue_recursive: null io_service_time_recursive: null @@ -7707,7 +7703,6 @@ definitions: description: | List of ID's and addresses of other managers in the swarm. type: "array" - default: null x-nullable: true items: $ref: "#/definitions/PeerNode" @@ -8280,7 +8275,7 @@ definitions: type: "object" x-nullable: true x-omitempty: true - required: ["Platform", "Containers", "Size", "UnpackedSize"] + required: ["Platform", "Containers", "Size"] properties: Platform: $ref: "#/definitions/OCIPlatform" @@ -8394,17 +8389,17 @@ paths: - `volume`=(`` or ``) type: "string" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/ContainerSummary" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8588,26 +8583,26 @@ paths: required: true responses: - 201: + "201": description: "Container created successfully" schema: $ref: "#/definitions/ContainerCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8620,18 +8615,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerInspectResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8655,18 +8650,18 @@ paths: is not supported on Windows. operationId: "ContainerTop" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerTopResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8695,7 +8690,7 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ContainerLogs" responses: - 200: + "200": description: | logs returned as a stream in response body. For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). @@ -8704,14 +8699,14 @@ paths: schema: type: "string" format: "binary" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8772,7 +8767,7 @@ paths: operationId: "ContainerChanges" produces: ["application/json"] responses: - 200: + "200": description: "The list of changes" schema: type: "array" @@ -8786,14 +8781,14 @@ paths: Kind: 1 - Path: "/test" Kind: 1 - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8812,16 +8807,16 @@ paths: produces: - "application/octet-stream" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8866,18 +8861,18 @@ paths: operationId: "ContainerStats" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ContainerStatsResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8910,18 +8905,18 @@ paths: consumes: - "application/octet-stream" produces: - - "text/plain" + - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "cannot resize container" schema: $ref: "#/definitions/ErrorResponse" @@ -8947,22 +8942,22 @@ paths: summary: "Start a container" operationId: "ContainerStart" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already started" - 400: + "400": description: "bad parameter, including an invalid checkpoint ID" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -8979,24 +8974,26 @@ paths: single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/stop: post: summary: "Stop a container" operationId: "ContainerStop" responses: - 204: + "204": description: "no error" - 304: + "304": description: "container already stopped" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9015,22 +9012,24 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/restart: post: summary: "Restart a container" operationId: "ContainerRestart" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9049,6 +9048,8 @@ paths: in: "query" description: "Number of seconds to wait before killing the container" type: "integer" + produces: + - "application/json" tags: ["Container"] /containers/{id}/kill: post: @@ -9058,23 +9059,23 @@ paths: container. operationId: "ContainerKill" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is not running" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9090,6 +9091,8 @@ paths: Signal to send to the container as an integer or string (e.g. `SIGINT`). type: "string" default: "SIGKILL" + produces: + - "application/json" tags: ["Container"] /containers/{id}/update: post: @@ -9101,18 +9104,18 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "The container has been updated." schema: $ref: "#/definitions/ContainerUpdateResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9153,20 +9156,20 @@ paths: summary: "Rename a container" operationId: "ContainerRename" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "name already in use" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9181,6 +9184,8 @@ paths: required: true description: "New name for the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/pause: post: @@ -9194,16 +9199,16 @@ paths: suspended, and subsequently resumed. operationId: "ContainerPause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9213,6 +9218,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/unpause: post: @@ -9220,16 +9227,16 @@ paths: description: "Resume a container which has been paused." operationId: "ContainerUnpause" responses: - 204: + "204": description: "no error" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9239,6 +9246,8 @@ paths: required: true description: "ID or name of the container" type: "string" + produces: + - "application/json" tags: ["Container"] /containers/{id}/attach: post: @@ -9344,22 +9353,22 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9416,22 +9425,22 @@ paths: summary: "Attach to a container via a websocket" operationId: "ContainerAttachWebsocket" responses: - 101: + "101": description: "no error, hints proxy about hijacking" - 200: + "200": description: "no error, no upgrade header found" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9481,22 +9490,22 @@ paths: operationId: "ContainerWait" produces: ["application/json"] responses: - 200: + "200": description: "The container has exit." schema: $ref: "#/definitions/ContainerWaitResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9524,20 +9533,20 @@ paths: summary: "Remove a container" operationId: "ContainerDelete" responses: - 204: + "204": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "conflict" schema: $ref: "#/definitions/ErrorResponse" @@ -9546,7 +9555,7 @@ paths: message: | You cannot remove a running container: c2ada9df5af8. Stop the container before attempting removal or force remove - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9571,6 +9580,8 @@ paths: description: "Remove the specified link associated with the container." type: "boolean" default: false + produces: + - "application/json" tags: ["Container"] /containers/{id}/archive: head: @@ -9581,7 +9592,7 @@ paths: about the path. operationId: "ContainerArchiveInfo" responses: - 200: + "200": description: "no error" headers: X-Docker-Container-Path-Stat: @@ -9589,18 +9600,18 @@ paths: description: | A base64 - encoded JSON object with some filesystem header information about the path - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9620,22 +9631,23 @@ paths: summary: "Get an archive of a filesystem resource in a container" description: "Get a tar archive of a resource in the filesystem of container id." operationId: "ContainerArchive" - produces: ["application/x-tar"] + produces: + - "application/x-tar" responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Container or path does not exist" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9660,27 +9672,27 @@ paths: operationId: "PutContainerArchive" consumes: ["application/x-tar", "application/octet-stream"] responses: - 200: + "200": description: "The content was extracted successfully" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "not a directory" - 403: + "403": description: "Permission denied, the volume or container rootfs is marked as read-only." schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such container or path does not exist inside the container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9736,7 +9748,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -9751,7 +9763,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -9764,13 +9776,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "Summary image data for the images matching the query" schema: type: "array" items: $ref: "#/definitions/ImageSummary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10014,13 +10026,13 @@ paths: - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) - `2` is [BuildKit](https://github.com/moby/buildkit) responses: - 200: + "200": description: "no error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10069,7 +10081,7 @@ paths: - `shared` - `private` responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10084,7 +10096,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10100,13 +10112,13 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 404: + "404": description: "repository does not exist or no read access" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10157,10 +10169,12 @@ paths: Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. + Repeat the parameter to apply multiple instructions. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -10192,18 +10206,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/ImageInspect" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10256,25 +10270,25 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/AttestationStatement" - 400: + "400": description: "Bad parameter (e.g. malformed `platform` value)" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image, or no manifest found for the requested platform" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" - 501: + "501": description: | The daemon's image backend does not support attestations. This is returned by the legacy (graphdriver) image store, which does @@ -10336,7 +10350,7 @@ paths: operationId: "ImageHistory" produces: ["application/json"] responses: - 200: + "200": description: "List of image layers" schema: type: "array" @@ -10366,11 +10380,11 @@ paths: - "scratch:latest" Size: 0 Comment: "Imported from -" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10410,13 +10424,13 @@ paths: consumes: - "application/octet-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10475,21 +10489,21 @@ paths: or tag already exists, it will be overwritten. operationId: "ImageTag" responses: - 201: + "201": description: "No error" - 400: + "400": description: "Bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10520,7 +10534,7 @@ paths: operationId: "ImageDelete" produces: ["application/json"] responses: - 200: + "200": description: "The image was deleted successfully" schema: type: "array" @@ -10531,15 +10545,15 @@ paths: - Untagged: "3e2f21a89f" - Deleted: "3e2f21a89f" - Deleted: "53b4f83ac9" - 404: + "404": description: "No such image" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Conflict" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10563,9 +10577,10 @@ paths: in: "query" description: | Select platform-specific content to delete. - Multiple values are accepted. + Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string. type: "array" + collectionFormat: "multi" items: # This should be OCIPlatform # but $ref is not supported for array in query in Swagger 2.0 @@ -10580,7 +10595,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -10622,7 +10637,7 @@ paths: is_automated: false name: "postgres" star_count: 12408 - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10664,7 +10679,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -10679,7 +10694,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10694,17 +10709,17 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "An identity token was generated successfully." schema: $ref: "#/definitions/AuthResponse" - 204: + "204": description: "No error" - 401: + "401": description: "Auth error" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10722,11 +10737,11 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/SystemInfo" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10738,11 +10753,11 @@ paths: operationId: "SystemVersion" produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/SystemVersion" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10752,9 +10767,10 @@ paths: summary: "Ping" description: "This is a dummy endpoint you can use to test if the server is accessible." operationId: "SystemPing" - produces: ["text/plain"] + produces: + - "text/plain" responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10792,7 +10808,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10810,7 +10826,7 @@ paths: operationId: "SystemPingHead" produces: ["text/plain"] responses: - 200: + "200": description: "no error" schema: type: "string" @@ -10838,7 +10854,7 @@ paths: Pragma: type: "string" default: "no-cache" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10852,18 +10868,18 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10937,15 +10953,15 @@ paths: - "application/x-ndjson" - "application/json-seq" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/EventMessage" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -10984,7 +11000,7 @@ paths: summary: "Get data usage information" operationId: "SystemDataUsage" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -10998,7 +11014,7 @@ paths: $ref: "#/definitions/VolumesDiskUsage" BuildCacheUsage: $ref: "#/definitions/BuildCacheDiskUsage" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11046,12 +11062,12 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11093,20 +11109,21 @@ paths: produces: - "application/x-tar" responses: - 200: + "200": description: "no error" schema: type: "string" format: "binary" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" parameters: - name: "names" in: "query" - description: "Image names to filter by" + description: "Image names to filter by. Repeat the parameter for multiple images." type: "array" + collectionFormat: "multi" items: type: "string" - name: "platform" @@ -11136,9 +11153,9 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11178,22 +11195,22 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 404: + "404": description: "no such container" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such container: c2ada9df5af8" - 409: + "409": description: "container is paused" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11290,13 +11307,13 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "No error" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Container is stopped or paused" schema: $ref: "#/definitions/ErrorResponse" @@ -11339,17 +11356,17 @@ paths: if `tty` was specified as part of creating and starting the exec instance. operationId: "ExecResize" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11378,7 +11395,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11427,11 +11444,11 @@ paths: user: "1000" Running: false Pid: 42000 - 404: + "404": description: "No such exec instance" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11449,11 +11466,11 @@ paths: operationId: "VolumeList" produces: ["application/json"] responses: - 200: + "200": description: "Summary volume data that matches the query" schema: $ref: "#/definitions/VolumeListResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11483,11 +11500,11 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 201: + "201": description: "The volume was created successfully" schema: $ref: "#/definitions/Volume" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11506,15 +11523,15 @@ paths: operationId: "VolumeInspect" produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/Volume" - 404: + "404": description: "No such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11533,21 +11550,21 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such volume" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -11589,17 +11606,17 @@ paths: description: "Instruct the driver to remove the volume." operationId: "VolumeDelete" responses: - 204: + "204": description: "The volume was removed" - 404: + "404": description: "No such volume or volume driver" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "Volume is in use and cannot be removed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11614,6 +11631,8 @@ paths: description: "Force the removal of the volume" type: "boolean" default: false + produces: + - "application/json" tags: ["Volume"] /volumes/prune: @@ -11633,7 +11652,7 @@ paths: - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -11648,7 +11667,7 @@ paths: description: "Disk space reclaimed in bytes" type: "integer" format: "int64" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11667,7 +11686,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: type: "array" @@ -11727,7 +11746,7 @@ paths: Config: [] Containers: {} Options: {} - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11760,15 +11779,15 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "No error" schema: $ref: "#/definitions/NetworkInspect" - 404: + "404": description: "Network not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11793,17 +11812,17 @@ paths: summary: "Remove a network" operationId: "NetworkDelete" responses: - 204: + "204": description: "No error" - 403: + "403": description: "operation not supported for pre-defined networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such network" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11813,6 +11832,8 @@ paths: description: "Network ID or name" required: true type: "string" + produces: + - "application/json" tags: ["Network"] /networks/create: @@ -11824,25 +11845,25 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "Network created successfully" schema: $ref: "#/definitions/NetworkCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: | Forbidden operation. This happens when trying to create a network named after a pre-defined network, or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "plugin not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11941,21 +11962,21 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "Operation forbidden" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -11979,17 +12000,17 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "No error" - 403: + "403": description: "Operation not supported for swarm scoped networks" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "Network or container not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12022,7 +12043,7 @@ paths: - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. type: "string" responses: - 200: + "200": description: "No error" schema: type: "object" @@ -12033,7 +12054,7 @@ paths: type: "array" items: type: "string" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12045,13 +12066,13 @@ paths: description: "Returns information about installed plugins." produces: ["application/json"] responses: - 200: + "200": description: "No error" schema: type: "array" items: $ref: "#/definitions/Plugin" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12074,7 +12095,7 @@ paths: summary: "Get plugin privileges" operationId: "GetPluginPrivileges" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -12093,7 +12114,7 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12118,9 +12139,9 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12175,15 +12196,15 @@ paths: summary: "Inspect a plugin" operationId: "PluginInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12201,15 +12222,15 @@ paths: summary: "Remove a plugin" operationId: "PluginDelete" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Plugin" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12234,13 +12255,13 @@ paths: summary: "Enable a plugin" operationId: "PluginEnable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12263,13 +12284,13 @@ paths: summary: "Disable a plugin" operationId: "PluginDisable" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin is not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12293,13 +12314,13 @@ paths: summary: "Upgrade a plugin" operationId: "PluginUpgrade" responses: - 204: + "204": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12347,6 +12368,8 @@ paths: Description: "" Value: - "/dev/cpu_dma_latency" + produces: + - "application/json" tags: ["Plugin"] /plugins/create: post: @@ -12355,9 +12378,9 @@ paths: consumes: - "application/x-tar" responses: - 204: + "204": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12375,6 +12398,8 @@ paths: schema: type: "string" format: "binary" + produces: + - "application/json" tags: ["Plugin"] /plugins/{name}/push: post: @@ -12391,13 +12416,13 @@ paths: required: true type: "string" responses: - 200: + "200": description: "no error" - 404: + "404": description: "plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" @@ -12424,33 +12449,35 @@ paths: type: "string" example: ["DEBUG=1"] responses: - 204: + "204": description: "No error" - 404: + "404": description: "Plugin not installed" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" + produces: + - "application/json" tags: ["Plugin"] /nodes: get: summary: "List nodes" operationId: "NodeList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Node" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12474,19 +12501,19 @@ paths: summary: "Inspect a node" operationId: "NodeInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Node" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12501,17 +12528,17 @@ paths: summary: "Delete a node" operationId: "NodeDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12532,21 +12559,21 @@ paths: summary: "Update a node" operationId: "NodeUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such node" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12574,19 +12601,19 @@ paths: summary: "Inspect swarm" operationId: "SwarmInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Swarm" - 404: + "404": description: "no such swarm" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12599,21 +12626,21 @@ paths: - "application/json" - "text/plain" responses: - 200: + "200": description: "no error" schema: description: "The node ID" type: "string" example: "7v2t30z9blmxuhnyo6s4cpenp" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12702,17 +12729,17 @@ paths: summary: "Join an existing swarm" operationId: "SwarmJoin" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is already part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12778,13 +12805,13 @@ paths: summary: "Leave a swarm" operationId: "SwarmLeave" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12802,17 +12829,17 @@ paths: summary: "Update a swarm" operationId: "SwarmUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12853,7 +12880,7 @@ paths: consumes: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "object" @@ -12864,11 +12891,11 @@ paths: type: "string" example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12895,13 +12922,13 @@ paths: example: UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" responses: - 200: + "200": description: "no error" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12911,17 +12938,17 @@ paths: summary: "List services" operationId: "ServiceList" responses: - 200: + "200": description: "no error" schema: type: "array" items: $ref: "#/definitions/Service" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -12954,27 +12981,27 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/ServiceCreateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 403: + "403": description: "network is not eligible for services" schema: $ref: "#/definitions/ErrorResponse" - 409: + "409": description: "name conflicts with an existing service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13069,19 +13096,19 @@ paths: summary: "Inspect a service" operationId: "ServiceInspect" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Service" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13101,17 +13128,17 @@ paths: summary: "Delete a service" operationId: "ServiceDelete" responses: - 200: + "200": description: "no error" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13129,23 +13156,23 @@ paths: consumes: ["application/json"] produces: ["application/json"] responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/ServiceUpdateResponse" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13246,23 +13273,23 @@ paths: - "application/vnd.docker.multiplexed-stream" operationId: "ServiceLogs" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such service" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such service: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13317,7 +13344,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13434,11 +13461,11 @@ paths: Gateway: "10.255.0.1" Addresses: - "10.255.0.5/16" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13466,19 +13493,19 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Task" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13503,23 +13530,23 @@ paths: - "application/vnd.docker.raw-stream" - "application/vnd.docker.multiplexed-stream" responses: - 200: + "200": description: "logs returned as a stream in response body" schema: type: "string" format: "binary" - 404: + "404": description: "no such task" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such task: c2ada9df5af8" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13574,7 +13601,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13604,11 +13631,11 @@ paths: Name: "app-dev.crt" Labels: foo: "bar" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13636,19 +13663,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13677,7 +13704,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Secret" @@ -13698,15 +13725,15 @@ paths: OptionA: "value for driver option A" OptionB: "value for driver option B" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13723,17 +13750,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "secret not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13749,21 +13776,21 @@ paths: summary: "Update a Secret" operationId: "SecretUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such secret" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13797,7 +13824,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: type: "array" @@ -13811,11 +13838,11 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "server.conf" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13842,19 +13869,19 @@ paths: produces: - "application/json" responses: - 201: + "201": description: "no error" schema: $ref: "#/definitions/IDResponse" - 409: + "409": description: "name conflicts with an existing object" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13878,7 +13905,7 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "no error" schema: $ref: "#/definitions/Config" @@ -13891,15 +13918,15 @@ paths: UpdatedAt: "2016-11-05T01:20:17.327670065Z" Spec: Name: "app-dev.crt" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13916,17 +13943,17 @@ paths: produces: - "application/json" responses: - 204: + "204": description: "no error" - 404: + "404": description: "config not found" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13942,21 +13969,21 @@ paths: summary: "Update a Config" operationId: "ConfigUpdate" responses: - 200: + "200": description: "no error" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 404: + "404": description: "no such config" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" - 503: + "503": description: "node is not part of a swarm" schema: $ref: "#/definitions/ErrorResponse" @@ -13992,18 +14019,18 @@ paths: produces: - "application/json" responses: - 200: + "200": description: "descriptor and platform information" schema: $ref: "#/definitions/DistributionInspect" - 401: + "401": description: "Failed authentication or no image found" schema: $ref: "#/definitions/ErrorResponse" examples: application/json: message: "No such image: someimage (tag: latest)" - 500: + "500": description: "Server error" schema: $ref: "#/definitions/ErrorResponse" @@ -14049,13 +14076,13 @@ paths: produces: - "application/vnd.docker.raw-stream" responses: - 101: + "101": description: "no error, hijacking successful" - 400: + "400": description: "bad parameter" schema: $ref: "#/definitions/ErrorResponse" - 500: + "500": description: "server error" schema: $ref: "#/definitions/ErrorResponse" diff --git a/_vendor/modules.txt b/_vendor/modules.txt index dda9cfc760..8aee7a79e4 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,7 +1,7 @@ -# github.com/moby/moby/api v1.56.0 +# github.com/moby/moby/api v1.56.1 # github.com/moby/buildkit v0.33.1 # github.com/docker/buildx v0.37.2 -# github.com/docker/cli v29.7.2+incompatible -# github.com/docker/compose/v5 v5.5.1 +# github.com/docker/cli v29.8.2+incompatible +# github.com/docker/compose/v5 v5.6.0 # github.com/docker/model-runner v1.1.36 # github.com/docker/docker-agent v1.126.0 diff --git a/go.mod b/go.mod index 9c06e21fb7..da2637f5d3 100644 --- a/go.mod +++ b/go.mod @@ -9,12 +9,12 @@ go 1.26.8 // Make sure to add an entry in the "tools" section when adding a new repository. require ( github.com/docker/buildx v0.37.2 - github.com/docker/cli v29.7.2+incompatible - github.com/docker/compose/v5 v5.5.1 + github.com/docker/cli v29.8.2+incompatible + github.com/docker/compose/v5 v5.6.0 github.com/docker/docker-agent v1.126.0 github.com/docker/model-runner v1.1.36 github.com/moby/buildkit v0.33.1 - github.com/moby/moby/api v1.56.0 + github.com/moby/moby/api v1.56.1 ) tool ( diff --git a/go.sum b/go.sum index c296244834..6bc7b4b580 100644 --- a/go.sum +++ b/go.sum @@ -129,6 +129,8 @@ github.com/docker/cli v29.7.1+incompatible h1:ILZpP6B7fedIr6ANy824QkDp1WMJuouIq0 github.com/docker/cli v29.7.1+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= github.com/docker/cli v29.7.2+incompatible h1:dlkwallR8XqfeVnA2ELEhdwvb4lsSwuB4IgsG8Q9cLY= github.com/docker/cli v29.7.2+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= +github.com/docker/cli v29.8.2+incompatible h1:2zgdFuoFst2T80oS42vhKGxkd0JRo305eIEKTsxR7pQ= +github.com/docker/cli v29.8.2+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= github.com/docker/compose/v5 v5.0.0 h1:J2uMCzJ/5xLcoIVVXvMmPe6HBzVQpmJThKa7Qk7Xldc= github.com/docker/compose/v5 v5.0.0/go.mod h1:BurapGv8zmYnsbSmlpCz5EU2Pi3YFV/PjeUnoFpcw64= github.com/docker/compose/v5 v5.0.1 h1:5yCjDJbwUqcuI+6WNFHNWz2/3vyBDsNnfe8LlFjyxEc= @@ -151,6 +153,8 @@ github.com/docker/compose/v5 v5.5.0 h1:B5Eh5CtlbscCMlbyMydbEj3rpIuP9GthdD7PC0Isv github.com/docker/compose/v5 v5.5.0/go.mod h1:5yn5qs7G7V7OZc1Kkd6wLz72Le0C45xLNJQ7dgASvMk= github.com/docker/compose/v5 v5.5.1 h1:saWlMxB0tfQ+FVUlWGIUjLvR0jF5cfTU18KI5zKLD/M= github.com/docker/compose/v5 v5.5.1/go.mod h1:I1MDqH4C/vHlbaWcA6A9pKTOBx9vhtQO3hx3e45igDE= +github.com/docker/compose/v5 v5.6.0 h1:WCDEV0D1CtZLyPdklHdEjFBnCStosBYkfsD3tvM/ITU= +github.com/docker/compose/v5 v5.6.0/go.mod h1:NLnbMzshDO3QlhgzMxd9sm981O1yLjPybL1WGStUesI= github.com/docker/distribution v2.8.3+incompatible h1:AtKxIZ36LoNK51+Z6RpzLpddBirtxJnzDrHLEKxTAYk= github.com/docker/distribution v2.8.3+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/docker v28.5.2+incompatible h1:DBX0Y0zAjZbSrm1uzOkdr1onVghKaftjlSWt4AFexzM= @@ -333,6 +337,8 @@ github.com/moby/moby/api v1.55.0 h1:2/sexvQyqIWS8pRSCFddBfpW2qE7vR7FCL+vN8pxwMc= github.com/moby/moby/api v1.55.0/go.mod h1:+RQ6wluLwtYaTd1WnPLykIDPekkuyD/ROWQClE83pzs= github.com/moby/moby/api v1.56.0 h1:GQzua3NA599ASSIICx0iFgiJeO9YkdDARvQsm23ZZuQ= github.com/moby/moby/api v1.56.0/go.mod h1:sZ+THbVWkjOmBPPfbnzdD/G1LuIexWhqlSHHPTDQ1Uk= +github.com/moby/moby/api v1.56.1 h1:PpWkvVPB7Fr/No8w+TfyJ/I6rWZ2YPZhT3JorIg+06c= +github.com/moby/moby/api v1.56.1/go.mod h1:sZ+THbVWkjOmBPPfbnzdD/G1LuIexWhqlSHHPTDQ1Uk= github.com/moby/moby/client v0.2.1 h1:1Grh1552mvv6i+sYOdY+xKKVTvzJegcVMhuXocyDz/k= github.com/moby/moby/client v0.2.1/go.mod h1:O+/tw5d4a1Ha/ZA/tPxIZJapJRUS6LNZ1wiVRxYHyUE= github.com/moby/moby/client v0.2.2 h1:Pt4hRMCAIlyjL3cr8M5TrXCwKzguebPAc2do2ur7dEM= diff --git a/hugo.yaml b/hugo.yaml index f50c8ada91..e0f4acf255 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -179,7 +179,7 @@ params: # (Used to show e.g., "latest" and "latest"-1 in engine install examples docker_ce_version_prev: "29.8.1" # Latest Docker Compose version - compose_version: "v5.5.0" + compose_version: "v5.6.0" # Latest BuildKit version buildkit_version: "0.32.0" # Latest actions version