Skip to content

Commit 68f9a45

Browse files
thaJeztahthaJeztah
committed
Remove API versions 1.17 and older from documentation
Docker 1.5 and older is no longer supported by Docker Hub, so there's not much need to document the API for those versions. Documentation is still available on GitHub, and through the older versions of the documentation for those that really need it. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 8adc8c3 commit 68f9a45

5 files changed

Lines changed: 2 additions & 7128 deletions

File tree

‎docs/reference/api/docker_remote_api.md‎

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,19 @@ Docker version | API version | Changes
5050
1.8.x | [1.20](docker_remote_api_v1.20.md) | [API changes](docker_remote_api.md#v1-20-api-changes)
5151
1.7.x | [1.19](docker_remote_api_v1.19.md) | [API changes](docker_remote_api.md#v1-19-api-changes)
5252
1.6.x | [1.18](docker_remote_api_v1.18.md) | [API changes](docker_remote_api.md#v1-18-api-changes)
53-
1.5.x | [1.17](docker_remote_api_v1.17.md) | [API changes](docker_remote_api.md#v1-17-api-changes)
54-
1.4.x | [1.16](docker_remote_api_v1.16.md) | [API changes](docker_remote_api.md#v1-16-api-changes)
55-
1.3.x | [1.15](docker_remote_api_v1.15.md) | [API changes](docker_remote_api.md#v1-15-api-changes)
56-
1.2.x | [1.14](docker_remote_api_v1.14.md) | [API changes](docker_remote_api.md#v1-14-api-changes)
5753

5854
Refer to the [GitHub repository](
5955
https://github.com/docker/docker/tree/master/docs/reference/api) for
6056
older releases.
6157

6258
## Authentication
6359

64-
Since API version 1.2, the auth configuration is now handled client side, so the
60+
Authentication configuration is handled client side, so the
6561
client has to send the `authConfig` as a `POST` in `/images/(name)/push`. The
6662
`authConfig`, set as the `X-Registry-Auth` header, is currently a Base64 encoded
6763
(JSON) string with the following structure:
6864

69-
```
65+
```JSON
7066
{"username": "string", "password": "string", "email": "string",
7167
"serveraddress" : "string", "auth": ""}
7268
```
@@ -249,53 +245,3 @@ end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and
249245
* `POST /build` closing the HTTP request cancels the build
250246
* `POST /containers/(id)/exec` includes `Warnings` field to response.
251247

252-
### v1.17 API changes
253-
254-
[Docker Remote API v1.17](docker_remote_api_v1.17.md) documentation
255-
256-
* The build supports `LABEL` command. Use this to add metadata to an image. For
257-
example you could add data describing the content of an image. `LABEL
258-
"com.example.vendor"="ACME Incorporated"`
259-
* `POST /containers/(id)/attach` and `POST /exec/(id)/start`
260-
* The Docker client now hints potential proxies about connection hijacking using HTTP Upgrade headers.
261-
* `POST /containers/create` sets labels on container create describing the container.
262-
* `GET /containers/json` returns the labels associated with the containers (`Labels`).
263-
* `GET /containers/(id)/json` returns the list current execs associated with the
264-
container (`ExecIDs`). This endpoint now returns the container labels
265-
(`Config.Labels`).
266-
* `POST /containers/(id)/rename` renames a container `id` to a new name.*
267-
* `POST /containers/create` and `POST /containers/(id)/start` callers can pass
268-
`ReadonlyRootfs` in the host config to mount the container's root filesystem as
269-
read only.
270-
* `GET /containers/(id)/stats` returns a live stream of a container's resource usage statistics.
271-
* `GET /images/json` returns the labels associated with each image (`Labels`).
272-
273-
274-
### v1.16 API changes
275-
276-
[Docker Remote API v1.16](docker_remote_api_v1.16.md)
277-
278-
* `GET /info` returns the number of CPUs available on the machine (`NCPU`),
279-
total memory available (`MemTotal`), a user-friendly name describing the running Docker daemon (`Name`), a unique ID identifying the daemon (`ID`), and
280-
a list of daemon labels (`Labels`).
281-
* `POST /containers/create` callers can set the new container's MAC address explicitly.
282-
* Volumes are now initialized when the container is created.
283-
* `POST /containers/(id)/copy` copies data which is contained in a volume.
284-
285-
### v1.15 API changes
286-
287-
[Docker Remote API v1.15](docker_remote_api_v1.15.md) documentation
288-
289-
`POST /containers/create` you can set a container's `HostConfig` when creating a
290-
container. Previously this was only available when starting a container.
291-
292-
### v1.14 API changes
293-
294-
[Docker Remote API v1.14](docker_remote_api_v1.14.md) documentation
295-
296-
* `DELETE /containers/(id)` when using `force`, the container will be immediately killed with SIGKILL.
297-
* `POST /containers/(id)/start` the `HostConfig` option accepts the field `CapAdd`, which specifies a list of capabilities
298-
to add, and the field `CapDrop`, which specifies a list of capabilities to drop.
299-
* `POST /images/create` th `fromImage` and `repo` parameters support the
300-
`repo:tag` format. Consequently, the `tag` parameter is now obsolete. Using the
301-
new format and the `tag` parameter at the same time will return an error.

0 commit comments

Comments
 (0)