const (
JsonOrYaml format = "jsonOrYaml"
Proto format = "proto"
)
const Definitions = "definitions"
const Elements = "[]"
SupplementaryOpenAPIFieldName is the conventional field name (JSON/YAML) containing supplementary OpenAPI definitions.
const SupplementaryOpenAPIFieldName = "openAPI"
func AddDefinitions(definitions spec.Definitions)
AddDefinitions adds the definitions to the global schema.
func AddSchema(s []byte) error
AddSchema parses s, and adds definitions from s to the global schema.
func DefinitionRefs(openAPIPath string) ([]string, error)
DefinitionRefs returns the list of openAPI definition references present in the input openAPIPath
func GetSchemaVersion() string
GetSchemaVersion returns what kubernetes OpenAPI version is being used
func IsCertainlyClusterScoped(typeMeta yaml.TypeMeta) bool
IsCertainlyClusterScoped returns true for Node, Namespace, etc. and false for Pod, Deployment, etc. and kinds that aren't recognized in the openapi data. See: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
func IsNamespaceScoped(typeMeta yaml.TypeMeta) (bool, bool)
IsNamespaceScoped determines whether a resource is namespace or cluster-scoped by looking at the information in the openapi schema. The second return value tells whether the provided type could be found in the openapi schema. If the value is false here, the scope of the resource is not known. If the type is found, the first return value will be true if the resource is namespace-scoped, and false if the type is cluster-scoped.
func ResetOpenAPI()
ResetOpenAPI resets the openapi data to empty
func Resolve(ref *spec.Ref, schema *spec.Schema) (*spec.Schema, error)
Resolve resolves the reference against the global schema
func Schema() *spec.Schema
Schema returns the global schema
func SchemaFromFile(path string) (*spec.Schema, error)
AddSchemaFromFile reads the file at path and parses the OpenAPI definitions from the field "openAPI", also returns a function to clean the added definitions The returned clean function is a no-op on error, or else it's a function that the caller should use to remove the added openAPI definitions from global schema
func SetSchema(openAPIField map[string]string, schema []byte, reset bool) error
SetSchema sets the kubernetes OpenAPI schema version to use
func SuppressBuiltInSchemaUse()
SuppressBuiltInSchemaUse can be called to prevent using the built-in Kubernetes schema as part of the global schema. Must be called before the schema is used.
ResourceSchema wraps the OpenAPI Schema.
type ResourceSchema struct {
// Schema is the OpenAPI schema for a Resource or field
Schema *spec.Schema
}
func GetSchema(s string, schema *spec.Schema) (*ResourceSchema, error)
GetSchema parses s into a ResourceSchema, resolving References within the global schema.
func SchemaForResourceType(t yaml.TypeMeta) *ResourceSchema
SchemaForResourceType returns the Schema for the given Resource TODO(pwittrock): create a version of this function that will return a schema which can be used for duck-typed Resources -- e.g. contains common fields such as metadata, replicas and spec.template.spec
func (rs *ResourceSchema) Elements() *ResourceSchema
Elements returns the Schema for the elements of an array.
func (rs *ResourceSchema) Field(field string) *ResourceSchema
Field returns the Schema for a field.
func (rs *ResourceSchema) IsMissingOrNull() bool
IsEmpty returns true if the ResourceSchema is empty
func (rs *ResourceSchema) Lookup(path ...string) *ResourceSchema
Lookup calls either Field or Elements for each item in the path. If the path item is "[]", then Elements is called, otherwise Field is called. If any Field or Elements call returns nil, then Lookup returns nil immediately.
func (rs *ResourceSchema) PatchStrategyAndKey() (string, string)
PatchStrategyAndKey returns the patch strategy and merge key extensions
func (rs *ResourceSchema) PatchStrategyAndKeyList() (string, []string)
PatchStrategyAndKeyList returns the patch strategy and complete merge key list
| Name | Synopsis |
|---|---|
| .. | |
| kubernetesapi | |
| v1_21_2 | Package v1_21_2 generated by go-bindata.// sources: kubernetesapi/v1_21_2/swagger.pb |
| kustomizationapi | Code generated for package kustomizationapi by go-bindata DO NOT EDIT. |