package
0.12.2
Repository: https://github.com/projectsyn/lieutenant-api.git
Documentation: pkg.go.dev

# Functions

GenerateClusterID creates a new cluster id.
GenerateTenantID creates a new tenant id.
GetSwagger returns the Swagger specification corresponding to the generated code in this file.
NewAPIClusterFromCRD transforms a CRD cluster into the API representation.
NewAPITenantFromCRD transforms a CRD tenant into the API representation.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCRDFromAPICluster transforms an API cluster into the CRD representation.
NewCRDFromAPITenant transforms an API tenant into the CRD representation.
NewCreateClusterRequest calls the generic CreateCluster builder with application/json body.
NewCreateClusterRequestWithBody generates requests for CreateCluster with any type of body.
NewCreateTenantRequest calls the generic CreateTenant builder with application/json body.
NewCreateTenantRequestWithBody generates requests for CreateTenant with any type of body.
NewDeleteClusterRequest generates requests for DeleteCluster.
NewDeleteTenantRequest generates requests for DeleteTenant.
NewDiscoveryRequest generates requests for Discovery.
NewDocsRequest generates requests for Docs.
NewGetClusterRequest generates requests for GetCluster.
NewGetTenantRequest generates requests for GetTenant.
NewHealthzRequest generates requests for Healthz.
NewInstallStewardRequest generates requests for InstallSteward.
NewListClustersRequest generates requests for ListClusters.
NewListTenantsRequest generates requests for ListTenants.
NewOpenapiRequest generates requests for Openapi.
NewPostClusterCompileMetaRequest calls the generic PostClusterCompileMeta builder with application/json body.
NewPostClusterCompileMetaRequestWithBody generates requests for PostClusterCompileMeta with any type of body.
NewPutClusterRequest calls the generic PutCluster builder with application/json body.
NewPutClusterRequestWithBody generates requests for PutCluster with any type of body.
NewPutTenantRequest calls the generic PutTenant builder with application/json body.
NewPutTenantRequestWithBody generates requests for PutTenant with any type of body.
NewQueryInventoryRequest generates requests for QueryInventory.
NewUpdateClusterRequestWithApplicationMergePatchPlusJSONBody calls the generic UpdateCluster builder with application/merge-patch+json body.
NewUpdateClusterRequestWithBody generates requests for UpdateCluster with any type of body.
NewUpdateInventoryRequest calls the generic UpdateInventory builder with application/json body.
NewUpdateInventoryRequestWithBody generates requests for UpdateInventory with any type of body.
NewUpdateTenantRequestWithApplicationMergePatchPlusJSONBody calls the generic UpdateTenant builder with application/merge-patch+json body.
NewUpdateTenantRequestWithBody generates requests for UpdateTenant with any type of body.
ParseCreateClusterResponse parses an HTTP response from a CreateClusterWithResponse call.
ParseCreateTenantResponse parses an HTTP response from a CreateTenantWithResponse call.
ParseDeleteClusterResponse parses an HTTP response from a DeleteClusterWithResponse call.
ParseDeleteTenantResponse parses an HTTP response from a DeleteTenantWithResponse call.
ParseDiscoveryResponse parses an HTTP response from a DiscoveryWithResponse call.
ParseDocsResponse parses an HTTP response from a DocsWithResponse call.
ParseGetClusterResponse parses an HTTP response from a GetClusterWithResponse call.
ParseGetTenantResponse parses an HTTP response from a GetTenantWithResponse call.
ParseHealthzResponse parses an HTTP response from a HealthzWithResponse call.
ParseInstallStewardResponse parses an HTTP response from a InstallStewardWithResponse call.
ParseListClustersResponse parses an HTTP response from a ListClustersWithResponse call.
ParseListTenantsResponse parses an HTTP response from a ListTenantsWithResponse call.
ParseOpenapiResponse parses an HTTP response from a OpenapiWithResponse call.
ParsePostClusterCompileMetaResponse parses an HTTP response from a PostClusterCompileMetaWithResponse call.
ParsePutClusterResponse parses an HTTP response from a PutClusterWithResponse call.
ParsePutTenantResponse parses an HTTP response from a PutTenantWithResponse call.
ParseQueryInventoryResponse parses an HTTP response from a QueryInventoryWithResponse call.
ParseUpdateClusterResponse parses an HTTP response from a UpdateClusterWithResponse call.
ParseUpdateInventoryResponse parses an HTTP response from a UpdateInventoryWithResponse call.
ParseUpdateTenantResponse parses an HTTP response from a UpdateTenantWithResponse call.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
RegisterHandlers adds each server route to the EchoRouter.
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
No description provided by the author
No description provided by the author
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

No description provided by the author
ClusterIDPrefix is prefixed to all cluster IDs.
ContentJSONPatch is the content type to do JSON updates.
Defines values for ListClustersParamsSortBy.
Defines values for ListClustersParamsSortBy.
Defines values for ListClustersParamsSortBy.
TenantIDPrefix is prefixed to all tenant IDs.

# Structs

Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
Cluster defines model for Cluster.
ClusterCompileMeta CompileMeta contains information about the last compilation with Commodore.
ClusterId defines model for ClusterId.
ClusterProperties A cluster defition object.
ClusterTenant defines model for ClusterTenant.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GitRepo Configuration Git repository, usually generated by the API.
No description provided by the author
InstallStewardParams defines parameters for InstallSteward.
No description provided by the author
Inventory Inventory data of a cluster.
ListClustersParams defines parameters for ListClusters.
No description provided by the author
No description provided by the author
Metadata defines model for Metadata.
OIDCConfig defines model for OIDCConfig.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
QueryInventoryParams defines parameters for QueryInventory.
No description provided by the author
Reason A reason for responses.
Revision defines model for Revision.
RevisionedGitRepo defines model for RevisionedGitRepo.
ServerInterfaceWrapper converts echo contexts to parameters.
Tenant defines model for Tenant.
TenantId defines model for TenantId.
TenantProperties A tenant definition object.
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration.
Doer performs HTTP requests.
ServerInterface represents all server handlers.

# Type aliases

Annotations Unstructured key value map containing arbitrary metadata.
ClientOption allows setting custom parameters during construction.
ClusterFacts Facts about a cluster object.
ClusterIdParameter A unique object identifier string.
CreateClusterJSONRequestBody defines body for CreateCluster for application/json ContentType.
CreateTenantJSONRequestBody defines body for CreateTenant for application/json ContentType.
Default A reason for responses.
DynamicClusterFacts Dynamic facts about a cluster object.
Id A unique object identifier string.
ListClustersParamsSortBy defines parameters for ListClusters.
PostClusterCompileMetaJSONRequestBody defines body for PostClusterCompileMeta for application/json ContentType.
PutClusterJSONRequestBody defines body for PutCluster for application/json ContentType.
PutTenantJSONRequestBody defines body for PutTenant for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.
TenantIdParameter A unique object identifier string.
UpdateClusterApplicationMergePatchPlusJSONRequestBody defines body for UpdateCluster for application/merge-patch+json ContentType.
UpdateInventoryJSONRequestBody defines body for UpdateInventory for application/json ContentType.
UpdateTenantApplicationMergePatchPlusJSONRequestBody defines body for UpdateTenant for application/merge-patch+json ContentType.