centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 14:28:47 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add pointer to latest API ref (#4897)

Browse Source
This commit is contained in:
Misty Stanley-Jones
2017-10-16 15:04:24 -07:00
committed by GitHub
parent 6f3acdfdc3
commit 6aae2e4e84
16 changed files with 65 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
develop/sdk/index.md
View File

@@ -44,10 +44,16 @@ go get github.com/docker/docker/client
[Read the full Docker Engine Python SDK reference](https://docker-py.readthedocs.io/).
## View the API reference
You can
[view the reference for the latest version of the API](/engine/api/latest/)
or [choose a specific version](/engine/api/version-history/).
## Versioned API and SDK
The version of the Docker API you should use depends upon the version of your
Docker daemon and Docker client.
The version of the Docker Engine API you should use depends upon the version of
your Docker daemon and Docker client.
A given version of the Docker Engine SDK supports a specific version of the
Docker Engine API, as well as all earlier versions. If breaking changes occur,
@@ -124,8 +130,9 @@ You can specify the API version to use, in one of the following ways:
Use the following guidelines to choose the SDK or API version to use in your
code:
- If you're starting a new project, use the latest version, but do specify the
version you are using. This helps prevent surprises.
- If you're starting a new project, use the
[latest version](/engine/api/latest/), but do specify the version you are
using. This helps prevent surprises.
- If you need a new feature, update your code use at least the oldest version
that supports the feature, and prefer the latest version you are able to use.
- Otherwise, continue to use the version that your code is already using.