docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

engine: update API information for v23.0 

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2023-05-03 00:51:59 +02:00
parent a3fab9bf80
commit 9fa5f6973d
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
2 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_includes/api-version-matrix.md
View File

@ -1,6 +1,7 @@
| Docker version | Maximum API version | Change log |
|:---------------|:---------------------------|:---------------------------------------------------------|
| 23.0 | [1.42](/engine/api/v1.42/) | [changes](/engine/api/version-history/#v142-api-changes) |
| 20.10 | [1.41](/engine/api/v1.41/) | [changes](/engine/api/version-history/#v141-api-changes) |
| 19.03 | [1.40](/engine/api/v1.40/) | [changes](/engine/api/version-history/#v140-api-changes) |
| 18.09 | [1.39](/engine/api/v1.39/) | [changes](/engine/api/version-history/#v139-api-changes) |

37
engine/api/index.md
View File

@ -32,7 +32,7 @@ Engine API), as well as SDKs for Go and Python. The SDKs allow you to build and
scale Docker apps and solutions quickly and easily. If Go or Python don't work
for you, you can use the Docker Engine API directly.
For information about Docker Engine SDKs, see [Develop with Docker Engine SDKs](/engine/api/sdk/).
For information about Docker Engine SDKs, see [Develop with Docker Engine SDKs](sdk/index.md).
The Docker Engine API is a RESTful API accessed by an HTTP client such as `wget` or
`curl`, or the HTTP library which is part of most modern programming languages.
@ -40,7 +40,7 @@ The Docker Engine API is a RESTful API accessed by an HTTP client such as `wget`
## View the API reference
You can
[view the reference for the latest version of the API](/engine/api/latest/)
[view the reference for the latest version of the API](latest/index.html)
or [choose a specific version](/engine/api/version-history/).
## Versioned API and SDK
@ -74,21 +74,21 @@ To see the highest version of the API your Docker daemon and client support, use
$ docker version
Client: Docker Engine - Community
Version: 20.10.0
API version: 1.41
Go version: go1.13.15
Git commit: 7287ab3
Built: Tue Dec 8 19:00:39 2020
Version: 23.0.5
API version: 1.42
Go version: go1.19.8
Git commit: bc4487a
Built: Wed Apr 26 16:21:22 2023
OS/Arch: linux/amd64
Context: default
Experimental: true
Server: Docker Engine - Community
Server: Docker Desktop 4.19.0 (106363)
Engine:
Version: 20.10.0
API version: 1.41 (minimum version 1.12)
Go version: go1.13.15
Git commit: eeddea2
Built: Tue Dec 8 18:58:12 2020
Version: 23.0.5
API version: 1.42 (minimum version 1.12)
Go version: go1.19.8
Git commit: 94d3ad6
Built: Wed Apr 26 16:18:20 2023
OS/Arch: linux/amd64
...
```
@ -97,11 +97,9 @@ You can specify the API version to use, in one of the following ways:
- When using the SDK, use the latest version you can, but at least the version
that incorporates the API version with the features you need.
- When using `curl` directly, specify the version as the first part of the URL.
For instance, if the endpoint is `/containers/`, you can use
`/v1.41/containers/`.
For instance, if the endpoint is `/containers/` you can use
`/v1.42/containers/`.
- To force the Docker CLI or the Docker Engine SDKs to use an old version
of the API than the version reported by `docker version`, set the
environment variable `DOCKER_API_VERSION` to the correct version. This works
@ -119,10 +117,9 @@ You can specify the API version to use, in one of the following ways:
- The Docker Go SDK allows you to enable API version negotiation, automatically
selects an API version that is supported by both the client, and the Docker Engine
that is used.
- For the SDKs, you can also specify the API version programmatically, as a
parameter to the `client` object. See the
[Go constructor](https://github.com/moby/moby/blob/v19.03.6/client/client.go#L119){: target="_blank" rel="noopener" class="_"}
[Go constructor](https://pkg.go.dev/github.com/docker/docker/client#NewClientWithOpts){: target="_blank" rel="noopener" class="_"}
or the
[Python SDK documentation for `client`](https://docker-py.readthedocs.io/en/stable/client.html){: target="_blank" rel="noopener" class="_"}.