Skip to content

Commit 6dab89c

Browse files
thaJeztahthaJeztah
committed
Engine API: unify APIs: fetch from single branch
The upstream (moby/moby) repository is unifying all API swagger files to be in the release branch. With that change, it is no longer needed to fetch each version of the API separately, and instead all versions can be fetched at once. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 944eb75 commit 6dab89c

18 files changed

+15
-25
lines changed

Diff for: ‎_layouts/engine-api.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<link rel="stylesheet" type="text/css" href="/css/api-reference.css" />
1515
</head>
1616
<body>
17-
<redoc spec-url="swagger.yaml" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
17+
<redoc spec-url="/engine/api/{{ page.api_version }}.yaml" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
1818
<script src="/js/redoc.min.js"></script>
1919
</body>
2020
</html>

Diff for: ‎_scripts/fetch-upstream-resources.sh

+14-24
Original file line numberDiff line numberDiff line change
@@ -62,37 +62,27 @@ if [ distribution_svn_branch = "branches/master" ]; then
6262
fi
6363

6464
# Directories to get via SVN. We use this because you can't use git to clone just a portion of a repository
65-
svn co "https://github.com/docker/docker-ce/${engine_svn_branch}/components/cli/docs/extend" ./engine/extend || (echo "Failed engine/extend download" && exit 1)
66-
svn co "https://github.com/docker/docker-ce/${engine_svn_branch}/components/engine/docs/api" ./engine/api || (echo "Failed engine/api download" && exit 1) # This will only get you the old API MD files 1.18 through 1.24
67-
svn co "https://github.com/docker/distribution/${distribution_svn_branch}/docs/spec" ./registry/spec || (echo "Failed registry/spec download" && exit 1)
68-
svn co "https://github.com/mirantis/compliance/trunk/docs/compliance" ./compliance || (echo "Failed docker/compliance download" && exit 1)
65+
svn co "https://github.com/docker/cli/${engine_svn_branch}/docs/extend" ./engine/extend || (echo "Failed engine/extend download" && exit 1)
66+
svn co "https://github.com/docker/docker/${engine_svn_branch}/docs/api" ./engine/api || (echo "Failed engine/api download" && exit 1)
67+
svn co "https://github.com/docker/distribution/${distribution_svn_branch}/docs/spec" ./registry/spec || (echo "Failed registry/spec download" && exit 1)
68+
svn co "https://github.com/mirantis/compliance/trunk/docs/compliance" ./compliance || (echo "Failed docker/compliance download" && exit 1)
6969

7070
# Cleanup svn directories
7171
find . -name .svn -exec rm -rf '{}' \;
7272

7373
# Get the Engine APIs that are in Swagger
74-
# Be careful with the locations on Github for these
75-
# When you change this you need to make sure to copy the previous
76-
# directory into a new one in the docs git and change the index.html
77-
wget --quiet --directory-prefix=./engine/api/v1.25/ https://raw.githubusercontent.com/docker/docker/v1.13.0/api/swagger.yaml || (echo "Failed 1.25 swagger download" && exit 1)
78-
wget --quiet --directory-prefix=./engine/api/v1.26/ https://raw.githubusercontent.com/docker/docker/v17.03.0-ce/api/swagger.yaml || (echo "Failed 1.26 swagger download" && exit 1)
79-
wget --quiet --directory-prefix=./engine/api/v1.27/ https://raw.githubusercontent.com/docker/docker/v17.03.1-ce/api/swagger.yaml || (echo "Failed 1.27 swagger download" && exit 1)
80-
wget --quiet --directory-prefix=./engine/api/v1.28/ https://raw.githubusercontent.com/docker/docker/v17.04.0-ce/api/swagger.yaml || (echo "Failed 1.28 swagger download" && exit 1)
81-
wget --quiet --directory-prefix=./engine/api/v1.29/ https://raw.githubusercontent.com/docker/docker/v17.05.0-ce/api/swagger.yaml || (echo "Failed 1.29 swagger download" && exit 1)
82-
# New location for swagger.yaml for 17.06+
83-
wget --quiet --directory-prefix=./engine/api/v1.30/ https://raw.githubusercontent.com/docker/docker-ce/v17.06.2-ce/components/engine/api/swagger.yaml || (echo "Failed 1.30 swagger download" && exit 1)
84-
wget --quiet --directory-prefix=./engine/api/v1.31/ https://raw.githubusercontent.com/docker/docker-ce/v17.07.0-ce/components/engine/api/swagger.yaml || (echo "Failed 1.31 swagger download" && exit 1)
85-
wget --quiet --directory-prefix=./engine/api/v1.32/ https://raw.githubusercontent.com/docker/docker-ce/v17.09.1-ce/components/engine/api/swagger.yaml || (echo "Failed 1.32 swagger download" && exit 1)
86-
wget --quiet --directory-prefix=./engine/api/v1.33/ https://raw.githubusercontent.com/docker/docker-ce/v17.10.0-ce/components/engine/api/swagger.yaml || (echo "Failed 1.33 swagger download" && exit 1)
87-
wget --quiet --directory-prefix=./engine/api/v1.34/ https://raw.githubusercontent.com/docker/docker-ce/v17.11.0-ce/components/engine/api/swagger.yaml || (echo "Failed 1.34 swagger download" && exit 1)
88-
wget --quiet --directory-prefix=./engine/api/v1.35/ https://raw.githubusercontent.com/docker/docker-ce/v17.12.1-ce/components/engine/api/swagger.yaml || (echo "Failed 1.35 swagger download" && exit 1)
89-
wget --quiet --directory-prefix=./engine/api/v1.36/ https://raw.githubusercontent.com/docker/docker-ce/v18.02.0-ce/components/engine/api/swagger.yaml || (echo "Failed 1.36 swagger download" && exit 1)
90-
wget --quiet --directory-prefix=./engine/api/v1.37/ https://raw.githubusercontent.com/docker/docker-ce/v18.03.1-ce/components/engine/api/swagger.yaml || (echo "Failed 1.37 swagger download" && exit 1)
91-
wget --quiet --directory-prefix=./engine/api/v1.38/ https://raw.githubusercontent.com/docker/docker-ce/v18.06.3-ce/components/engine/api/swagger.yaml || (echo "Failed 1.38 swagger download" && exit 1)
92-
wget --quiet --directory-prefix=./engine/api/v1.39/ https://raw.githubusercontent.com/docker/docker-ce/v18.09.9/components/engine/api/swagger.yaml || (echo "Failed 1.39 swagger download" && exit 1)
74+
# Add a new engine/api/<version>.md file to add a new API version page.
75+
# @TODO stop fetching individual files, onces all API docs are unified upstream in moby/moby
76+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v17.06.2-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.30.yaml || (echo "Failed 1.30 swagger download" && exit 1)
77+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v17.07.0-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.31.yaml || (echo "Failed 1.31 swagger download" && exit 1)
78+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v17.09.1-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.32.yaml || (echo "Failed 1.32 swagger download" && exit 1)
79+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v17.10.0-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.33.yaml || (echo "Failed 1.33 swagger download" && exit 1)
80+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v17.11.0-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.34.yaml || (echo "Failed 1.34 swagger download" && exit 1)
81+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v17.12.1-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.35.yaml || (echo "Failed 1.35 swagger download" && exit 1)
82+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v18.02.0-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.36.yaml || (echo "Failed 1.36 swagger download" && exit 1)
83+
wget --quiet --directory-prefix=./engine/api/ https://raw.githubusercontent.com/docker/docker-ce/v18.03.1-ce/components/engine/api/swagger.yaml; mv ./engine/api/swagger.yaml ./engine/api/v1.37.yaml || (echo "Failed 1.37 swagger download" && exit 1)
9384

9485
# Get a few one-off files that we use directly from upstream
95-
wget --quiet --directory-prefix=./engine/api/v"${latest_engine_api_version}"/ "https://raw.githubusercontent.com/docker/docker-ce/${ENGINE_BRANCH}/components/engine/api/swagger.yaml" || (echo "Failed ${latest_engine_api_version} swagger download" && exit 1)
9686
wget --quiet --directory-prefix=./engine/ "https://raw.githubusercontent.com/docker/docker-ce/${ENGINE_BRANCH}/components/cli/docs/deprecated.md" || (echo "Failed engine/deprecated.md download" && exit 1)
9787
wget --quiet --directory-prefix=./engine/reference/ "https://raw.githubusercontent.com/docker/docker-ce/${ENGINE_BRANCH}/components/cli/docs/reference/builder.md" || (echo "Failed engine/reference/builder.md download" && exit 1)
9888
wget --quiet --directory-prefix=./engine/reference/ "https://raw.githubusercontent.com/docker/docker-ce/${ENGINE_BRANCH}/components/cli/docs/reference/run.md" || (echo "Failed engine/reference/run.md download" && exit 1)

Diff for: ‎engine/api/v1.25/index.md renamed to ‎engine/api/v1.25.md

File renamed without changes.

Diff for: ‎engine/api/v1.26/index.md renamed to ‎engine/api/v1.26.md

File renamed without changes.

Diff for: ‎engine/api/v1.27/index.md renamed to ‎engine/api/v1.27.md

File renamed without changes.

Diff for: ‎engine/api/v1.28/index.md renamed to ‎engine/api/v1.28.md

File renamed without changes.

Diff for: ‎engine/api/v1.29/index.md renamed to ‎engine/api/v1.29.md

File renamed without changes.

Diff for: ‎engine/api/v1.30/index.md renamed to ‎engine/api/v1.30.md

File renamed without changes.

Diff for: ‎engine/api/v1.31/index.md renamed to ‎engine/api/v1.31.md

File renamed without changes.

Diff for: ‎engine/api/v1.32/index.md renamed to ‎engine/api/v1.32.md

File renamed without changes.

Diff for: ‎engine/api/v1.33/index.md renamed to ‎engine/api/v1.33.md

File renamed without changes.

Diff for: ‎engine/api/v1.34/index.md renamed to ‎engine/api/v1.34.md

File renamed without changes.

Diff for: ‎engine/api/v1.35/index.md renamed to ‎engine/api/v1.35.md

File renamed without changes.

Diff for: ‎engine/api/v1.36/index.md renamed to ‎engine/api/v1.36.md

File renamed without changes.

Diff for: ‎engine/api/v1.37/index.md renamed to ‎engine/api/v1.37.md

File renamed without changes.

Diff for: ‎engine/api/v1.38/index.md renamed to ‎engine/api/v1.38.md

File renamed without changes.

Diff for: ‎engine/api/v1.39/index.md renamed to ‎engine/api/v1.39.md

File renamed without changes.

Diff for: ‎engine/api/v1.40/index.md renamed to ‎engine/api/v1.40.md

File renamed without changes.

0 commit comments

Comments
 (0)