v1alpha1

package
v0.1.0-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 14, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

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.6.1-0.20260318123712-00a90b7a03f4 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.6.1-0.20260318123712-00a90b7a03f4 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

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.

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type CreateResourceJSONRequestBody

type CreateResourceJSONRequestBody = Resource

CreateResourceJSONRequestBody defines body for CreateResource for application/json ContentType.

type CreateResourceParams

type CreateResourceParams struct {
	// Id Optional ID for the resource
	Id *string `form:"id,omitempty" json:"id,omitempty"`
}

CreateResourceParams defines parameters for CreateResource.

type Error

type Error struct {
	// Detail Human-readable explanation specific to this occurrence
	Detail *string `json:"detail,omitempty"`

	// Instance URI reference for this specific error occurrence
	Instance *string `json:"instance,omitempty"`

	// Status HTTP status code
	Status *int `json:"status,omitempty"`

	// Title Short human-readable summary of the problem
	Title string `json:"title"`

	// Type URI reference identifying the error type
	Type string `json:"type"`
}

Error RFC 7807 compliant error response

type Health

type Health struct {
	// Path Canonical path of the resource
	Path *string `json:"path,omitempty"`

	// Status Health status
	Status string `json:"status"`
}

Health Health status singleton resource

type ListResourcesParams

type ListResourcesParams struct {
	// Provider Filter provider name
	Provider *string `form:"provider,omitempty" json:"provider,omitempty"`

	// MaxPageSize Maximum number of results per page
	MaxPageSize *int `form:"max_page_size,omitempty" json:"max_page_size,omitempty"`

	// PageToken Token for pagination
	PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
}

ListResourcesParams defines parameters for ListResources.

type RehydrateRequest

type RehydrateRequest struct {
	// NewResourceId The new resource ID to use for the rehydrated resource
	NewResourceId string `json:"new_resource_id"`
}

RehydrateRequest Request body for resource rehydration

type RehydrateResourceJSONRequestBody

type RehydrateResourceJSONRequestBody = RehydrateRequest

RehydrateResourceJSONRequestBody defines body for RehydrateResource for application/json ContentType.

type Resource

type Resource struct {
	// ApprovalStatus The approval status after the spec is validated by Policy Engine.
	ApprovalStatus *string `json:"approval_status,omitempty"`

	// CatalogItemInstanceId The unique identifier of the catalog item instance
	CatalogItemInstanceId string `json:"catalog_item_instance_id"`

	// CreateTime Timestamp when the resource was first created
	CreateTime *time.Time `json:"create_time,omitempty"`

	// Id Unique identifier for the Resource
	Id *string `json:"id,omitempty"`

	// Path Resource path identifier
	Path *string `json:"path,omitempty"`

	// ProviderName Name of the Service Provider
	ProviderName *string `json:"provider_name,omitempty"`

	// Spec Service specification following one of the supported service type
	// schemas (VMSpec, ContainerSpec, DatabaseSpec, or ClusterSpec).
	Spec map[string]interface{} `json:"spec"`

	// UpdateTime Timestamp when the resource was last updated
	UpdateTime *time.Time `json:"update_time,omitempty"`
}

Resource Full resource representation

type ResourceIdPath

type ResourceIdPath = string

ResourceIdPath defines model for ResourceIdPath.

type ResourceList

type ResourceList struct {
	// NextPageToken Token for retrieving the next page of results
	NextPageToken *string    `json:"next_page_token,omitempty"`
	Resources     []Resource `json:"resources"`
}

ResourceList Paginated list of resources

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL