Skip to content

Commit

Permalink
Update engine API docs, fetch script, and matrix
Browse files Browse the repository at this point in the history
  • Loading branch information
@gbarr01
gbarr01 authored and gbarr01 committed Mar 22, 2018
1 parent cb157b3 commit f36f3ec
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 25 deletions.
2 changes: 2 additions & 0 deletions _data/toc.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1348,6 +1348,8 @@ reference:
section:
- path: /engine/api/version-history/
title: Version history overview
- path: /engine/api/v1.37/
title: v1.37 reference
- path: /engine/api/v1.36/
title: v1.36 reference
- path: /engine/api/v1.35/
Expand Down
45 changes: 23 additions & 22 deletions _includes/api-version-matrix.md
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@

| Docker version | Maximum API version | Change log |
-----------------|---------------------------|-----------------------------------------------------------|
| 18.02 | [1.36](/engine/api/v1.36/)| [changes](/engine/api/version-history/#v136-api-changes) |
| 17.12 | [1.35](/engine/api/v1.35/)| [changes](/engine/api/version-history/#v135-api-changes) |
| 17.11 | [1.34](/engine/api/v1.34/)| [changes](/engine/api/version-history/#v134-api-changes) |
| 17.10 | [1.33](/engine/api/v1.33/)| [changes](/engine/api/version-history/#v133-api-changes) |
| 17.09 | [1.32](/engine/api/v1.32/)| [changes](/engine/api/version-history/#v132-api-changes) |
| 17.07 | [1.31](/engine/api/v1.31/)| [changes](/engine/api/version-history/#v131-api-changes) |
| 17.06 | [1.30](/engine/api/v1.30/)| [changes](/engine/api/version-history/#v130-api-changes) |
| 17.05 | [1.29](/engine/api/v1.29/)| [changes](/engine/api/version-history/#v129-api-changes) |
| 17.04 | [1.28](/engine/api/v1.28/)| [changes](/engine/api/version-history/#v128-api-changes) |
| 17.03.1 | [1.27](/engine/api/v1.27/)| [changes](/engine/api/version-history/#v127-api-changes) |
| 17.03 | [1.26](/engine/api/v1.27/)| [changes](/engine/api/version-history/#v126-api-changes) |
| 1.13.1 | [1.26](/engine/api/v1.26/)| [changes](/engine/api/version-history/#v126-api-changes) |
| 1.13 | [1.25](/engine/api/v1.26/)| [changes](/engine/api/version-history/#v125-api-changes) |
| 1.12 | [1.24](/engine/api/v1.24/)| [changes](/engine/api/version-history/#v124-api-changes) |
| 1.11 | [1.23](/engine/api/v1.23/)| [changes](/engine/api/version-history/#v123-api-changes) |
| 1.10 | [1.22](/engine/api/v1.22/)| [changes](/engine/api/version-history/#v122-api-changes) |
| 1.9 | [1.21](/engine/api/v1.21/)| [changes](/engine/api/version-history/#v121-api-changes) |
| 1.8 | [1.20](/engine/api/v1.20/)| [changes](/engine/api/version-history/#v120-api-changes) |
| 1.7 | [1.19](/engine/api/v1.19/)| [changes](/engine/api/version-history/#v119-api-changes) |
| 1.6 | [1.18](/engine/api/v1.18/)| [changes](/engine/api/version-history/#v118-api-changes) |
| Docker version | Maximum API version | Change log |
|:---------------|:---------------------------|:----------------------------------------------------------|
| 18.03 | [1.37](/engine/api/v1.37/) | [changes](/engine/api/version-history/#v1-37-api-changes) |
| 18.02 | [1.36](/engine/api/v1.36/) | [changes](/engine/api/version-history/#v1-36-api-changes) |
| 17.12 | [1.35](/engine/api/v1.35/) | [changes](/engine/api/version-history/#v1-35-api-changes) |
| 17.11 | [1.34](/engine/api/v1.34/) | [changes](/engine/api/version-history/#v1-34-api-changes) |
| 17.10 | [1.33](/engine/api/v1.33/) | [changes](/engine/api/version-history/#v1-33-api-changes) |
| 17.09 | [1.32](/engine/api/v1.32/) | [changes](/engine/api/version-history/#v1-32-api-changes) |
| 17.07 | [1.31](/engine/api/v1.31/) | [changes](/engine/api/version-history/#v1-31-api-changes) |
| 17.06 | [1.30](/engine/api/v1.30/) | [changes](/engine/api/version-history/#v1-30-api-changes) |
| 17.05 | [1.29](/engine/api/v1.29/) | [changes](/engine/api/version-history/#v1-29-api-changes) |
| 17.04 | [1.28](/engine/api/v1.28/) | [changes](/engine/api/version-history/#v1-28-api-changes) |
| 17.03.1 | [1.27](/engine/api/v1.27/) | [changes](/engine/api/version-history/#v1-27-api-changes) |
| 17.03 | [1.26](/engine/api/v1.27/) | [changes](/engine/api/version-history/#v1-26-api-changes) |
| 1.13.1 | [1.26](/engine/api/v1.26/) | [changes](/engine/api/version-history/#v1-26-api-changes) |
| 1.13 | [1.25](/engine/api/v1.26/) | [changes](/engine/api/version-history/#v1-25-api-changes) |
| 1.12 | [1.24](/engine/api/v1.24/) | [changes](/engine/api/version-history/#v1-24-api-changes) |
| 1.11 | [1.23](/engine/api/v1.23/) | [changes](/engine/api/version-history/#v1-23-api-changes) |
| 1.10 | [1.22](/engine/api/v1.22/) | [changes](/engine/api/version-history/#v1-22-api-changes) |
| 1.9 | [1.21](/engine/api/v1.21/) | [changes](/engine/api/version-history/#v1-21-api-changes) |
| 1.8 | [1.20](/engine/api/v1.20/) | [changes](/engine/api/version-history/#v1-20-api-changes) |
| 1.7 | [1.19](/engine/api/v1.19/) | [changes](/engine/api/version-history/#v1-19-api-changes) |
| 1.6 | [1.18](/engine/api/v1.18/) | [changes](/engine/api/version-history/#v1-18-api-changes) |
7 changes: 4 additions & 3 deletions _scripts/fetch-upstream-resources.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ done < <(cat ${SOURCE}/_config.yml |grep '_version:' |grep '^[a-z].*')
sedi "s/{{ site.latest_stable_docker_engine_api_version }}/$latest_stable_docker_engine_api_version/g" ${SOURCE}/_data/toc.yaml

# Engine stable
ENGINE_SVN_BRANCH="branches/17.12"
ENGINE_BRANCH="17.12"
ENGINE_EDGE_BRANCH="18.02"
ENGINE_SVN_BRANCH="branches/18.03"
ENGINE_BRANCH="18.03"
ENGINE_EDGE_BRANCH="18.03"

# Distribution
DISTRIBUTION_SVN_BRANCH="branches/release/2.6"
Expand Down Expand Up @@ -146,6 +146,7 @@ wget -O ${SOURCE}/engine/api/v1.33/swagger.yaml https://raw.githubusercontent.co
wget -O ${SOURCE}/engine/api/v1.34/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/17.11/components/engine/api/swagger.yaml || (echo "Failed 1.34 swagger download or the 1.34 directory doesn't exist" && exit -1)
wget -O ${SOURCE}/engine/api/v1.35/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/17.12/components/engine/api/swagger.yaml || (echo "Failed 1.35 swagger download or the 1.35 directory doesn't exist" && exit -1)
wget -O ${SOURCE}/engine/api/v1.36/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/18.02/components/engine/api/swagger.yaml || (echo "Failed 1.36 swagger download or the 1.36 directory doesn't exist" && exit -1)
wget -O ${SOURCE}/engine/api/v1.37/swagger.yaml https://raw.githubusercontent.com/docker/docker-ce/18.02/components/engine/api/swagger.yaml || (echo "Failed 1.37 swagger download or the 1.37 directory doesn't exist" && exit -1)

# Get dockerd.md for stable and edge, from upstream
wget -O ${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
35 changes: 35 additions & 0 deletions engine/api/v1.37/index.html
View file
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.37 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.37/redoc.1.11.0.min.js
View file

Large diffs are not rendered by default.

0 comments on commit f36f3ec

Please sign in to comment.