Merge pull request #10344 from thaJeztah/unified_apis

Simplify fetching API versions
2020-02-25 14:22:07 +00:00 · 2020-02-25 14:22:07 +00:00 · 0715c06677
parent 944eb75952 3bbc3f5a25
commit 0715c06677
27 changed files with 47 additions and 74 deletions
--- a/.dockerignore
+++ b/.dockerignore
@ -1,6 +1,7 @@
 .dockerignore
 .git
 .gitignore
+tests
 Dockerfile
 docker-compose.yml
 _site
--- a/_layouts/engine-api.html
+++ b/_layouts/engine-api.html
@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-    <title>Docker Engine API {{ page.api_version }} Reference</title>
+    <title>Docker Engine API {{ page.name | replace: '.md' }} 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." />
@ -14,7 +14,7 @@
    <link rel="stylesheet" type="text/css" href="/css/api-reference.css" />
 </head>
 <body>
-<redoc spec-url="swagger.yaml" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
+<redoc spec-url="/engine/api/{{ page.name | replace: '.md'}}.yaml" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
 <script src="/js/redoc.min.js"></script>
 </body>
 </html>
--- a/_scripts/fetch-upstream-resources.sh
+++ b/_scripts/fetch-upstream-resources.sh
@ -62,45 +62,33 @@ if [ distribution_svn_branch = "branches/master" ]; then
 fi

 # Directories to get via SVN. We use this because you can't use git to clone just a portion of a repository
-svn co "https://github.com/docker/docker-ce/${engine_svn_branch}/components/cli/docs/extend" ./engine/extend || (echo "Failed engine/extend download" && exit 1)
-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
-svn co "https://github.com/docker/distribution/${distribution_svn_branch}/docs/spec" ./registry/spec         || (echo "Failed registry/spec download" && exit 1)
-svn co "https://github.com/mirantis/compliance/trunk/docs/compliance" ./compliance                           || (echo "Failed docker/compliance download" && exit 1)
+svn co "https://github.com/docker/cli/${engine_svn_branch}/docs/extend"              ./engine/extend || (echo "Failed engine/extend download" && exit 1)
+svn co "https://github.com/docker/docker/${engine_svn_branch}/docs/api"              ./engine/api    || (echo "Failed engine/api download" && exit 1)
+svn co "https://github.com/docker/distribution/${distribution_svn_branch}/docs/spec" ./registry/spec || (echo "Failed registry/spec download" && exit 1)
+svn co "https://github.com/mirantis/compliance/trunk/docs/compliance"                ./compliance    || (echo "Failed docker/compliance download" && exit 1)

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

 # Get the Engine APIs that are in Swagger
-# Be careful with the locations on Github for these
-# When you change this you need to make sure to copy the previous
-# directory into a new one in the docs git and change the index.html
-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)
-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)
-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)
-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)
-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)
-# New location for swagger.yaml for 17.06+
-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)
-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)
-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)
-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)
-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)
-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)
-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)
-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)
-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)
-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)
+# Add a new engine/api/<version>.md file to add a new API version page.
+# @TODO stop fetching individual files, onces all API docs are unified upstream in moby/moby
+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)
+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)
+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)
+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)
+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)
+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)
+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)
+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)

 # Get a few one-off files that we use directly from upstream
-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)
-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)
-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)
-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)
-wget --quiet --directory-prefix=./engine/reference/commandline/ "https://raw.githubusercontent.com/docker/docker-ce/${ENGINE_BRANCH}/components/cli/docs/reference/commandline/cli.md"     || (echo "Failed engine/reference/commandline/cli.md download" && exit 1)
-wget --quiet --directory-prefix=./engine/reference/commandline/ "https://raw.githubusercontent.com/docker/docker-ce/${ENGINE_BRANCH}/components/cli/docs/reference/commandline/dockerd.md" || (echo "Failed engine/reference/commandline/dockerd.md download" && exit 1)
-wget --quiet --directory-prefix=./registry/                     "https://raw.githubusercontent.com/docker/distribution/${DISTRIBUTION_BRANCH}/docs/configuration.md"                       || (echo "Failed registry/configuration.md download" && exit 1)
+wget --quiet --directory-prefix=./engine/                       "https://raw.githubusercontent.com/docker/cli/${ENGINE_BRANCH}/docs/deprecated.md"                    || (echo "Failed engine/deprecated.md download" && exit 1)
+wget --quiet --directory-prefix=./engine/reference/             "https://raw.githubusercontent.com/docker/cli/${ENGINE_BRANCH}/docs/reference/builder.md"             || (echo "Failed engine/reference/builder.md download" && exit 1)
+wget --quiet --directory-prefix=./engine/reference/             "https://raw.githubusercontent.com/docker/cli/${ENGINE_BRANCH}/docs/reference/run.md"                 || (echo "Failed engine/reference/run.md download" && exit 1)
+wget --quiet --directory-prefix=./engine/reference/commandline/ "https://raw.githubusercontent.com/docker/cli/${ENGINE_BRANCH}/docs/reference/commandline/cli.md"     || (echo "Failed engine/reference/commandline/cli.md download" && exit 1)
+wget --quiet --directory-prefix=./engine/reference/commandline/ "https://raw.githubusercontent.com/docker/cli/${ENGINE_BRANCH}/docs/reference/commandline/dockerd.md" || (echo "Failed engine/reference/commandline/dockerd.md download" && exit 1)
+wget --quiet --directory-prefix=./registry/                     "https://raw.githubusercontent.com/docker/distribution/${DISTRIBUTION_BRANCH}/docs/configuration.md"  || (echo "Failed registry/configuration.md download" && exit 1)

 # Remove things we don't want in the build
 rm ./registry/spec/api.md.tmpl
-rm -rf ./apidocs/cloud-api-source
-rm -rf ./tests
--- a/engine/api/v1.25/index.md
+++ b/engine/api/v1.25/index.md
@ -1,6 +1,5 @@
 ---
 layout: engine-api
-api_version: v1.25
 redirect_from:
  - /engine/reference/api/docker_remote_api_v1.25/
 ---
--- a/engine/api/v1.26/index.md
+++ b/engine/api/v1.26/index.md
@ -1,6 +1,5 @@
 ---
 layout: engine-api
-api_version: v1.26
 redirect_from:
  - /engine/reference/api/docker_remote_api_v1.26/
 ---
--- a/engine/api/v1.27/index.md
+++ b/engine/api/v1.27/index.md
@ -1,6 +1,5 @@
 ---
 layout: engine-api
-api_version: v1.27
 redirect_from:
  - /engine/reference/api/docker_remote_api_v1.27/
 ---
--- a/engine/api/v1.28/index.md
+++ b/engine/api/v1.28/index.md
@ -1,6 +1,5 @@
 ---
 layout: engine-api
-api_version: v1.28
 redirect_from:
  - /engine/reference/api/docker_remote_api_v1.28/
 ---
--- a/engine/api/v1.29/index.md
+++ b/engine/api/v1.29/index.md
@ -1,4 +1,3 @@
 ---
 layout: engine-api
-api_version: v1.29
 ---
--- a/engine/api/v1.30/index.md
+++ b/engine/api/v1.30/index.md
@ -1,4 +1,3 @@
 ---
 layout: engine-api
-api_version: v1.30
 ---
--- a/engine/api/v1.31/index.md
+++ b/engine/api/v1.31/index.md
@ -1,4 +1,3 @@
 ---
 layout: engine-api
-api_version: v1.31
 ---
--- a/engine/api/v1.32/index.md
+++ b/engine/api/v1.32/index.md
@ -1,4 +1,3 @@
 ---
 layout: engine-api
-api_version: v1.32
 ---
--- a/engine/api/v1.33.md
+++ b/engine/api/v1.33.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.33/index.md
+++ b/engine/api/v1.33/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.33
---
--- a/engine/api/v1.34.md
+++ b/engine/api/v1.34.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.34/index.md
+++ b/engine/api/v1.34/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.34
---
--- a/engine/api/v1.35.md
+++ b/engine/api/v1.35.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.35/index.md
+++ b/engine/api/v1.35/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.35
---
--- a/engine/api/v1.36.md
+++ b/engine/api/v1.36.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.36/index.md
+++ b/engine/api/v1.36/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.36
---
--- a/engine/api/v1.37.md
+++ b/engine/api/v1.37.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.37/index.md
+++ b/engine/api/v1.37/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.37
---
--- a/engine/api/v1.38.md
+++ b/engine/api/v1.38.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.38/index.md
+++ b/engine/api/v1.38/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.38
---
--- a/engine/api/v1.39.md
+++ b/engine/api/v1.39.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.39/index.md
+++ b/engine/api/v1.39/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.39
---
--- a/engine/api/v1.40.md
+++ b/engine/api/v1.40.md
@ -0,0 +1,3 @@
+---
+layout: engine-api
+---
--- a/engine/api/v1.40/index.md
+++ b/engine/api/v1.40/index.md
@ -1,4 +0,0 @@
---
-layout: engine-api
-api_version: v1.40
---