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.7.0 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.7.0 DO NOT EDIT.
Index ¶
- func GetSpec() (swagger *openapi3.T, err error)
- func GetSpecJSON() ([]byte, error)
- func GetSwagger() (*openapi3.T, error)deprecated
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type AlreadyExists
- type BadRequest
- type CatalogItem
- type CatalogItemIdPath
- type CatalogItemInstance
- type CatalogItemInstanceIdPath
- type CatalogItemInstanceList
- type CatalogItemInstanceSpec
- type CatalogItemList
- type CatalogItemSpec
- type CreateCatalogItemInstanceJSONRequestBody
- type CreateCatalogItemInstanceParams
- type CreateCatalogItemJSONRequestBody
- type CreateCatalogItemParams
- type CreateServiceTypeJSONRequestBody
- type CreateServiceTypeParams
- type Error
- type ErrorType
- type FieldConfiguration
- type FieldConfigurationDependsOn
- type Forbidden
- type HasInstances
- type InternalServerError
- type ListCatalogItemInstancesParams
- type ListCatalogItemsParams
- type ListServiceTypesParams
- type NotFound
- type PolicyDependency
- type PolicyRejected
- type ProviderError
- type ServiceType
- type ServiceTypeIdPath
- type ServiceTypeList
- type Unauthorized
- type UpdateCatalogItemApplicationMergePatchPlusJSONRequestBody
- type UserValue
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSpec ¶
GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.
func GetSpecJSON ¶
GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.
func GetSwagger
deprecated
Types ¶
type AlreadyExists ¶
type AlreadyExists = Error
AlreadyExists Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type BadRequest ¶
type BadRequest = Error
BadRequest Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type CatalogItem ¶
type CatalogItem struct {
// ApiVersion Version of the CatalogItem schema itself (e.g., v1alpha1).
// Immutable after creation.
ApiVersion *string `json:"api_version,omitempty"`
// CreateTime Timestamp when the catalog item was created (RFC 3339)
CreateTime *time.Time `json:"create_time,omitempty"`
// DisplayName User-friendly display name for the catalog item.
// Mutable and does not need to be unique.
DisplayName *string `json:"display_name,omitempty"`
// Path Resource path in the format: catalog-items/{catalogItemId}
Path *string `json:"path,omitempty"`
// Spec Specification for a catalog item, defining the service type reference
// and field configurations.
Spec *CatalogItemSpec `json:"spec,omitempty"`
// Uid Unique identifier for the catalog item. This field is output-only and
// immutable after creation. The ID can be optionally specified via
// query parameter on creation; if not provided, the server generates a UUID.
//
// Follows AEP-122 resource ID conventions.
Uid *string `json:"uid,omitempty"`
// UpdateTime Timestamp when the catalog item was last modified (RFC 3339)
UpdateTime *time.Time `json:"update_time,omitempty"`
}
CatalogItem defines model for CatalogItem.
type CatalogItemIdPath ¶
type CatalogItemIdPath = string
CatalogItemIdPath defines model for CatalogItemIdPath.
type CatalogItemInstance ¶
type CatalogItemInstance struct {
// ApiVersion Version of the CatalogItemInstance schema itself (e.g., v1alpha1).
// Immutable after creation.
ApiVersion string `json:"api_version"`
// CreateTime Timestamp when the catalog item was created (RFC 3339)
CreateTime *time.Time `json:"create_time,omitempty"`
// DisplayName User-friendly display name for the catalog item instance.
// Mutable and does not need to be unique.
DisplayName string `json:"display_name"`
// Path Resource path in the format: catalog-item-instances/{catalogItemInstanceId}
Path *string `json:"path,omitempty"`
// ResourceId Unique identifier for the resource in the Placement Manager.
// This field is output-only and set by the server during creation.
ResourceId *string `json:"resource_id,omitempty"`
// Spec Specification for a catalog item instance, defining the catalog item reference
// and field configurations.
Spec CatalogItemInstanceSpec `json:"spec"`
// Uid Unique identifier for the catalog item instance. This field is output-only and
// immutable after creation. The ID can be optionally specified via
// query parameter on creation; if not provided, the server generates a UUID.
//
// Follows AEP-122 resource ID conventions.
Uid *string `json:"uid,omitempty"`
// UpdateTime Timestamp when the catalog item was last modified (RFC 3339)
UpdateTime *time.Time `json:"update_time,omitempty"`
}
CatalogItemInstance defines model for CatalogItemInstance.
type CatalogItemInstanceIdPath ¶
type CatalogItemInstanceIdPath = string
CatalogItemInstanceIdPath defines model for CatalogItemInstanceIdPath.
type CatalogItemInstanceList ¶
type CatalogItemInstanceList struct {
// NextPageToken Token for retrieving the next page.
// Empty string indicates this is the last page.
NextPageToken string `json:"next_page_token"`
// Results Array of catalog item instance resources
Results []CatalogItemInstance `json:"results"`
}
CatalogItemInstanceList defines model for CatalogItemInstanceList.
type CatalogItemInstanceSpec ¶
type CatalogItemInstanceSpec struct {
// CatalogItemId The Catalog item ID this catalog item instance references.
// Immutable after creation.
CatalogItemId string `json:"catalog_item_id"`
// UserValues Array of user values for this catalog item instance.
UserValues []UserValue `json:"user_values"`
}
CatalogItemInstanceSpec Specification for a catalog item instance, defining the catalog item reference and field configurations.
type CatalogItemList ¶
type CatalogItemList struct {
// NextPageToken Token for retrieving the next page.
// Empty string indicates this is the last page.
NextPageToken string `json:"next_page_token"`
// Results Array of catalog item resources
Results []CatalogItem `json:"results"`
}
CatalogItemList defines model for CatalogItemList.
type CatalogItemSpec ¶
type CatalogItemSpec struct {
// Fields Array of field configurations for this catalog item.
// Each configuration defines constraints and defaults for fields
// in the service type specification.
Fields *[]FieldConfiguration `json:"fields,omitempty"`
// ServiceType The Service type this catalog item references.
// Immutable after creation.
ServiceType *string `json:"service_type,omitempty"`
}
CatalogItemSpec Specification for a catalog item, defining the service type reference and field configurations.
type CreateCatalogItemInstanceJSONRequestBody ¶
type CreateCatalogItemInstanceJSONRequestBody = CatalogItemInstance
CreateCatalogItemInstanceJSONRequestBody defines body for CreateCatalogItemInstance for application/json ContentType.
type CreateCatalogItemInstanceParams ¶
type CreateCatalogItemInstanceParams struct {
// Id Optional user-specified catalog item instance ID
Id *string `form:"id,omitempty" json:"id,omitempty"`
}
CreateCatalogItemInstanceParams defines parameters for CreateCatalogItemInstance.
type CreateCatalogItemJSONRequestBody ¶
type CreateCatalogItemJSONRequestBody = CatalogItem
CreateCatalogItemJSONRequestBody defines body for CreateCatalogItem for application/json ContentType.
type CreateCatalogItemParams ¶
type CreateCatalogItemParams struct {
// Id Optional user-specified catalog item ID
Id *string `form:"id,omitempty" json:"id,omitempty"`
}
CreateCatalogItemParams defines parameters for CreateCatalogItem.
type CreateServiceTypeJSONRequestBody ¶
type CreateServiceTypeJSONRequestBody = ServiceType
CreateServiceTypeJSONRequestBody defines body for CreateServiceType for application/json ContentType.
type CreateServiceTypeParams ¶
type CreateServiceTypeParams struct {
// Id Optional user-specified ID for the service type.
// Must follow DNS-1123 label format (lowercase alphanumeric with hyphens).
// If omitted, the server generates an ID.
Id *string `form:"id,omitempty" json:"id,omitempty"`
}
CreateServiceTypeParams defines parameters for CreateServiceType.
type Error ¶
type Error struct {
// Detail Human-readable explanation specific to this occurrence of the error.
// May contain request-specific details to help debug the issue.
Detail *string `json:"detail,omitempty"`
// Instance Unique identifier for this specific error occurrence.
// Can be used for tracking and debugging.
Instance *string `json:"instance,omitempty"`
// Status HTTP status code (matches the response status)
Status int32 `json:"status"`
// Title Short, human-readable summary of the error type.
// Should be consistent across occurrences of the same error type.
Title string `json:"title"`
// Type Machine-readable error code. Uses AEP standard error codes.
Type ErrorType `json:"type"`
}
Error Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type ErrorType ¶
type ErrorType string
ErrorType Machine-readable error code. Uses AEP standard error codes.
const ( ABORTED ErrorType = "ABORTED" ALREADYEXISTS ErrorType = "ALREADY_EXISTS" DEADLINEEXCEEDED ErrorType = "DEADLINE_EXCEEDED" FAILEDPRECONDITION ErrorType = "FAILED_PRECONDITION" INTERNAL ErrorType = "INTERNAL" INVALIDARGUMENT ErrorType = "INVALID_ARGUMENT" NOTFOUND ErrorType = "NOT_FOUND" OUTOFRANGE ErrorType = "OUT_OF_RANGE" PERMISSIONDENIED ErrorType = "PERMISSION_DENIED" RESOURCEEXHAUSTED ErrorType = "RESOURCE_EXHAUSTED" UNAUTHENTICATED ErrorType = "UNAUTHENTICATED" UNAVAILABLE ErrorType = "UNAVAILABLE" UNIMPLEMENTED ErrorType = "UNIMPLEMENTED" )
Defines values for ErrorType.
type FieldConfiguration ¶
type FieldConfiguration struct {
// Default Default value for this field.
// Type depends on the field's schema (can be string, number, boolean, object, array).
// If editable=false, this is the fixed value.
// If editable=true, this is the initial/suggested value.
Default interface{} `json:"default,omitempty"`
// DependsOn Conditional default or options. This field's value depends on another field.
// - For fixed fields: allowedValues[K] is the default when source has K.
// - For editable fields: allowedValues[K] is the array of options when source has K.
// Resolved client-side based on user selections.
DependsOn *FieldConfigurationDependsOn `json:"depends_on,omitempty"`
// DisplayName User-facing label for this field in UI/CLI.
// If omitted, derived from the path (e.g., "spec.vcpu.count" → "Vcpu Count").
DisplayName *string `json:"display_name,omitempty"`
// Editable Whether end users can modify this field value when requesting services.
// If false, the field is fixed to the default value.
Editable *bool `json:"editable,omitempty"`
// Path JSON path to the field in the ServiceType spec using dot notation.
// Examples: "spec.vcpu.count", "spec.memory.size_gb", "metadata.labels.tier"
Path string `json:"path"`
// ValidationSchema JSON Schema constraints for validating this field (draft 2020-12).
// Only applicable when editable=true.
// Supports standard JSON Schema keywords: type, minimum, maximum,
// pattern, enum, minLength, maxLength, etc.
//
// Reference: https://json-schema.org/draft/2020-12/json-schema-validation
ValidationSchema *map[string]interface{} `json:"validation_schema,omitempty"`
}
FieldConfiguration defines model for FieldConfiguration.
type FieldConfigurationDependsOn ¶
type FieldConfigurationDependsOn struct {
// AllowedValues Map from source field value (string key K) to options for this field.
// If the field at path equals key K, this field's options are at allowed_values[K].
// Type is map[string][]any: keys are strings, values are arrays of any (e.g. strings or objects).
AllowedValues map[string][]interface{} `json:"allowed_values"`
// Path JSON path of the field this one depends on (e.g., region).
Path string `json:"path"`
}
FieldConfigurationDependsOn Conditional default or options. This field's value depends on another field. - For fixed fields: allowedValues[K] is the default when source has K. - For editable fields: allowedValues[K] is the array of options when source has K. Resolved client-side based on user selections.
type Forbidden ¶
type Forbidden = Error
Forbidden Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type HasInstances ¶
type HasInstances = Error
HasInstances Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type InternalServerError ¶
type InternalServerError = Error
InternalServerError Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type ListCatalogItemInstancesParams ¶
type ListCatalogItemInstancesParams struct {
// PageToken Token for retrieving the next page of results
PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
// MaxPageSize Maximum number of items to return per page
MaxPageSize *int32 `form:"max_page_size,omitempty" json:"max_page_size,omitempty"`
// CatalogItemId Filter catalog item instances by catalog item ID.
// Only returns items where spec.catalog_item_id matches this value.
CatalogItemId *string `form:"catalog_item_id,omitempty" json:"catalog_item_id,omitempty"`
}
ListCatalogItemInstancesParams defines parameters for ListCatalogItemInstances.
type ListCatalogItemsParams ¶
type ListCatalogItemsParams struct {
// PageToken Token for retrieving the next page of results
PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
// MaxPageSize Maximum number of items to return per page
MaxPageSize *int32 `form:"max_page_size,omitempty" json:"max_page_size,omitempty"`
// ServiceType Filter catalog items by service type.
// Only returns items where spec.service_type matches this value.
ServiceType *string `form:"service_type,omitempty" json:"service_type,omitempty"`
}
ListCatalogItemsParams defines parameters for ListCatalogItems.
type ListServiceTypesParams ¶
type ListServiceTypesParams struct {
// PageToken Token for retrieving the next page of results.
// Obtained from the next_page_token field of a previous response.
PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
// MaxPageSize Maximum number of items to return per page.
// If not specified, defaults to 100.
MaxPageSize *int32 `form:"max_page_size,omitempty" json:"max_page_size,omitempty"`
}
ListServiceTypesParams defines parameters for ListServiceTypes.
type NotFound ¶
type NotFound = Error
NotFound Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type PolicyDependency ¶
type PolicyDependency = Error
PolicyDependency Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type PolicyRejected ¶
type PolicyRejected = Error
PolicyRejected Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type ProviderError ¶
type ProviderError = Error
ProviderError Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type ServiceType ¶
type ServiceType struct {
// ApiVersion Version of the service type schema (e.g., v1alpha1, v1beta1, v1).
// Immutable after creation.
ApiVersion string `json:"api_version"`
// CreateTime Timestamp when the resource was created (RFC 3339)
CreateTime *time.Time `json:"create_time,omitempty"`
Metadata *struct {
// Labels Key-value pairs for categorization and filtering.
// Both keys and values are strings.
Labels *map[string]string `json:"labels,omitempty"`
} `json:"metadata,omitempty"`
// Path Resource path in the format: service-types/{serviceTypeId}
// This is the canonical identifier for the resource.
Path *string `json:"path,omitempty"`
// ServiceType Classification of the service type.
// Common values include: vm, container, database, cluster.
// Administrators may define custom types beyond these.
ServiceType string `json:"service_type"`
// Spec Service-specific configuration schema (required).
// This is an opaque dictionary containing service type-specific fields.
//
// Examples by service type:
// - VM: vcpu, memory, storage, guest_os, access
// - Container: image, resources, process, network
// - Database: engine, version, resources
// - Cluster: version, nodes (control plane, workers)
//
// The structure varies based on the service_type and schema_version.
Spec map[string]interface{} `json:"spec"`
// Uid Unique identifier for the service type. This field is output-only and
// immutable after creation. The ID can be optionally specified via
// query parameter on creation; if not provided, the server generates a UUID.
//
// Follows AEP-122 resource ID conventions.
Uid *string `json:"uid,omitempty"`
// UpdateTime Timestamp when the resource was last modified (RFC 3339)
UpdateTime *time.Time `json:"update_time,omitempty"`
}
ServiceType defines model for ServiceType.
type ServiceTypeIdPath ¶
type ServiceTypeIdPath = string
ServiceTypeIdPath defines model for ServiceTypeIdPath.
type ServiceTypeList ¶
type ServiceTypeList struct {
// NextPageToken Token for retrieving the next page of results.
// Empty string indicates this is the last page.
// Opaque token - do not parse or construct manually.
NextPageToken string `json:"next_page_token"`
// Results Array of service type resources.
// May be empty if no results match the query.
Results []ServiceType `json:"results"`
}
ServiceTypeList defines model for ServiceTypeList.
type Unauthorized ¶
type Unauthorized = Error
Unauthorized Error response following RFC 7807 Problem Details for HTTP APIs and AEP-193 Error Responses specification.
type UpdateCatalogItemApplicationMergePatchPlusJSONRequestBody ¶
type UpdateCatalogItemApplicationMergePatchPlusJSONRequestBody = CatalogItem
UpdateCatalogItemApplicationMergePatchPlusJSONRequestBody defines body for UpdateCatalogItem for application/merge-patch+json ContentType.
type UserValue ¶
type UserValue struct {
// Path JSON path to the user value in the CatalogItem spec using dot notation.
// Examples: "spec.vcpu.count", "spec.memory.size_gb", "metadata.labels.tier"
Path string `json:"path"`
// Value Value for this user value.
// Type depends on the field's schema (can be string, number, boolean, object, array).
Value interface{} `json:"value"`
}
UserValue defines model for UserValue.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package servicetypes provides primitives to interact with the openapi HTTP API.
|
Package servicetypes provides primitives to interact with the openapi HTTP API. |
|
cluster
Package cluster provides primitives to interact with the openapi HTTP API.
|
Package cluster provides primitives to interact with the openapi HTTP API. |
|
container
Package container provides primitives to interact with the openapi HTTP API.
|
Package container provides primitives to interact with the openapi HTTP API. |
|
database
Package database provides primitives to interact with the openapi HTTP API.
|
Package database provides primitives to interact with the openapi HTTP API. |
|
three_tier_app_demo
Package three_tier_app_demo provides primitives to interact with the openapi HTTP API.
|
Package three_tier_app_demo provides primitives to interact with the openapi HTTP API. |
|
vm
Package vm provides primitives to interact with the openapi HTTP API.
|
Package vm provides primitives to interact with the openapi HTTP API. |