Documentation
¶
Index ¶
- func NodeJSClient(swagger map[string]interface{}, templateDir string) (inputsts, providerts string, err error)
- type GroupConfig
- type KindConfig
- func (kc *KindConfig) APIVersion() string
- func (kc *KindConfig) Comment() string
- func (kc *KindConfig) HasMeta() bool
- func (kc *KindConfig) Kind() string
- func (kc *KindConfig) OptionalProperties() []*Property
- func (kc *KindConfig) Properties() []*Property
- func (kc *KindConfig) RawAPIVersion() string
- func (kc *KindConfig) RequiredProperties() []*Property
- func (kc *KindConfig) TypeGuard() string
- func (kc *KindConfig) URNAPIVersion() string
- type Property
- type VersionConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type GroupConfig ¶
type GroupConfig struct {
// contains filtered or unexported fields
}
GroupConfig represents a Kubernetes API group (e.g., core, apps, extensions, etc.)
func (*GroupConfig) Group ¶
func (gc *GroupConfig) Group() string
Group returns the name of the group (e.g., `core` for core, etc.)
func (*GroupConfig) Versions ¶
func (gc *GroupConfig) Versions() []*VersionConfig
Versions returns the set of version for some Kubernetes API group. For example, the `apps` group has `v1beta1`, `v1beta2`, and `v1`.
type KindConfig ¶
type KindConfig struct {
// contains filtered or unexported fields
}
KindConfig represents a Kubernetes API kind (e.g., the `Deployment` type in `apps/v1beta1/Deployment`).
func (*KindConfig) APIVersion ¶
func (kc *KindConfig) APIVersion() string
APIVersion returns the fully-qualified apiVersion (e.g., `storage.k8s.io/v1` for storage, etc.)
func (*KindConfig) Comment ¶
func (kc *KindConfig) Comment() string
Comment returns the comments associated with some Kubernetes API kind.
func (*KindConfig) HasMeta ¶
func (kc *KindConfig) HasMeta() bool
HasMeta encodes if the object has a Meta field.
func (*KindConfig) Kind ¶
func (kc *KindConfig) Kind() string
Kind returns the name of the Kubernetes API kind (e.g., `Deployment` for `apps/v1beta1/Deployment`).
func (*KindConfig) OptionalProperties ¶
func (kc *KindConfig) OptionalProperties() []*Property
OptionalProperties returns the list of properties that are optional on some Kubernetes API kind (i.e., things that we will want to `.` into, like `thing.apiVersion`, `thing.kind`, `thing.metadata`, etc.).
func (*KindConfig) Properties ¶
func (kc *KindConfig) Properties() []*Property
Properties returns the list of properties that exist on some Kubernetes API kind (i.e., things that we will want to `.` into, like `thing.apiVersion`, `thing.kind`, `thing.metadata`, etc.).
func (*KindConfig) RawAPIVersion ¶
func (kc *KindConfig) RawAPIVersion() string
RawAPIVersion returns the "raw" apiVersion (e.g., `v1` rather than `core/v1`).
func (*KindConfig) RequiredProperties ¶
func (kc *KindConfig) RequiredProperties() []*Property
RequiredProperties returns the list of properties that are required to exist on some Kubernetes API kind (i.e., things that we will want to `.` into, like `thing.apiVersion`, `thing.kind`, `thing.metadata`, etc.).
func (*KindConfig) TypeGuard ¶
func (kc *KindConfig) TypeGuard() string
TypeGuard returns the text of a TypeScript type guard for the given kind.
func (*KindConfig) URNAPIVersion ¶
func (kc *KindConfig) URNAPIVersion() string
URNAPIVersion returns API version that can be used in a URN (e.g., using the backwards-compatible alias `apiextensions` instead of `apiextensions.k8s.io`).
type Property ¶
type Property struct {
// contains filtered or unexported fields
}
Property represents a property we want to expose on a Kubernetes API kind (i.e., things that we will want to `.` into, like `thing.apiVersion`, `thing.kind`, `thing.metadata`, etc.).
func (*Property) DefaultValue ¶
DefaultValue returns the type of the property.
type VersionConfig ¶
type VersionConfig struct {
// contains filtered or unexported fields
}
VersionConfig represents a version of a Kubernetes API group (e.g., the `apps` group has `v1beta1`, `v1beta2`, and `v1`.)
func (*VersionConfig) APIVersion ¶
func (vc *VersionConfig) APIVersion() string
APIVersion returns the fully-qualified apiVersion (e.g., `storage.k8s.io/v1` for storage, etc.)
func (*VersionConfig) Kinds ¶
func (vc *VersionConfig) Kinds() []*KindConfig
Kinds returns the set of kinds in some Kubernetes API group/version combination (e.g., `apps/v1beta1` has the `Deployment` kind, etc.).
func (*VersionConfig) KindsAndAliases ¶
func (vc *VersionConfig) KindsAndAliases() []*KindConfig
KindsAndAliases will produce a list of kinds, including aliases (e.g., both `apiregistration` and `apiregistration.k8s.io`).
func (*VersionConfig) ListKindsAndAliases ¶
func (vc *VersionConfig) ListKindsAndAliases() []*KindConfig
ListKindsAndAliases will return all known `Kind`s that are lists, or aliases of lists. These `Kind`s are not instantiated by the API server, and we must "flatten" them client-side to get an accurate view of what resource operations we need to perform.
func (*VersionConfig) RawAPIVersion ¶
func (vc *VersionConfig) RawAPIVersion() string
RawAPIVersion returns the "raw" apiVersion (e.g., `v1` rather than `core/v1`).
func (*VersionConfig) Version ¶
func (vc *VersionConfig) Version() string
Version returns the name of the version (e.g., `apps/v1beta1` would return `v1beta1`).
Source Files