github/sample-controller
github/sample-controller
3
0
Fork 0
mirror of https://github.com/kubernetes/sample-controller.git synced 2025-01-21 01:12:51 +08:00
Code Issues Packages Projects Releases Wiki Activity
a202d033e8
sample-controller/vendor/k8s.io/code-generator/cmd/openapi-gen
History
Kubernetes Publisher a202d033e8 sync: initially remove files BUILD */BUILD BUILD.bazel */BUILD.bazel
2018-03-21 11:25:57 +00:00
..
args sync: initially remove files BUILD */BUILD BUILD.bazel */BUILD.bazel 2018-03-21 11:25:57 +00:00
main.go sync: update required packages 2018-03-21 07:24:56 +00:00
README sync: update required packages 2018-03-21 07:24:56 +00:00

README 

# Generate OpenAPI definitions

- To generate definition for a specific type or package add "+k8s:openapi-gen=true" tag to the type/package comment lines.
- To exclude a type or a member from a tagged package/type, add "+k8s:openapi-gen=false" tag to the comment lines.

# OpenAPI Extensions
OpenAPI spec can have extensions on types. To define one or more extensions on a type or its member
add "+k8s:openapi-gen=x-kubernetes-$NAME:$VALUE" to the comment lines before type/member. A type/member can
have multiple extensions. The rest of the line in the comment will be used as $VALUE so there is no need to
escape or quote the value string. Extensions can be use to pass more information to client generators or
documentation generators. For example a type my have a friendly name to be displayed in documentation or
being used in a client's fluent interface.