From 4d7600d4efe0f748a433f227bf76271c22e5191e Mon Sep 17 00:00:00 2001
From: Natasha Sarkar <natashasarkar@google.com>
Date: Thu, 12 Nov 2020 17:41:59 -0800
Subject: [PATCH] updated comments and readme

---
 kyaml/openapi/Makefile                          | 2 ++
 kyaml/openapi/README.md                         | 7 +++----
 kyaml/openapi/openapi.go                        | 6 +++++-
 kyaml/openapi/scripts/fetchSchemaFromCluster.sh | 2 +-
 kyaml/openapi/scripts/generateSwaggerDotGo.sh   | 2 +-
 5 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/kyaml/openapi/Makefile b/kyaml/openapi/Makefile
index 55b8d171f..f5cd8dc67 100644
--- a/kyaml/openapi/Makefile
+++ b/kyaml/openapi/Makefile
@@ -17,6 +17,8 @@ clean:
 
 # This will remove all currently built-in schema,
 # so think twice before deleting.
+# To replace what this will delete typically requires the ability
+# to contact a live kubernetes API server.
 .PHONY: nuke
 nuke: clean
 	rm -r kubernetesapi/*
diff --git a/kyaml/openapi/README.md b/kyaml/openapi/README.md
index fe2f9ba7f..935c6eb8c 100644
--- a/kyaml/openapi/README.md
+++ b/kyaml/openapi/README.md
@@ -1,11 +1,10 @@
 # Sampling New OpenAPI Data
 
 [OpenAPI schema]: ./kubernetesapi/
-[kind clusters]: https://hub.docker.com/r/kindest/node/tags
+[kind]: https://hub.docker.com/r/kindest/node/tags
 
-This document describes how to fetch OpenAPI data from
-a particular kubernetes version number. Note that you can
-only fetch data from versions supported by [kind clusters].
+This document describes how to fetch OpenAPI data from a
+live kubernetes API server, e.g. an instance of [kind].
 
 ### Delete all currently built-in schema
 ```
diff --git a/kyaml/openapi/openapi.go b/kyaml/openapi/openapi.go
index e4a62e109..48fd0f5b6 100644
--- a/kyaml/openapi/openapi.go
+++ b/kyaml/openapi/openapi.go
@@ -7,6 +7,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io/ioutil"
+	"path/filepath"
 	"reflect"
 	"strings"
 	"sync"
@@ -436,7 +437,10 @@ func initSchema() {
 		}
 
 		// parse the swagger, this should never fail
-		assetName := "kubernetesapi/" + kubernetesAPIDefaultVersion + "/swagger.json"
+		assetName := filepath.Join(
+			"kubernetesapi",
+			kubernetesAPIDefaultVersion,
+			"swagger.json")
 		if err := parse(kubernetesapi.OpenApiMustAsset[kubernetesAPIDefaultVersion](assetName)); err != nil {
 			// this should never happen
 			panic(err)
diff --git a/kyaml/openapi/scripts/fetchSchemaFromCluster.sh b/kyaml/openapi/scripts/fetchSchemaFromCluster.sh
index a411de6bc..b2d3d64ef 100755
--- a/kyaml/openapi/scripts/fetchSchemaFromCluster.sh
+++ b/kyaml/openapi/scripts/fetchSchemaFromCluster.sh
@@ -11,4 +11,4 @@ $MYGOBIN/kpt live  fetch-k8s-schema  --pretty-print > /tmp/new_swagger.json
 $MYGOBIN/kind delete cluster --name=getopenapidata
 cp /tmp/kubeconfig.txt $HOME/.kube/config | true
 mkdir -p kubernetesapi/"${VERSION//.}"
-cp /tmp/new_swagger.json kubernetesapi/"${VERSION//.}"/swagger.json
\ No newline at end of file
+cp /tmp/new_swagger.json kubernetesapi/"${VERSION//.}"/swagger.json
diff --git a/kyaml/openapi/scripts/generateSwaggerDotGo.sh b/kyaml/openapi/scripts/generateSwaggerDotGo.sh
index b3b03edde..1c01f8630 100755
--- a/kyaml/openapi/scripts/generateSwaggerDotGo.sh
+++ b/kyaml/openapi/scripts/generateSwaggerDotGo.sh
@@ -8,4 +8,4 @@ VERSION=$1
 $MYGOBIN/go-bindata \
   --pkg "${VERSION//.}" \
   -o kubernetesapi/"${VERSION//.}"/swagger.go \
-  kubernetesapi/"${VERSION//.}"/swagger.json
\ No newline at end of file
+  kubernetesapi/"${VERSION//.}"/swagger.json