util

Documentation

Index

• func GetCanonicalTypeName(model interface{}) string
• func ToCanonicalName(name string) string
• func ToRESTFriendlyName(name string) string
• type OpenAPICanonicalTypeNamer
• type Trie
  • func NewTrie(list []string) Trie
  • func (t *Trie) Add(v string)
  • func (t *Trie) GetPrefix(v string) (string, bool)
  • func (t *Trie) HasPrefix(v string) bool

Functions

func GetCanonicalTypeName

func GetCanonicalTypeName(model interface{}) string

GetCanonicalTypeName will find the canonical type name of a sample object, removing the "vendor" part of the path

func ToCanonicalName

func ToCanonicalName(name string) string

[DEPRECATED] ToCanonicalName converts Golang package/type canonical name into REST friendly OpenAPI name. This method is deprecated because it has a misleading name. Please use ToRESTFriendlyName instead

NOTE: actually the "canonical name" in this method should be named "REST friendly OpenAPI name", which is different from "canonical name" defined in GetCanonicalTypeName. The "canonical name" defined in GetCanonicalTypeName means Go type names with full package path.

Examples of REST friendly OpenAPI name:

Input:  k8s.io/api/core/v1.Pod
Output: io.k8s.api.core.v1.Pod

Input:  k8s.io/api/core/v1
Output: io.k8s.api.core.v1

Input:  csi.storage.k8s.io/v1alpha1.CSINodeInfo
Output: io.k8s.storage.csi.v1alpha1.CSINodeInfo

func ToRESTFriendlyName

func ToRESTFriendlyName(name string) string

ToRESTFriendlyName converts Golang package/type canonical name into REST friendly OpenAPI name.

Examples of REST friendly OpenAPI name:

Input:  k8s.io/api/core/v1.Pod
Output: io.k8s.api.core.v1.Pod

Input:  k8s.io/api/core/v1
Output: io.k8s.api.core.v1

Input:  csi.storage.k8s.io/v1alpha1.CSINodeInfo
Output: io.k8s.storage.csi.v1alpha1.CSINodeInfo

Types

type OpenAPICanonicalTypeNamer

type OpenAPICanonicalTypeNamer interface {
	OpenAPICanonicalTypeName() string
}

OpenAPICanonicalTypeNamer is an interface for models without Go type to seed model name.

OpenAPI canonical names are Go type names with full package path, for uniquely indentifying a model / Go type. If a Go type is vendored from another package, only the path after "/vendor/" should be used. For custom resource definition (CRD), the canonical name is expected to be

group/version.kind

Examples of canonical name:

Go type: k8s.io/kubernetes/pkg/apis/core.Pod
CRD:     csi.storage.k8s.io/v1alpha1.CSINodeInfo

Example for vendored Go type:

Original full path:  k8s.io/kubernetes/vendor/k8s.io/api/core/v1.Pod
Canonical name:      k8s.io/api/core/v1.Pod

Original full path:  vendor/k8s.io/api/core/v1.Pod
Canonical name:      k8s.io/api/core/v1.Pod

type Trie

type Trie struct {
	// contains filtered or unexported fields
}

A simple trie implementation with Add and HasPrefix methods only.

func NewTrie

func NewTrie(list []string) Trie

NewTrie creates a Trie and add all strings in the provided list to it.

func (*Trie) Add

func (t *Trie) Add(v string)

Add adds a word to this trie

func (*Trie) GetPrefix

func (t *Trie) GetPrefix(v string) (string, bool)

GetPrefix is like HasPrefix but return the prefix in case of match or empty string otherwise.

func (*Trie) HasPrefix

func (t *Trie) HasPrefix(v string) bool

HasPrefix returns true of v has any of the prefixes stored in this trie.