mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
commit
3f9dc02135
6 changed files with 6166 additions and 12 deletions
|
@ -21,7 +21,7 @@ import (
|
||||||
// Common constants for daemon and client.
|
// Common constants for daemon and client.
|
||||||
const (
|
const (
|
||||||
// DefaultVersion of Current REST API
|
// DefaultVersion of Current REST API
|
||||||
DefaultVersion string = "1.25"
|
DefaultVersion string = "1.26"
|
||||||
|
|
||||||
// NoBaseImageSpecifier is the symbol used by the FROM
|
// NoBaseImageSpecifier is the symbol used by the FROM
|
||||||
// command to specify that no base image is to be used.
|
// command to specify that no base image is to be used.
|
||||||
|
|
|
@ -8,10 +8,10 @@ produces:
|
||||||
consumes:
|
consumes:
|
||||||
- "application/json"
|
- "application/json"
|
||||||
- "text/plain"
|
- "text/plain"
|
||||||
basePath: "/v1.25"
|
basePath: "/v1.26"
|
||||||
info:
|
info:
|
||||||
title: "Docker Remote API"
|
title: "Docker Remote API"
|
||||||
version: "1.25"
|
version: "1.26"
|
||||||
x-logo:
|
x-logo:
|
||||||
url: "https://docs.docker.com/images/logo-docker-main.png"
|
url: "https://docs.docker.com/images/logo-docker-main.png"
|
||||||
description: |
|
description: |
|
||||||
|
@ -33,7 +33,7 @@ info:
|
||||||
|
|
||||||
The API is usually changed in each release of Docker. If you want to write a client that doesn't break when connecting to newer Docker releases, you can lock to a specific API version.
|
The API is usually changed in each release of Docker. If you want to write a client that doesn't break when connecting to newer Docker releases, you can lock to a specific API version.
|
||||||
|
|
||||||
For Docker 1.13, the API version is 1.25. To lock to this version, you prefix the URL with `/v1.25`. For example, calling `/info` is the same as calling `/v1.25/info`.
|
For Docker 1.14, the API version is 1.26. To lock to this version, you prefix the URL with `/v1.26`. For example, calling `/info` is the same as calling `/v1.26/info`.
|
||||||
|
|
||||||
The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer Docker daemons.
|
The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer Docker daemons.
|
||||||
|
|
||||||
|
@ -1581,7 +1581,7 @@ definitions:
|
||||||
NanoCPUs: 4000000000
|
NanoCPUs: 4000000000
|
||||||
MemoryBytes: 8272408576
|
MemoryBytes: 8272408576
|
||||||
Engine:
|
Engine:
|
||||||
EngineVersion: "1.13.0"
|
EngineVersion: "1.14.0"
|
||||||
Labels:
|
Labels:
|
||||||
foo: "bar"
|
foo: "bar"
|
||||||
Plugins:
|
Plugins:
|
||||||
|
@ -5052,13 +5052,13 @@ paths:
|
||||||
type: "string"
|
type: "string"
|
||||||
examples:
|
examples:
|
||||||
application/json:
|
application/json:
|
||||||
Version: "1.13.0"
|
Version: "1.14.0"
|
||||||
Os: "linux"
|
Os: "linux"
|
||||||
KernelVersion: "3.19.0-23-generic"
|
KernelVersion: "3.19.0-23-generic"
|
||||||
GoVersion: "go1.6.3"
|
GoVersion: "go1.6.3"
|
||||||
GitCommit: "deadbee"
|
GitCommit: "deadbee"
|
||||||
Arch: "amd64"
|
Arch: "amd64"
|
||||||
ApiVersion: "1.25"
|
ApiVersion: "1.26"
|
||||||
MinAPIVersion: "1.12"
|
MinAPIVersion: "1.12"
|
||||||
BuildTime: "2016-06-14T07:09:13.444803460+00:00"
|
BuildTime: "2016-06-14T07:09:13.444803460+00:00"
|
||||||
Experimental: true
|
Experimental: true
|
||||||
|
|
|
@ -3,7 +3,7 @@ Package client is a Go client for the Docker Remote API.
|
||||||
|
|
||||||
The "docker" command uses this package to communicate with the daemon. It can also
|
The "docker" command uses this package to communicate with the daemon. It can also
|
||||||
be used by your own Go applications to do anything the command-line interface does
|
be used by your own Go applications to do anything the command-line interface does
|
||||||
– running containers, pulling images, managing swarms, etc.
|
- running containers, pulling images, managing swarms, etc.
|
||||||
|
|
||||||
For more information about the Remote API, see the documentation:
|
For more information about the Remote API, see the documentation:
|
||||||
https://docs.docker.com/engine/reference/api/docker_remote_api/
|
https://docs.docker.com/engine/reference/api/docker_remote_api/
|
||||||
|
@ -58,7 +58,7 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
// DefaultVersion is the version of the current stable API
|
// DefaultVersion is the version of the current stable API
|
||||||
const DefaultVersion string = "1.25"
|
const DefaultVersion string = "1.26"
|
||||||
|
|
||||||
// Client is the API client that performs all operations
|
// Client is the API client that performs all operations
|
||||||
// against a docker server.
|
// against a docker server.
|
||||||
|
|
|
@ -165,7 +165,7 @@ func (cli *Client) doRequest(ctx context.Context, req *http.Request) (serverResp
|
||||||
// daemon on Windows where the daemon is listening on a named pipe
|
// daemon on Windows where the daemon is listening on a named pipe
|
||||||
// `//./pipe/docker_engine, and the client must be running elevated.
|
// `//./pipe/docker_engine, and the client must be running elevated.
|
||||||
// Give users a clue rather than the not-overly useful message
|
// Give users a clue rather than the not-overly useful message
|
||||||
// such as `error during connect: Get http://%2F%2F.%2Fpipe%2Fdocker_engine/v1.25/info:
|
// such as `error during connect: Get http://%2F%2F.%2Fpipe%2Fdocker_engine/v1.26/info:
|
||||||
// open //./pipe/docker_engine: The system cannot find the file specified.`.
|
// open //./pipe/docker_engine: The system cannot find the file specified.`.
|
||||||
// Note we can't string compare "The system cannot find the file specified" as
|
// Note we can't string compare "The system cannot find the file specified" as
|
||||||
// this is localised - for example in French the error would be
|
// this is localised - for example in French the error would be
|
||||||
|
|
|
@ -54,8 +54,8 @@ default.
|
||||||
It is required to to supply a version to API calls. This is done by prefixing
|
It is required to to supply a version to API calls. This is done by prefixing
|
||||||
the URL with the version number.
|
the URL with the version number.
|
||||||
|
|
||||||
The current version of the API is 1.25, so to call the `/info` endpoint, you
|
The current version of the API is 1.26, so to call the `/info` endpoint, you
|
||||||
would send a request to the URL `/v1.25/info`. To call, for example, version
|
would send a request to the URL `/v1.26/info`. To call, for example, version
|
||||||
1.24 of the API instead, you would request `/v1.24/info`.
|
1.24 of the API instead, you would request `/v1.24/info`.
|
||||||
|
|
||||||
If a newer daemon is installed, new properties may be returned even when
|
If a newer daemon is installed, new properties may be returned even when
|
||||||
|
@ -69,6 +69,7 @@ Use the table below to find the API version for a Docker version:
|
||||||
|
|
||||||
Docker version | API version | Changes
|
Docker version | API version | Changes
|
||||||
----------------|------------------------------------|------------------------------------------------------
|
----------------|------------------------------------|------------------------------------------------------
|
||||||
|
1.14.x | [1.26](docker_remote_api_v1.26.md) | [API changes](docker_remote_api.md#v1-26-api-changes)
|
||||||
1.13.x | [1.25](docker_remote_api_v1.25.md) | [API changes](docker_remote_api.md#v1-25-api-changes)
|
1.13.x | [1.25](docker_remote_api_v1.25.md) | [API changes](docker_remote_api.md#v1-25-api-changes)
|
||||||
1.12.x | [1.24](docker_remote_api_v1.24.md) | [API changes](docker_remote_api.md#v1-24-api-changes)
|
1.12.x | [1.24](docker_remote_api_v1.24.md) | [API changes](docker_remote_api.md#v1-24-api-changes)
|
||||||
1.11.x | [1.23](docker_remote_api_v1.23.md) | [API changes](docker_remote_api.md#v1-23-api-changes)
|
1.11.x | [1.23](docker_remote_api_v1.23.md) | [API changes](docker_remote_api.md#v1-23-api-changes)
|
||||||
|
@ -137,6 +138,11 @@ Running `docker rmi` emits an **untag** event when removing an image name. The
|
||||||
|
|
||||||
This section lists each version from latest to oldest. Each listing includes a link to the full documentation set and the changes relevant in that release.
|
This section lists each version from latest to oldest. Each listing includes a link to the full documentation set and the changes relevant in that release.
|
||||||
|
|
||||||
|
### v1.26 API changes
|
||||||
|
|
||||||
|
[Docker Remote API v1.26](docker_remote_api_v1.26.md) documentation
|
||||||
|
|
||||||
|
|
||||||
### v1.25 API changes
|
### v1.25 API changes
|
||||||
|
|
||||||
[Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
|
[Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
|
||||||
|
|
6148
docs/reference/api/docker_remote_api_v1.26.md
Normal file
6148
docs/reference/api/docker_remote_api_v1.26.md
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Reference in a new issue