Skip to content

Commit

Permalink
Add API 1.33, API matrix
Browse files Browse the repository at this point in the history
  • Loading branch information
Misty Stanley-Jones authored and Misty Stanley-Jones committed Oct 18, 2017
1 parent 3c5e81b commit a30b95e
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ ENV ENGINE_BRANCH="17.06.x"
ENV DISTRIBUTION_SVN_BRANCH="branches/release/2.6"
ENV DISTRIBUTION_BRANCH="release/2.6"

RUN apk --update add bash \
RUN /sbin/apk --update add bash \
&& bash ./md_source/_scripts/fetch-upstream-resources.sh \
&& jekyll build -s md_source -d target --config md_source/_config.yml \
&& rm -rf target/apidocs/layouts \
Expand Down
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "

docker_ce_stable_version: "17.09"
latest_stable_docker_engine_api_version: "1.32"
docker_ce_edge_version: "17.09"
docker_ce_edge_version: "17.10"
docker_ee_version: "17.06"
compose_version: "1.17.0"
machine_version: "0.12.2"
Expand Down
8 changes: 5 additions & 3 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -609,13 +609,15 @@ reference:
- path: /engine/api/sdks/
title: SDKs
- path: /engine/api/latest/
title: v{{ site.latest_stable_docker_engine_api_version }} reference
title: v{{ site.latest_stable_docker_engine_api_version }} reference (latest stable)
- sectiontitle: API reference by version
section:
- path: /engine/api/v1.32/
title: v1.32 Reference
- path: /engine/api/version-history/
title: Version history overview
- path: /engine/api/v1.33/
title: v1.33 reference
- path: /engine/api/v1.32/
title: v1.32 Reference
- path: /engine/api/v1.31/
title: v1.31 Reference
- path: /engine/api/v1.30/
Expand Down
18 changes: 18 additions & 0 deletions _includes/api-version-matrix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

| Docker version | Maximum API version |
-----------------|---------------------------|
| 17.10 | [1.33](/engine/api/v1.33/)|
| 17.09 | [1.32](/engine/api/v1.32/)|
| 17.07 | [1.31](/engine/api/v1.31/)|
| 17.06 | [1.30](/engine/api/v1.30/)|
| 17.05 | [1.29](/engine/api/v1.29/)|
| 17.04 | [1.28](/engine/api/v1.28/)|
| 17.03 | [1.27](/engine/api/v1.27/)|
| 1.13 | [1.26](/engine/api/v1.26/)|
| 1.12 | [1.24](/engine/api/v1.24/)|
| 1.11 | [1.23](/engine/api/v1.23/)|
| 1.10 | [1.22](/engine/api/v1.22/)|
| 1.9 | [1.21](/engine/api/v1.21/)|
| 1.8 | [1.20](/engine/api/v1.20/)|
| 1.7 | [1.19](/engine/api/v1.19/)|
| 1.6 | [1.18](/engine/api/v1.18/)|
3 changes: 2 additions & 1 deletion _scripts/fetch-upstream-resources.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sed -i "s/{{ site.latest_stable_docker_engine_api_version }}/$latest_stable_dock
# Engine stable
ENGINE_SVN_BRANCH="branches/17.09"
ENGINE_BRANCH="17.09"
ENGINE_EDGE_BRANCH="17.09"
ENGINE_EDGE_BRANCH="17.10"

# Distribution
DISTRIBUTION_SVN_BRANCH="branches/release/2.6"
Expand Down Expand Up @@ -96,6 +96,7 @@ wget -O md_source/engine/api/v1.29/swagger.yaml https://raw.githubusercontent.co
wget -O md_source/engine/api/v1.30/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/17.06/components/engine/api/swagger.yaml || (echo "Failed 1.30 swagger download or the 1.30 directory doesn't exist" && exit -1)
wget -O md_source/engine/api/v1.31/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/17.07/components/engine/api/swagger.yaml || (echo "Failed 1.31 swagger download or the 1.31 directory doesn't exist" && exit -1)
wget -O md_source/engine/api/v1.32/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/17.09/components/engine/api/swagger.yaml || (echo "Failed 1.32 swagger download or the 1.32 directory doesn't exist" && exit -1)
wget -O md_source/engine/api/v1.33/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/17.10/components/engine/api/swagger.yaml || (echo "Failed 1.33 swagger download or the 1.33 directory doesn't exist" && exit -1)

# Get dockerd.md for stable and edge, from upstream
wget -O md_source/engine/reference/commandline/dockerd.md https://raw.githubusercontent.com/docker/docker-ce/"$ENGINE_BRANCH"/components/cli/docs/reference/commandline/dockerd.md || (echo "Failed to fetch stable dockerd.md" && exit -1)
Expand Down
7 changes: 7 additions & 0 deletions develop/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,13 @@ You can specify the API version to use, in one of the following ways:
or the
[Python SDK documentation for `client`](https://docker-py.readthedocs.io/en/stable/client.html).

### API version matrix

Docker does not recommend running versions prior to 1.12, which means you
are encouraged to use an API version of 1.24 or higher.

{% include api-version-matrix.md %}

### Choose the SDK or API version to use

Use the following guidelines to choose the SDK or API version to use in your
Expand Down
35 changes: 35 additions & 0 deletions engine/api/v1.33/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: null
---
<!DOCTYPE html>
<html>
<head>
<title>Docker Engine API v1.33 Reference</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Reference for the API served by Docker Engine.">
<meta charset="utf-8"/>
<!--
ReDoc doesn't change outer page styles
-->
<style>
body {
margin: 0;
padding: 0;
}
api-logo {
background-image: linear-gradient(0deg, #15A4D7 0%, #1488C6 100%);
height: 100px;
text-align: left !important;
}
api-logo img {
width: 136px !important;
margin: 32px 0 0 50px;
}
</style>
</head>
<body>
<redoc spec-url="swagger.yaml" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
<script src="redoc.1.11.0.min.js"> </script>
</body>
</html>
44 changes: 44 additions & 0 deletions engine/api/v1.33/redoc.1.11.0.min.js

Large diffs are not rendered by default.

0 comments on commit a30b95e

Please sign in to comment.