From 6dab89c905fe4d22de135f4eb9e02ecee2b0c611 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 24 Feb 2020 13:20:56 +0100 Subject: [PATCH] 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 --- _layouts/engine-api.html | 2 +- _scripts/fetch-upstream-resources.sh | 38 +++++++++---------------- engine/api/{v1.25/index.md => v1.25.md} | 0 engine/api/{v1.26/index.md => v1.26.md} | 0 engine/api/{v1.27/index.md => v1.27.md} | 0 engine/api/{v1.28/index.md => v1.28.md} | 0 engine/api/{v1.29/index.md => v1.29.md} | 0 engine/api/{v1.30/index.md => v1.30.md} | 0 engine/api/{v1.31/index.md => v1.31.md} | 0 engine/api/{v1.32/index.md => v1.32.md} | 0 engine/api/{v1.33/index.md => v1.33.md} | 0 engine/api/{v1.34/index.md => v1.34.md} | 0 engine/api/{v1.35/index.md => v1.35.md} | 0 engine/api/{v1.36/index.md => v1.36.md} | 0 engine/api/{v1.37/index.md => v1.37.md} | 0 engine/api/{v1.38/index.md => v1.38.md} | 0 engine/api/{v1.39/index.md => v1.39.md} | 0 engine/api/{v1.40/index.md => v1.40.md} | 0 18 files changed, 15 insertions(+), 25 deletions(-) rename engine/api/{v1.25/index.md => v1.25.md} (100%) rename engine/api/{v1.26/index.md => v1.26.md} (100%) rename engine/api/{v1.27/index.md => v1.27.md} (100%) rename engine/api/{v1.28/index.md => v1.28.md} (100%) rename engine/api/{v1.29/index.md => v1.29.md} (100%) rename engine/api/{v1.30/index.md => v1.30.md} (100%) rename engine/api/{v1.31/index.md => v1.31.md} (100%) rename engine/api/{v1.32/index.md => v1.32.md} (100%) rename engine/api/{v1.33/index.md => v1.33.md} (100%) rename engine/api/{v1.34/index.md => v1.34.md} (100%) rename engine/api/{v1.35/index.md => v1.35.md} (100%) rename engine/api/{v1.36/index.md => v1.36.md} (100%) rename engine/api/{v1.37/index.md => v1.37.md} (100%) rename engine/api/{v1.38/index.md => v1.38.md} (100%) rename engine/api/{v1.39/index.md => v1.39.md} (100%) rename engine/api/{v1.40/index.md => v1.40.md} (100%) diff --git a/_layouts/engine-api.html b/_layouts/engine-api.html index 36bfacaeeb..e62c992307 100644 --- a/_layouts/engine-api.html +++ b/_layouts/engine-api.html @@ -14,7 +14,7 @@ - + diff --git a/_scripts/fetch-upstream-resources.sh b/_scripts/fetch-upstream-resources.sh index c9e2db7619..be6f5177cd 100755 --- a/_scripts/fetch-upstream-resources.sh +++ b/_scripts/fetch-upstream-resources.sh @@ -62,37 +62,27 @@ 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/.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) diff --git a/engine/api/v1.25/index.md b/engine/api/v1.25.md similarity index 100% rename from engine/api/v1.25/index.md rename to engine/api/v1.25.md diff --git a/engine/api/v1.26/index.md b/engine/api/v1.26.md similarity index 100% rename from engine/api/v1.26/index.md rename to engine/api/v1.26.md diff --git a/engine/api/v1.27/index.md b/engine/api/v1.27.md similarity index 100% rename from engine/api/v1.27/index.md rename to engine/api/v1.27.md diff --git a/engine/api/v1.28/index.md b/engine/api/v1.28.md similarity index 100% rename from engine/api/v1.28/index.md rename to engine/api/v1.28.md diff --git a/engine/api/v1.29/index.md b/engine/api/v1.29.md similarity index 100% rename from engine/api/v1.29/index.md rename to engine/api/v1.29.md diff --git a/engine/api/v1.30/index.md b/engine/api/v1.30.md similarity index 100% rename from engine/api/v1.30/index.md rename to engine/api/v1.30.md diff --git a/engine/api/v1.31/index.md b/engine/api/v1.31.md similarity index 100% rename from engine/api/v1.31/index.md rename to engine/api/v1.31.md diff --git a/engine/api/v1.32/index.md b/engine/api/v1.32.md similarity index 100% rename from engine/api/v1.32/index.md rename to engine/api/v1.32.md diff --git a/engine/api/v1.33/index.md b/engine/api/v1.33.md similarity index 100% rename from engine/api/v1.33/index.md rename to engine/api/v1.33.md diff --git a/engine/api/v1.34/index.md b/engine/api/v1.34.md similarity index 100% rename from engine/api/v1.34/index.md rename to engine/api/v1.34.md diff --git a/engine/api/v1.35/index.md b/engine/api/v1.35.md similarity index 100% rename from engine/api/v1.35/index.md rename to engine/api/v1.35.md diff --git a/engine/api/v1.36/index.md b/engine/api/v1.36.md similarity index 100% rename from engine/api/v1.36/index.md rename to engine/api/v1.36.md diff --git a/engine/api/v1.37/index.md b/engine/api/v1.37.md similarity index 100% rename from engine/api/v1.37/index.md rename to engine/api/v1.37.md diff --git a/engine/api/v1.38/index.md b/engine/api/v1.38.md similarity index 100% rename from engine/api/v1.38/index.md rename to engine/api/v1.38.md diff --git a/engine/api/v1.39/index.md b/engine/api/v1.39.md similarity index 100% rename from engine/api/v1.39/index.md rename to engine/api/v1.39.md diff --git a/engine/api/v1.40/index.md b/engine/api/v1.40.md similarity index 100% rename from engine/api/v1.40/index.md rename to engine/api/v1.40.md