Documentation
¶
Overview ¶
Package v1alpha1 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Package v1alpha1 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type ApiVersion
- type Catalog
- type CatalogItem
- type CatalogItemArtifact
- type CatalogItemArtifactType
- type CatalogItemCategory
- type CatalogItemConfigurable
- type CatalogItemDeprecation
- type CatalogItemList
- type CatalogItemMeta
- type CatalogItemReference
- type CatalogItemSpec
- type CatalogItemType
- type CatalogItemVersion
- func (t CatalogItemVersion) AsCatalogItemVersion0() (CatalogItemVersion0, error)
- func (t CatalogItemVersion) AsCatalogItemVersion1() (CatalogItemVersion1, error)
- func (t *CatalogItemVersion) FromCatalogItemVersion0(v CatalogItemVersion0) error
- func (t *CatalogItemVersion) FromCatalogItemVersion1(v CatalogItemVersion1) error
- func (t CatalogItemVersion) MarshalJSON() ([]byte, error)
- func (t *CatalogItemVersion) MergeCatalogItemVersion0(v CatalogItemVersion0) error
- func (t *CatalogItemVersion) MergeCatalogItemVersion1(v CatalogItemVersion1) error
- func (t *CatalogItemVersion) UnmarshalJSON(b []byte) error
- type CatalogItemVersion0
- type CatalogItemVersion1
- type CatalogItemVisibility
- type CatalogList
- type CatalogSpec
- type CatalogStatus
- type CreateCatalogItemJSONRequestBody
- type CreateCatalogJSONRequestBody
- type ListAllCatalogItemsParams
- type ListCatalogItemsParams
- type ListCatalogsParams
- type PatchCatalogApplicationJSONPatchPlusJSONRequestBody
- type PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody
- type ReplaceCatalogItemJSONRequestBody
- type ReplaceCatalogJSONRequestBody
- type ReplaceCatalogStatusJSONRequestBody
- type Status
Constants ¶
const ( StatusKind = "Status" CatalogAPIVersion = "v1alpha1" CatalogKind = "Catalog" CatalogListKind = "CatalogList" CatalogItemKind = "CatalogItem" CatalogItemListKind = "CatalogItemList" )
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
Types ¶
type ApiVersion ¶
type ApiVersion = string
ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
type Catalog ¶
type Catalog struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Metadata ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
Metadata externalRef0.ObjectMeta `json:"metadata"`
// Spec CatalogSpec describes the configuration of a catalog. Catalogs are containers for locally-managed CatalogItems.
Spec CatalogSpec `json:"spec"`
// Status CatalogStatus represents the current status of a catalog source.
Status *CatalogStatus `json:"status,omitempty"`
}
Catalog defines model for Catalog.
func (*Catalog) ValidateUpdate ¶
ValidateUpdate ensures immutable fields are unchanged for Catalog.
type CatalogItem ¶
type CatalogItem struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Kind Kind is a string value representing the REST resource this object represents.
Kind string `json:"kind"`
// Metadata Metadata for CatalogItem resources. Extends ObjectMeta with catalog scoping.
Metadata CatalogItemMeta `json:"metadata"`
// Spec CatalogItemSpec defines the configuration for a catalog item.
Spec CatalogItemSpec `json:"spec"`
}
CatalogItem CatalogItem represents an application template from a catalog. It provides default configuration values that can be customized when adding the application to a fleet.
func (CatalogItem) Validate ¶
func (ci CatalogItem) Validate() []error
type CatalogItemArtifact ¶
type CatalogItemArtifact struct {
// Name Optional human-readable display name for this artifact.
Name *string `json:"name,omitempty"`
// Type Type of artifact format. Includes bootc-image-builder output formats. Defaults to container if only one artifact.
Type *CatalogItemArtifactType `json:"type,omitempty"`
// Uri Artifact URI (OCI reference, URL, S3 path, etc.).
Uri string `json:"uri"`
}
CatalogItemArtifact An alternative artifact format.
type CatalogItemArtifactType ¶
type CatalogItemArtifactType string
CatalogItemArtifactType Type of artifact format. Includes bootc-image-builder output formats. Defaults to container if only one artifact.
const ( CatalogItemArtifactTypeAmi CatalogItemArtifactType = "ami" CatalogItemArtifactTypeAnacondaIso CatalogItemArtifactType = "anaconda-iso" CatalogItemArtifactTypeContainer CatalogItemArtifactType = "container" CatalogItemArtifactTypeGce CatalogItemArtifactType = "gce" CatalogItemArtifactTypeIso CatalogItemArtifactType = "iso" CatalogItemArtifactTypeQcow2 CatalogItemArtifactType = "qcow2" CatalogItemArtifactTypeRaw CatalogItemArtifactType = "raw" CatalogItemArtifactTypeVhd CatalogItemArtifactType = "vhd" CatalogItemArtifactTypeVmdk CatalogItemArtifactType = "vmdk" )
Defines values for CatalogItemArtifactType.
type CatalogItemCategory ¶
type CatalogItemCategory string
CatalogItemCategory Category of a catalog item.
const ( CatalogItemCategoryApplication CatalogItemCategory = "application" CatalogItemCategorySystem CatalogItemCategory = "system" )
Defines values for CatalogItemCategory.
type CatalogItemConfigurable ¶
type CatalogItemConfigurable struct {
// Config Configuration values (envVars, ports, volumes, resources, etc.).
Config *map[string]interface{} `json:"config,omitempty"`
// ConfigSchema JSON Schema defining configurable parameters and their validation.
ConfigSchema *map[string]interface{} `json:"configSchema,omitempty"`
// Readme Detailed documentation, preferably in markdown format.
Readme *string `json:"readme,omitempty"`
}
CatalogItemConfigurable Configuration fields that can be specified at item level (as defaults) and overridden at version level. Version-level values fully replace item-level values (not merged).
type CatalogItemDeprecation ¶
type CatalogItemDeprecation struct {
// Message Required message explaining why this is deprecated and what to do instead.
Message string `json:"message"`
// Replacement Optional name of the replacement catalog item (item-level only).
Replacement *string `json:"replacement,omitempty"`
}
CatalogItemDeprecation Deprecation information for a catalog item or version. Presence indicates deprecated status.
type CatalogItemList ¶
type CatalogItemList struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Items List of CatalogItems.
Items []CatalogItem `json:"items"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
Metadata externalRef0.ListMeta `json:"metadata"`
}
CatalogItemList CatalogItemList is a list of CatalogItems.
type CatalogItemMeta ¶
type CatalogItemMeta struct {
// Annotations Properties set by the service.
Annotations *map[string]string `json:"annotations,omitempty"`
// Catalog The catalog this item belongs to. Similar to namespace in Kubernetes.
Catalog string `json:"catalog"`
// CreationTimestamp The time the object was created.
CreationTimestamp *time.Time `json:"creationTimestamp,omitempty"`
// DeletionTimestamp The time the object will be deleted.
DeletionTimestamp *time.Time `json:"deletionTimestamp,omitempty"`
// Generation A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
Generation *int64 `json:"generation,omitempty"`
// Labels Map of string keys and values that can be used to organize and categorize (scope and select) objects.
Labels *map[string]string `json:"labels,omitempty"`
// Name The name of the object.
Name *string `json:"name,omitempty"`
// Owner A resource that owns this resource, in "kind/name" format.
Owner *string `json:"owner,omitempty"`
// ResourceVersion An opaque string that identifies the server's internal version of an object.
ResourceVersion *string `json:"resourceVersion,omitempty"`
}
CatalogItemMeta defines model for CatalogItemMeta.
type CatalogItemReference ¶
type CatalogItemReference struct {
// Artifacts Alternative artifact formats (e.g., qcow2, ISO for bootc images).
Artifacts *[]CatalogItemArtifact `json:"artifacts,omitempty"`
// Uri Primary artifact URI without version tag. Supports OCI references, URLs, S3 paths, etc.
Uri string `json:"uri"`
}
CatalogItemReference Reference to the primary artifact and optional alternative formats.
type CatalogItemSpec ¶
type CatalogItemSpec struct {
// Category Category of a catalog item.
Category *CatalogItemCategory `json:"category,omitempty"`
// Defaults Configuration fields that can be specified at item level (as defaults) and overridden at version level. Version-level values fully replace item-level values (not merged).
Defaults *CatalogItemConfigurable `json:"defaults,omitempty"`
// Deprecation Deprecation information for a catalog item or version. Presence indicates deprecated status.
Deprecation *CatalogItemDeprecation `json:"deprecation,omitempty"`
// DisplayName Human-readable display name shown in catalog listings.
DisplayName *string `json:"displayName,omitempty"`
// DocumentationUrl Link to external documentation.
DocumentationUrl *string `json:"documentationUrl,omitempty"`
// Homepage The homepage URL for the catalog item project.
Homepage *string `json:"homepage,omitempty"`
// Icon URL or data URI of the catalog item icon for display in UI.
Icon *string `json:"icon,omitempty"`
// Provider Provider or publisher of the catalog item (company or team name).
Provider *string `json:"provider,omitempty"`
// Reference Reference to the primary artifact and optional alternative formats.
Reference CatalogItemReference `json:"reference"`
// ShortDescription A brief one-line description of the catalog item.
ShortDescription *string `json:"shortDescription,omitempty"`
// Support Link to support resources or documentation for getting help.
Support *string `json:"support,omitempty"`
// Type Type of catalog item within its category.
Type CatalogItemType `json:"type"`
// Versions Available versions using Cincinnati model. Use replaces for primary edge, skips when stable channel skips intermediate versions.
Versions []CatalogItemVersion `json:"versions"`
// Visibility Visibility controls who can see and use the catalog item.
Visibility *CatalogItemVisibility `json:"visibility,omitempty"`
}
CatalogItemSpec CatalogItemSpec defines the configuration for a catalog item.
type CatalogItemType ¶
type CatalogItemType string
CatalogItemType Type of catalog item within its category.
const ( CatalogItemTypeCompose CatalogItemType = "compose" CatalogItemTypeContainer CatalogItemType = "container" CatalogItemTypeData CatalogItemType = "data" CatalogItemTypeDriver CatalogItemType = "driver" CatalogItemTypeFirmware CatalogItemType = "firmware" CatalogItemTypeHelm CatalogItemType = "helm" CatalogItemTypeOS CatalogItemType = "os" CatalogItemTypeQuadlet CatalogItemType = "quadlet" )
Defines values for CatalogItemType.
type CatalogItemVersion ¶
type CatalogItemVersion struct {
// Channels Channels this version belongs to.
Channels []string `json:"channels"`
// Config Configuration values (envVars, ports, volumes, resources, etc.).
Config *map[string]interface{} `json:"config,omitempty"`
// ConfigSchema JSON Schema defining configurable parameters and their validation.
ConfigSchema *map[string]interface{} `json:"configSchema,omitempty"`
// Deprecation Deprecation information for a catalog item or version. Presence indicates deprecated status.
Deprecation *CatalogItemDeprecation `json:"deprecation,omitempty"`
// Digest OCI digest for immutable reference. Mutually exclusive with tag. Format: sha256:...
Digest *string `json:"digest,omitempty"`
// Readme Detailed documentation, preferably in markdown format.
Readme *string `json:"readme,omitempty"`
// Replaces The single version this one replaces, defining the primary upgrade edge.
Replaces *string `json:"replaces,omitempty"`
// SkipRange Semver range of versions that can upgrade directly to this one. Use for z-stream updates or hotfixes.
SkipRange *string `json:"skipRange,omitempty"`
// Skips Additional versions that can upgrade directly to this one. Use when stable channel skips intermediate fast-only versions.
Skips *[]string `json:"skips,omitempty"`
// Tag Image tag to pull. Mutually exclusive with digest.
Tag *string `json:"tag,omitempty"`
// Version Semantic version identifier (e.g., 1.2.3, v2.0.0-rc1). Required for version ordering and upgrade graph.
Version string `json:"version"`
// contains filtered or unexported fields
}
CatalogItemVersion defines model for CatalogItemVersion.
func (CatalogItemVersion) AsCatalogItemVersion0 ¶
func (t CatalogItemVersion) AsCatalogItemVersion0() (CatalogItemVersion0, error)
AsCatalogItemVersion0 returns the union data inside the CatalogItemVersion as a CatalogItemVersion0
func (CatalogItemVersion) AsCatalogItemVersion1 ¶
func (t CatalogItemVersion) AsCatalogItemVersion1() (CatalogItemVersion1, error)
AsCatalogItemVersion1 returns the union data inside the CatalogItemVersion as a CatalogItemVersion1
func (*CatalogItemVersion) FromCatalogItemVersion0 ¶
func (t *CatalogItemVersion) FromCatalogItemVersion0(v CatalogItemVersion0) error
FromCatalogItemVersion0 overwrites any union data inside the CatalogItemVersion as the provided CatalogItemVersion0
func (*CatalogItemVersion) FromCatalogItemVersion1 ¶
func (t *CatalogItemVersion) FromCatalogItemVersion1(v CatalogItemVersion1) error
FromCatalogItemVersion1 overwrites any union data inside the CatalogItemVersion as the provided CatalogItemVersion1
func (CatalogItemVersion) MarshalJSON ¶
func (t CatalogItemVersion) MarshalJSON() ([]byte, error)
func (*CatalogItemVersion) MergeCatalogItemVersion0 ¶
func (t *CatalogItemVersion) MergeCatalogItemVersion0(v CatalogItemVersion0) error
MergeCatalogItemVersion0 performs a merge with any union data inside the CatalogItemVersion, using the provided CatalogItemVersion0
func (*CatalogItemVersion) MergeCatalogItemVersion1 ¶
func (t *CatalogItemVersion) MergeCatalogItemVersion1(v CatalogItemVersion1) error
MergeCatalogItemVersion1 performs a merge with any union data inside the CatalogItemVersion, using the provided CatalogItemVersion1
func (*CatalogItemVersion) UnmarshalJSON ¶
func (t *CatalogItemVersion) UnmarshalJSON(b []byte) error
type CatalogItemVersion0 ¶
type CatalogItemVersion0 = interface{}
CatalogItemVersion0 defines model for .
type CatalogItemVersion1 ¶
type CatalogItemVersion1 = interface{}
CatalogItemVersion1 defines model for .
type CatalogItemVisibility ¶
type CatalogItemVisibility string
CatalogItemVisibility Visibility controls who can see and use the catalog item.
const ( CatalogItemVisibilityDraft CatalogItemVisibility = "draft" CatalogItemVisibilityPublished CatalogItemVisibility = "published" )
Defines values for CatalogItemVisibility.
type CatalogList ¶
type CatalogList struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Items List of Catalogs.
Items []Catalog `json:"items"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
Metadata externalRef0.ListMeta `json:"metadata"`
}
CatalogList CatalogList is a list of Catalogs.
type CatalogSpec ¶
type CatalogSpec struct {
// DisplayName Human-readable display name shown in catalog listings.
DisplayName *string `json:"displayName,omitempty"`
// Icon URL or data URI of the catalog icon for display in UI.
Icon *string `json:"icon,omitempty"`
// Provider Provider or publisher of the catalog (company or team name).
Provider *string `json:"provider,omitempty"`
// ShortDescription A brief one-line description of the catalog.
ShortDescription *string `json:"shortDescription,omitempty"`
// Support Link to support resources or documentation for getting help.
Support *string `json:"support,omitempty"`
// Visibility Visibility controls who can see and use the catalog item.
Visibility *CatalogItemVisibility `json:"visibility,omitempty"`
}
CatalogSpec CatalogSpec describes the configuration of a catalog. Catalogs are containers for locally-managed CatalogItems.
type CatalogStatus ¶
type CatalogStatus struct {
// Conditions Current state of the catalog source.
Conditions []externalRef0.Condition `json:"conditions"`
}
CatalogStatus CatalogStatus represents the current status of a catalog source.
type CreateCatalogItemJSONRequestBody ¶
type CreateCatalogItemJSONRequestBody = CatalogItem
CreateCatalogItemJSONRequestBody defines body for CreateCatalogItem for application/json ContentType.
type CreateCatalogJSONRequestBody ¶
type CreateCatalogJSONRequestBody = Catalog
CreateCatalogJSONRequestBody defines body for CreateCatalog for application/json ContentType.
type ListAllCatalogItemsParams ¶
type ListAllCatalogItemsParams struct {
// Continue An optional parameter to query more results from the server. The value of the parameter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// LabelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
ListAllCatalogItemsParams defines parameters for ListAllCatalogItems.
type ListCatalogItemsParams ¶
type ListCatalogItemsParams struct {
// Continue An optional parameter to query more results from the server.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// LabelSelector A selector to restrict the list of returned objects by their labels.
LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
// Limit The maximum number of results returned in the list response.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
ListCatalogItemsParams defines parameters for ListCatalogItems.
type ListCatalogsParams ¶
type ListCatalogsParams struct {
// Continue An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response.
Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
// LabelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`
// FieldSelector A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2").
FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`
// Limit The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
ListCatalogsParams defines parameters for ListCatalogs.
type PatchCatalogApplicationJSONPatchPlusJSONRequestBody ¶
type PatchCatalogApplicationJSONPatchPlusJSONRequestBody = externalRef0.PatchRequest
PatchCatalogApplicationJSONPatchPlusJSONRequestBody defines body for PatchCatalog for application/json-patch+json ContentType.
type PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody ¶
type PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody = externalRef0.PatchRequest
PatchCatalogStatusApplicationJSONPatchPlusJSONRequestBody defines body for PatchCatalogStatus for application/json-patch+json ContentType.
type ReplaceCatalogItemJSONRequestBody ¶
type ReplaceCatalogItemJSONRequestBody = CatalogItem
ReplaceCatalogItemJSONRequestBody defines body for ReplaceCatalogItem for application/json ContentType.
type ReplaceCatalogJSONRequestBody ¶
type ReplaceCatalogJSONRequestBody = Catalog
ReplaceCatalogJSONRequestBody defines body for ReplaceCatalog for application/json ContentType.
type ReplaceCatalogStatusJSONRequestBody ¶
type ReplaceCatalogStatusJSONRequestBody = Catalog
ReplaceCatalogStatusJSONRequestBody defines body for ReplaceCatalogStatus for application/json ContentType.
type Status ¶
type Status struct {
// ApiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
ApiVersion ApiVersion `json:"apiVersion"`
// Code Suggested HTTP return code for this status, 0 if not set.
Code int32 `json:"code"`
// Kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
Kind string `json:"kind"`
// Message A human-readable description of the status of this operation.
Message string `json:"message"`
// Reason A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
Reason string `json:"reason"`
// Status Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
Status string `json:"status"`
}
Status Status is a return value for calls that don't return other objects.