mirror of
https://github.com/optim-enterprises-bv/kubernetes.git
synced 2025-11-04 04:08:16 +00:00
04e891c7d3
Also add a makefile. This will need a cherrypick onto 1.0,1.1 with edits to hack/jenkins/test-dockerized.sh to run branch-specific test scripts. Also had to modify hack/verify-api-reference.sh to handle volume mount path peculiarity when doing `docker run -v` inside a container started with `docker run -v`. See associated comment in hack/jenkins/test-dockerized.sh
49 lines
1.7 KiB
Bash
Executable File
49 lines
1.7 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Copyright 2015 The Kubernetes Authors All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# Generates updated api-reference docs from the latest swagger spec.
|
|
# Usage: ./update-api-reference-docs.sh <absolute output path>
|
|
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
|
|
REPO_DIR=${REPO_DIR:-"${PWD}/${KUBE_ROOT}"}
|
|
DEFAULT_OUTPUT_PATH="${REPO_DIR}/docs/api-reference"
|
|
OUTPUT=${1:-${DEFAULT_OUTPUT_PATH}}
|
|
|
|
echo "Generating api reference docs at ${OUTPUT}"
|
|
|
|
V1_PATH="${OUTPUT}/v1/"
|
|
V1BETA1_PATH="${OUTPUT}/extensions/v1beta1"
|
|
SWAGGER_PATH="${REPO_DIR}/api/swagger-spec/"
|
|
|
|
echo "Reading swagger spec from: ${SWAGGER_PATH}"
|
|
|
|
mkdir -p $V1_PATH
|
|
mkdir -p $V1BETA1_PATH
|
|
|
|
docker run --rm -v $V1_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v3 \
|
|
v1 \
|
|
https://raw.githubusercontent.com/kubernetes/kubernetes/master/pkg/api/v1/register.go
|
|
|
|
docker run --rm -v $V1BETA1_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v3 \
|
|
v1beta1 \
|
|
https://raw.githubusercontent.com/kubernetes/kubernetes/master/pkg/apis/extensions/v1beta1/register.go
|
|
|
|
# ex: ts=2 sw=2 et filetype=sh
|