Skip to content

🚸 ux: fix kube api usage#241

Merged
jfbus merged 2 commits into
mainfrom
sdk-v3.0.0-rc.3
Jul 9, 2026
Merged

🚸 ux: fix kube api usage#241
jfbus merged 2 commits into
mainfrom
sdk-v3.0.0-rc.3

Conversation

@jfbus

@jfbus jfbus commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

WARNING : Differences in reference doc 🤔

 docs/reference/octl_kube_api.md                    | 30 +++++++++++-----------
 docs/reference/octl_kube_api_DeleteCluster.md      |  4 +--
 docs/reference/octl_kube_api_DeleteProject.md      |  4 +--
 docs/reference/octl_kube_api_GetCPSubregions.md    |  4 +--
 docs/reference/octl_kube_api_GetCluster.md         |  4 +--
 docs/reference/octl_kube_api_GetClusterTemplate.md |  4 +--
 .../octl_kube_api_GetControlPlanePlans.md          |  4 +--
 .../octl_kube_api_GetKubeconfigWithPubkeyNACL.md   |  4 +--
 .../octl_kube_api_GetKubernetesVersions.md         |  4 +--
 ...ctl_kube_api_GetNetPeeringAcceptanceTemplate.md |  4 +--
 .../octl_kube_api_GetNetPeeringRequestTemplate.md  |  4 +--
 .../reference/octl_kube_api_GetNodepoolTemplate.md |  4 +--
 docs/reference/octl_kube_api_GetProject.md         |  4 +--
 docs/reference/octl_kube_api_GetProjectTemplate.md |  4 +--
 docs/reference/octl_kube_api_ListProjects.md       |  4 +--
 docs/reference/octl_kube_api_UpgradeCluster.md     |  4 +--
 docs/reference/octl_kube_cluster_delete.md         |  2 +-
 docs/reference/octl_kube_project_delete.md         |  2 +-
 docs/reference/octl_kube_project_list.md           |  2 +-
 19 files changed, 48 insertions(+), 48 deletions(-)
Detailed changes

docs/reference/octl_kube_api.md

-* [octl kube api DeleteCluster](octl_kube_api_DeleteCluster.md)	 - request returning *DetailResponse
-* [octl kube api DeleteProject](octl_kube_api_DeleteProject.md)	 - request returning *DetailResponse
-* [octl kube api GetCPSubregions](octl_kube_api_GetCPSubregions.md)	 - request returning *CPSubregionsResponse
-* [octl kube api GetCluster](octl_kube_api_GetCluster.md)	 - request returning *ClusterResponse
-* [octl kube api GetClusterTemplate](octl_kube_api_GetClusterTemplate.md)	 - request returning *TemplateResponseClusterInputTemplate
-* [octl kube api GetControlPlanePlans](octl_kube_api_GetControlPlanePlans.md)	 - request returning *ControlPlanesResponse
+* [octl kube api DeleteCluster](octl_kube_api_DeleteCluster.md)	 - Deletes a specific cluster by its ID.
+* [octl kube api DeleteProject](octl_kube_api_DeleteProject.md)	 - Deletes a specific project by its ID.
+* [octl kube api GetCPSubregions](octl_kube_api_GetCPSubregions.md)	 - Retrieves the available subregions for cluster deployment.
+* [octl kube api GetCluster](octl_kube_api_GetCluster.md)	 - Retrieves detailed information about a specific cluster by its ID.
+* [octl kube api GetClusterTemplate](octl_kube_api_GetClusterTemplate.md)	 - Retrieves the default cluster template, including predefined control plane configurations, networking settings, and maintenance schedules.
+* [octl kube api GetControlPlanePlans](octl_kube_api_GetControlPlanePlans.md)	 - Retrieves the available control plane plans for cluster deployment.
-* [octl kube api GetKubeconfigWithPubkeyNACL](octl_kube_api_GetKubeconfigWithPubkeyNACL.md)	 - request returning *KubeconfigResponse
-* [octl kube api GetKubernetesVersions](octl_kube_api_GetKubernetesVersions.md)	 - request returning *KubernetesVersionsResponse
-* [octl kube api GetNetPeeringAcceptanceTemplate](octl_kube_api_GetNetPeeringAcceptanceTemplate.md)	 - request returning *TemplateResponseNetPeeringAcceptance
-* [octl kube api GetNetPeeringRequestTemplate](octl_kube_api_GetNetPeeringRequestTemplate.md)	 - request returning *TemplateResponseNetPeeringRequest
-* [octl kube api GetNodepoolTemplate](octl_kube_api_GetNodepoolTemplate.md)	 - request returning *TemplateResponseNodepool
-* [octl kube api GetProject](octl_kube_api_GetProject.md)	 - request returning *ProjectResponse
+* [octl kube api GetKubeconfigWithPubkeyNACL](octl_kube_api_GetKubeconfigWithPubkeyNACL.md)	 - Retrieves the kubeconfig for a specific cluster by its ID with optional NaCl public key encryption.
+* [octl kube api GetKubernetesVersions](octl_kube_api_GetKubernetesVersions.md)	 - Retrieves the available Kubernetes versions for cluster creation or upgrades.
+* [octl kube api GetNetPeeringAcceptanceTemplate](octl_kube_api_GetNetPeeringAcceptanceTemplate.md)	 - NetPeering Acceptance manifest
+* [octl kube api GetNetPeeringRequestTemplate](octl_kube_api_GetNetPeeringRequestTemplate.md)	 - NetPeering Request manifest
+* [octl kube api GetNodepoolTemplate](octl_kube_api_GetNodepoolTemplate.md)	 - Retrieves the default node pool template, including predefined configurations for node scaling, storage, and upgrade strategies.
+* [octl kube api GetProject](octl_kube_api_GetProject.md)	 - Retrieves detailed information about a specific project by its ID.
-* [octl kube api GetProjectTemplate](octl_kube_api_GetProjectTemplate.md)	 - request returning *TemplateResponseProjectInput
+* [octl kube api GetProjectTemplate](octl_kube_api_GetProjectTemplate.md)	 - Retrieves the default project template, including predefined network configurations, region, and metadata.
-* [octl kube api ListProjects](octl_kube_api_ListProjects.md)	 - request returning *ProjectResponseList
+* [octl kube api ListProjects](octl_kube_api_ListProjects.md)	 - Retrieves a list of all projects with optional filters for name, status, CIDR, and deletion status.
-* [octl kube api UpgradeCluster](octl_kube_api_UpgradeCluster.md)	 - request returning *ClusterResponse
+* [octl kube api UpgradeCluster](octl_kube_api_UpgradeCluster.md)	 - Upgrades a specific cluster by its ID to the latest available version.

docs/reference/octl_kube_api_DeleteCluster.md

-request returning *DetailResponse
+Deletes a specific cluster by its ID.
-request returning *DetailResponse
+Deletes a specific cluster by its ID. Returns confirmation of the deletion.

docs/reference/octl_kube_api_DeleteProject.md

-request returning *DetailResponse
+Deletes a specific project by its ID.
-request returning *DetailResponse
+Deletes a specific project by its ID. Returns a confirmation of the project deletion.

docs/reference/octl_kube_api_GetCPSubregions.md

-request returning *CPSubregionsResponse
+Retrieves the available subregions for cluster deployment.
-request returning *CPSubregionsResponse
+Retrieves the available subregions for cluster deployment. Returns a list of supported subregions for cluster creation.

docs/reference/octl_kube_api_GetCluster.md

-request returning *ClusterResponse
+Retrieves detailed information about a specific cluster by its ID.
-request returning *ClusterResponse
+Retrieves detailed information about a specific cluster by its ID. Returns the cluster details if found.

docs/reference/octl_kube_api_GetClusterTemplate.md

-request returning *TemplateResponseClusterInputTemplate
+Retrieves the default cluster template, including predefined control plane configurations, networking settings, and maintenance schedules.
-request returning *TemplateResponseClusterInputTemplate
+Retrieves the default cluster template, including predefined control plane configurations, networking settings, and maintenance schedules. Returns a JSON response containing the request context and template details, such as control plane type, CIDR ranges for pods and services, admission flags, multi-AZ support, Kubernetes version, subregions, and scheduled automatic maintenance settings.

docs/reference/octl_kube_api_GetControlPlanePlans.md

-request returning *ControlPlanesResponse
+Retrieves the available control plane plans for cluster deployment.
-request returning *ControlPlanesResponse
+Retrieves the available control plane plans for cluster deployment. Returns a list of supported control plane plans for cluster creation or upgrades.

docs/reference/octl_kube_api_GetKubeconfigWithPubkeyNACL.md

-request returning *KubeconfigResponse
+Retrieves the kubeconfig for a specific cluster by its ID with optional NaCl public key encryption.
-request returning *KubeconfigResponse
+Retrieves the kubeconfig for a specific cluster by its ID with optional NaCl public key encryption. Optionally, you can specify a user, group, and TTL (time-to-live) for the kubeconfig. If the x_encrypt_nacl header is provided, the kubeconfig will be encrypted using the given NaCl public key. Returns the kubeconfig details as a dictionary.

docs/reference/octl_kube_api_GetKubernetesVersions.md

-request returning *KubernetesVersionsResponse
+Retrieves the available Kubernetes versions for cluster creation or upgrades.
-request returning *KubernetesVersionsResponse
+Retrieves the available Kubernetes versions for cluster creation or upgrades. Returns a list of supported Kubernetes versions.

docs/reference/octl_kube_api_GetNetPeeringAcceptanceTemplate.md

-request returning *TemplateResponseNetPeeringAcceptance
+NetPeering Acceptance manifest
-request returning *TemplateResponseNetPeeringAcceptance
+NetPeering Acceptance manifest

docs/reference/octl_kube_api_GetNetPeeringRequestTemplate.md

-request returning *TemplateResponseNetPeeringRequest
+NetPeering Request manifest
-request returning *TemplateResponseNetPeeringRequest
+NetPeering Request manifest

docs/reference/octl_kube_api_GetNodepoolTemplate.md

-request returning *TemplateResponseNodepool
+Retrieves the default node pool template, including predefined configurations for node scaling, storage, and upgrade strategies.
-request returning *TemplateResponseNodepool
+Retrieves the default node pool template, including predefined configurations for node scaling, storage, and upgrade strategies. Returns a JSON response containing the request context and template details, such as node count, node type, availability zones, volume specifications, upgrade strategy, and auto-healing settings.

docs/reference/octl_kube_api_GetProject.md

-request returning *ProjectResponse
+Retrieves detailed information about a specific project by its ID.
-request returning *ProjectResponse
+Retrieves detailed information about a specific project by its ID. Returns the details of the project if found.

docs/reference/octl_kube_api_GetProjectTemplate.md

-request returning *TemplateResponseProjectInput
+Retrieves the default project template, including predefined network configurations, region, and metadata.
-request returning *TemplateResponseProjectInput
+Retrieves the default project template, including predefined network configurations, region, and metadata. Returns a JSON response containing the request context and template details, such as CIDR block, project name, region, description, and tags.

docs/reference/octl_kube_api_ListProjects.md

-request returning *ProjectResponseList
+Retrieves a list of all projects with optional filters for name, status, CIDR, and deletion status.
-request returning *ProjectResponseList
+Retrieves a list of all projects with optional filters for name, status, CIDR, and deletion status. Returns a list of matching projects based on the specified filters.

docs/reference/octl_kube_api_UpgradeCluster.md

-request returning *ClusterResponse
+Upgrades a specific cluster by its ID to the latest available version.
-request returning *ClusterResponse
+Upgrades a specific cluster by its ID to the latest available version. Returns the updated cluster details after the upgrade process is completed.

docs/reference/octl_kube_cluster_delete.md

-request returning *DetailResponse
+Deletes a specific cluster by its ID. Returns confirmation of the deletion.

docs/reference/octl_kube_project_delete.md

-request returning *DetailResponse
+Deletes a specific project by its ID. Returns a confirmation of the project deletion.

docs/reference/octl_kube_project_list.md

-request returning *ProjectResponseList
+Retrieves a list of all projects with optional filters for name, status, CIDR, and deletion status. Returns a list of matching projects based on the specified filters.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

🔖 auto-tagging: Adding label "dependencies"

@github-actions github-actions Bot added the dependencies Dependency update label Jul 9, 2026
@jfbus jfbus marked this pull request as ready for review July 9, 2026 14:22
@jfbus jfbus requested a review from a team July 9, 2026 14:22
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Binary size: 81.7MB => 81.7MB (change +4KB, +0.0%) 😉

@jfbus jfbus force-pushed the sdk-v3.0.0-rc.3 branch from 585fe1a to 9d2b8e2 Compare July 9, 2026 14:29
@jfbus jfbus requested a review from a team as a code owner July 9, 2026 14:29
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

🔖 auto-tagging: Adding label "dependencies"

@jfbus jfbus added kind/other Other change and removed dependencies Dependency update labels Jul 9, 2026
@jfbus jfbus changed the title ⬆️ deps: Go SDK v3.0.0-rc.3 🚸 ux: fix kube api usage Jul 9, 2026
@jfbus jfbus merged commit f60b403 into main Jul 9, 2026
11 checks passed
@jfbus jfbus deleted the sdk-v3.0.0-rc.3 branch July 9, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/other Other change

Development

Successfully merging this pull request may close these issues.

3 participants