summaryrefslogtreecommitdiff
path: root/vendor/k8s.io/kube-openapi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/k8s.io/kube-openapi/README.md')
-rw-r--r--vendor/k8s.io/kube-openapi/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/vendor/k8s.io/kube-openapi/README.md b/vendor/k8s.io/kube-openapi/README.md
new file mode 100644
index 000000000..babadde1f
--- /dev/null
+++ b/vendor/k8s.io/kube-openapi/README.md
@@ -0,0 +1,14 @@
+# Kube OpenAPI
+
+This repo is the home for Kubernetes OpenAPI discovery spec generation. The goal
+is to support a subset of OpenAPI features to satisfy kubernetes use-cases but
+implement that subset with little to no assumption about the structure of the
+code or routes. Thus, there should be no kubernetes specific code in this repo.
+
+
+There are two main parts:
+ - A model generator that goes through .go files, find and generate model
+definitions.
+ - The spec generator that is responsible for dynamically generate
+the final OpenAPI spec using web service routes or combining other
+OpenAPI/Json specs.