caching

History

Matt Moore 932173e3e2 Bootstrap knative/caching. This adds all of the elements needed to bootstrap the knative/caching repo. I've tried to limit this to largely boilerplate elements so that it can more easily be recycled as we create other repos.		2018-09-01 20:50:01 +00:00
..
args	Bootstrap knative/caching.	2018-09-01 20:50:01 +00:00
README	Bootstrap knative/caching.	2018-09-01 20:50:01 +00:00
main.go	Bootstrap knative/caching.	2018-09-01 20:50:01 +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.