diff --git a/v1/providers/launchpad/Makefile b/v1/providers/launchpad/Makefile index f218d8f..ed0451e 100644 --- a/v1/providers/launchpad/Makefile +++ b/v1/providers/launchpad/Makefile @@ -1,4 +1,4 @@ -SPEC_VERSION ?= v2.39.5 +SPEC_VERSION ?= v2.40.9 SPEC_FILE ?= swagger-${SPEC_VERSION}.yaml SPEC_FILE_FINAL ?= swagger-${SPEC_VERSION}.final.yaml OUTPUT_DIR ?= launchpad diff --git a/v1/providers/launchpad/gen/launchpad/.openapi-generator/FILES b/v1/providers/launchpad/gen/launchpad/.openapi-generator/FILES index 6dba1d2..c99a601 100644 --- a/v1/providers/launchpad/gen/launchpad/.openapi-generator/FILES +++ b/v1/providers/launchpad/gen/launchpad/.openapi-generator/FILES @@ -10,6 +10,7 @@ api_catalog_gpu_os_choices.go api_catalog_instance_types.go api_catalog_persona_choices.go api_catalog_runtimes.go +api_catalog_vgpu_profile_choices.go api_health.go api_identity_profile.go api_inventory_clusters.go @@ -33,6 +34,7 @@ docs/CatalogGpuOsChoicesAPI.md docs/CatalogInstanceTypesAPI.md docs/CatalogPersonaChoicesAPI.md docs/CatalogRuntimesAPI.md +docs/CatalogVgpuProfileChoicesAPI.md docs/CategoryEnum.md docs/Cluster.md docs/ClusterBulkUpdate.md @@ -40,15 +42,18 @@ docs/ClusterDeployment.md docs/ClusterGpusInner.md docs/ClusterInstancesInner.md docs/ClusterNodesInner.md +docs/ClusterPipeline.md +docs/ClusterPipelineCluster.md docs/ClusterPipelineTrigger.md +docs/ClusterProvisionCreateResponse.md docs/CpuManufacturerEnum.md docs/Deployment.md docs/DeploymentBulkUpdate.md -docs/DeploymentCluster.md docs/DeploymentInstance.md docs/DeploymentKey.md docs/DeploymentNote.md docs/DeploymentPipeline.md +docs/DeploymentPipelineTrigger.md docs/DeploymentService.md docs/DeploymentState.md docs/DeploymentTask.md @@ -100,6 +105,7 @@ docs/OEM.md docs/OnDemandSpeedEnum.md docs/Overrides.md docs/PaginatedClusterList.md +docs/PaginatedClusterPipelineList.md docs/PaginatedDeploymentInstanceList.md docs/PaginatedDeploymentKeyList.md docs/PaginatedDeploymentList.md @@ -120,6 +126,7 @@ docs/PaginatedOEMList.md docs/PaginatedPersonaChoiceList.md docs/PaginatedProviderList.md docs/PaginatedRuntimeList.md +docs/PaginatedVGpuProfileChoiceList.md docs/PasswordChange.md docs/PersonaChoice.md docs/PipelineAction.md @@ -137,9 +144,9 @@ docs/StatusEnum.md docs/SystemArchEnum.md docs/Tenant.md docs/TypeEnum.md +docs/VGpuProfileChoice.md docs/VersionAPI.md docs/VersionRetrieve200Response.md -docs/VgpuProfileEnum.md git_push.sh go.mod go.sum @@ -154,15 +161,18 @@ model_cluster_deployment.go model_cluster_gpus_inner.go model_cluster_instances_inner.go model_cluster_nodes_inner.go +model_cluster_pipeline.go +model_cluster_pipeline_cluster.go model_cluster_pipeline_trigger.go +model_cluster_provision_create_response.go model_cpu_manufacturer_enum.go model_deployment.go model_deployment_bulk_update.go -model_deployment_cluster.go model_deployment_instance.go model_deployment_key.go model_deployment_note.go model_deployment_pipeline.go +model_deployment_pipeline_trigger.go model_deployment_service.go model_deployment_state.go model_deployment_task.go @@ -205,6 +215,7 @@ model_oem.go model_on_demand_speed_enum.go model_overrides.go model_paginated_cluster_list.go +model_paginated_cluster_pipeline_list.go model_paginated_deployment_instance_list.go model_paginated_deployment_key_list.go model_paginated_deployment_list.go @@ -225,6 +236,7 @@ model_paginated_oem_list.go model_paginated_persona_choice_list.go model_paginated_provider_list.go model_paginated_runtime_list.go +model_paginated_v_gpu_profile_choice_list.go model_password_change.go model_persona_choice.go model_pipeline_action.go @@ -242,8 +254,8 @@ model_status_enum.go model_system_arch_enum.go model_tenant.go model_type_enum.go +model_v_gpu_profile_choice.go model_version_retrieve_200_response.go -model_vgpu_profile_enum.go response.go test/api_auth_test.go test/api_catalog_deployments_test.go @@ -252,6 +264,7 @@ test/api_catalog_gpu_os_choices_test.go test/api_catalog_instance_types_test.go test/api_catalog_persona_choices_test.go test/api_catalog_runtimes_test.go +test/api_catalog_vgpu_profile_choices_test.go test/api_health_test.go test/api_identity_profile_test.go test/api_inventory_clusters_test.go diff --git a/v1/providers/launchpad/gen/launchpad/README.md b/v1/providers/launchpad/gen/launchpad/README.md index c0d71d2..0dc6394 100644 --- a/v1/providers/launchpad/gen/launchpad/README.md +++ b/v1/providers/launchpad/gen/launchpad/README.md @@ -5,7 +5,7 @@ RESTful API for interacting with the NVIDIA LaunchPad platform ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 2.39.5 +- API version: 2.40.9 - Package version: 1.0.0 - Generator version: 7.8.0 - Build package: org.openapitools.codegen.languages.GoClientCodegen @@ -97,6 +97,7 @@ Class | Method | HTTP request | Description *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsPartialUpdate**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentspartialupdate) | **Patch** /v1/catalog/deployments/{id}/ | *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsPipelinesCreate**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentspipelinescreate) | **Post** /v1/catalog/deployments/{deployment_id}/pipelines/ | *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsPipelinesList**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentspipelineslist) | **Get** /v1/catalog/deployments/{deployment_id}/pipelines/ | +*CatalogDeploymentsAPI* | [**V1CatalogDeploymentsPipelinesTriggerCreate**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentspipelinestriggercreate) | **Post** /v1/catalog/deployments/{id}/pipelines/trigger/ | *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsRetrieve**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentsretrieve) | **Get** /v1/catalog/deployments/{id}/ | *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsServicesCreate**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentsservicescreate) | **Post** /v1/catalog/deployments/{deployment_id}/services/ | *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsServicesList**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentsserviceslist) | **Get** /v1/catalog/deployments/{deployment_id}/services/ | @@ -108,18 +109,18 @@ Class | Method | HTTP request | Description *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsTasksList**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentstaskslist) | **Get** /v1/catalog/deployments/{deployment_id}/tasks/ | 🚧 [Beta Feature] *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsTasksRetrieve**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentstasksretrieve) | **Get** /v1/catalog/deployments/{deployment_id}/tasks/{id}/ | 🚧 [Beta Feature] *CatalogDeploymentsAPI* | [**V1CatalogDeploymentsUpdate**](docs/CatalogDeploymentsAPI.md#v1catalogdeploymentsupdate) | **Put** /v1/catalog/deployments/{id}/ | -*CatalogDeploymentsAPI* | [**V1CatalogExperiencesNotesCreate**](docs/CatalogDeploymentsAPI.md#v1catalogexperiencesnotescreate) | **Post** /v1/catalog/experiences/{experience_id}/notes/ | -*CatalogDeploymentsAPI* | [**V1CatalogExperiencesNotesDestroy**](docs/CatalogDeploymentsAPI.md#v1catalogexperiencesnotesdestroy) | **Delete** /v1/catalog/experiences/{experience_id}/notes/{id}/ | -*CatalogDeploymentsAPI* | [**V1CatalogExperiencesNotesList**](docs/CatalogDeploymentsAPI.md#v1catalogexperiencesnoteslist) | **Get** /v1/catalog/experiences/{experience_id}/notes/ | -*CatalogDeploymentsAPI* | [**V1CatalogExperiencesNotesPartialUpdate**](docs/CatalogDeploymentsAPI.md#v1catalogexperiencesnotespartialupdate) | **Patch** /v1/catalog/experiences/{experience_id}/notes/{id}/ | -*CatalogDeploymentsAPI* | [**V1CatalogExperiencesNotesRetrieve**](docs/CatalogDeploymentsAPI.md#v1catalogexperiencesnotesretrieve) | **Get** /v1/catalog/experiences/{experience_id}/notes/{id}/ | -*CatalogDeploymentsAPI* | [**V1CatalogExperiencesNotesUpdate**](docs/CatalogDeploymentsAPI.md#v1catalogexperiencesnotesupdate) | **Put** /v1/catalog/experiences/{experience_id}/notes/{id}/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesBulkCreate**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesbulkcreate) | **Post** /v1/catalog/experiences/bulk/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesBulkPartialUpdate**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesbulkpartialupdate) | **Patch** /v1/catalog/experiences/bulk/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesCreate**](docs/CatalogExperiencesAPI.md#v1catalogexperiencescreate) | **Post** /v1/catalog/experiences/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesDestroy**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesdestroy) | **Delete** /v1/catalog/experiences/{id}/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesHistoryList**](docs/CatalogExperiencesAPI.md#v1catalogexperienceshistorylist) | **Get** /v1/catalog/experiences/{id}/history/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesList**](docs/CatalogExperiencesAPI.md#v1catalogexperienceslist) | **Get** /v1/catalog/experiences/ | +*CatalogExperiencesAPI* | [**V1CatalogExperiencesNotesCreate**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesnotescreate) | **Post** /v1/catalog/experiences/{experience_id}/notes/ | +*CatalogExperiencesAPI* | [**V1CatalogExperiencesNotesDestroy**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesnotesdestroy) | **Delete** /v1/catalog/experiences/{experience_id}/notes/{id}/ | +*CatalogExperiencesAPI* | [**V1CatalogExperiencesNotesList**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesnoteslist) | **Get** /v1/catalog/experiences/{experience_id}/notes/ | +*CatalogExperiencesAPI* | [**V1CatalogExperiencesNotesPartialUpdate**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesnotespartialupdate) | **Patch** /v1/catalog/experiences/{experience_id}/notes/{id}/ | +*CatalogExperiencesAPI* | [**V1CatalogExperiencesNotesRetrieve**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesnotesretrieve) | **Get** /v1/catalog/experiences/{experience_id}/notes/{id}/ | +*CatalogExperiencesAPI* | [**V1CatalogExperiencesNotesUpdate**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesnotesupdate) | **Put** /v1/catalog/experiences/{experience_id}/notes/{id}/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesPartialUpdate**](docs/CatalogExperiencesAPI.md#v1catalogexperiencespartialupdate) | **Patch** /v1/catalog/experiences/{id}/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesRetrieve**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesretrieve) | **Get** /v1/catalog/experiences/{id}/ | *CatalogExperiencesAPI* | [**V1CatalogExperiencesStatsRetrieve**](docs/CatalogExperiencesAPI.md#v1catalogexperiencesstatsretrieve) | **Get** /v1/catalog/experiences/stats/ | 🚧 [Beta Feature] @@ -136,6 +137,8 @@ Class | Method | HTTP request | Description *CatalogRuntimesAPI* | [**V1CatalogRuntimesPartialUpdate**](docs/CatalogRuntimesAPI.md#v1catalogruntimespartialupdate) | **Patch** /v1/catalog/runtimes/{id}/ | *CatalogRuntimesAPI* | [**V1CatalogRuntimesRetrieve**](docs/CatalogRuntimesAPI.md#v1catalogruntimesretrieve) | **Get** /v1/catalog/runtimes/{id}/ | *CatalogRuntimesAPI* | [**V1CatalogRuntimesUpdate**](docs/CatalogRuntimesAPI.md#v1catalogruntimesupdate) | **Put** /v1/catalog/runtimes/{id}/ | +*CatalogVgpuProfileChoicesAPI* | [**V1CatalogVgpuProfileChoicesCreate**](docs/CatalogVgpuProfileChoicesAPI.md#v1catalogvgpuprofilechoicescreate) | **Post** /v1/catalog/vgpu-profile-choices/ | +*CatalogVgpuProfileChoicesAPI* | [**V1CatalogVgpuProfileChoicesList**](docs/CatalogVgpuProfileChoicesAPI.md#v1catalogvgpuprofilechoiceslist) | **Get** /v1/catalog/vgpu-profile-choices/ | *HealthAPI* | [**HealthRetrieve**](docs/HealthAPI.md#healthretrieve) | **Get** /health/ | *IdentityProfileAPI* | [**V1IdentityProfilePartialUpdate**](docs/IdentityProfileAPI.md#v1identityprofilepartialupdate) | **Patch** /v1/identity/profile/ | *IdentityProfileAPI* | [**V1IdentityProfileRetrieve**](docs/IdentityProfileAPI.md#v1identityprofileretrieve) | **Get** /v1/identity/profile/ | @@ -145,6 +148,7 @@ Class | Method | HTTP request | Description *InventoryClustersAPI* | [**V1InventoryClustersHistoryList**](docs/InventoryClustersAPI.md#v1inventoryclustershistorylist) | **Get** /v1/inventory/clusters/{id}/history/ | *InventoryClustersAPI* | [**V1InventoryClustersList**](docs/InventoryClustersAPI.md#v1inventoryclusterslist) | **Get** /v1/inventory/clusters/ | *InventoryClustersAPI* | [**V1InventoryClustersPartialUpdate**](docs/InventoryClustersAPI.md#v1inventoryclusterspartialupdate) | **Patch** /v1/inventory/clusters/{id}/ | +*InventoryClustersAPI* | [**V1InventoryClustersPipelinesList**](docs/InventoryClustersAPI.md#v1inventoryclusterspipelineslist) | **Get** /v1/inventory/clusters/{cluster_id}/pipelines/ | *InventoryClustersAPI* | [**V1InventoryClustersPipelinesTriggerCreate**](docs/InventoryClustersAPI.md#v1inventoryclusterspipelinestriggercreate) | **Post** /v1/inventory/clusters/{id}/pipelines/trigger/ | *InventoryClustersAPI* | [**V1InventoryClustersProvisionCreate**](docs/InventoryClustersAPI.md#v1inventoryclustersprovisioncreate) | **Post** /v1/inventory/clusters/provision/ | *InventoryClustersAPI* | [**V1InventoryClustersProvisionDestroy**](docs/InventoryClustersAPI.md#v1inventoryclustersprovisiondestroy) | **Delete** /v1/inventory/clusters/{id}/provision/ | @@ -219,15 +223,18 @@ Class | Method | HTTP request | Description - [ClusterGpusInner](docs/ClusterGpusInner.md) - [ClusterInstancesInner](docs/ClusterInstancesInner.md) - [ClusterNodesInner](docs/ClusterNodesInner.md) + - [ClusterPipeline](docs/ClusterPipeline.md) + - [ClusterPipelineCluster](docs/ClusterPipelineCluster.md) - [ClusterPipelineTrigger](docs/ClusterPipelineTrigger.md) + - [ClusterProvisionCreateResponse](docs/ClusterProvisionCreateResponse.md) - [CpuManufacturerEnum](docs/CpuManufacturerEnum.md) - [Deployment](docs/Deployment.md) - [DeploymentBulkUpdate](docs/DeploymentBulkUpdate.md) - - [DeploymentCluster](docs/DeploymentCluster.md) - [DeploymentInstance](docs/DeploymentInstance.md) - [DeploymentKey](docs/DeploymentKey.md) - [DeploymentNote](docs/DeploymentNote.md) - [DeploymentPipeline](docs/DeploymentPipeline.md) + - [DeploymentPipelineTrigger](docs/DeploymentPipelineTrigger.md) - [DeploymentService](docs/DeploymentService.md) - [DeploymentState](docs/DeploymentState.md) - [DeploymentTask](docs/DeploymentTask.md) @@ -270,6 +277,7 @@ Class | Method | HTTP request | Description - [OnDemandSpeedEnum](docs/OnDemandSpeedEnum.md) - [Overrides](docs/Overrides.md) - [PaginatedClusterList](docs/PaginatedClusterList.md) + - [PaginatedClusterPipelineList](docs/PaginatedClusterPipelineList.md) - [PaginatedDeploymentInstanceList](docs/PaginatedDeploymentInstanceList.md) - [PaginatedDeploymentKeyList](docs/PaginatedDeploymentKeyList.md) - [PaginatedDeploymentList](docs/PaginatedDeploymentList.md) @@ -290,6 +298,7 @@ Class | Method | HTTP request | Description - [PaginatedPersonaChoiceList](docs/PaginatedPersonaChoiceList.md) - [PaginatedProviderList](docs/PaginatedProviderList.md) - [PaginatedRuntimeList](docs/PaginatedRuntimeList.md) + - [PaginatedVGpuProfileChoiceList](docs/PaginatedVGpuProfileChoiceList.md) - [PasswordChange](docs/PasswordChange.md) - [PersonaChoice](docs/PersonaChoice.md) - [PipelineAction](docs/PipelineAction.md) @@ -307,8 +316,8 @@ Class | Method | HTTP request | Description - [SystemArchEnum](docs/SystemArchEnum.md) - [Tenant](docs/Tenant.md) - [TypeEnum](docs/TypeEnum.md) + - [VGpuProfileChoice](docs/VGpuProfileChoice.md) - [VersionRetrieve200Response](docs/VersionRetrieve200Response.md) - - [VgpuProfileEnum](docs/VgpuProfileEnum.md) ## Documentation For Authorization diff --git a/v1/providers/launchpad/gen/launchpad/api/openapi.yaml b/v1/providers/launchpad/gen/launchpad/api/openapi.yaml index 7de51de..b22ddf4 100644 --- a/v1/providers/launchpad/gen/launchpad/api/openapi.yaml +++ b/v1/providers/launchpad/gen/launchpad/api/openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: description: RESTful API for interacting with the NVIDIA LaunchPad platform title: NVIDIA LaunchPad API - version: 2.39.5 + version: 2.40.9 servers: - url: / paths: @@ -677,7 +677,7 @@ paths: created: 2024-04-01T06:14:32.602Z experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -723,6 +723,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -768,7 +769,7 @@ paths: cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b collection_branch: my-branch experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -807,6 +808,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -825,7 +827,7 @@ paths: collection_branch: my-branch experience_branch: main experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -864,6 +866,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -882,7 +885,7 @@ paths: cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b collection_branch: my-branch experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -921,6 +924,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -979,7 +983,7 @@ paths: created: 2024-04-01T06:14:32.602Z experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -1025,6 +1029,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -2220,7 +2225,7 @@ paths: created: 2024-04-01T06:14:32.602Z experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -2266,6 +2271,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -2350,7 +2356,7 @@ paths: created: 2024-04-01T06:14:32.602Z experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -2396,6 +2402,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -2438,7 +2445,7 @@ paths: value: collection_branch: my-branch experience_branch: main - expires_at: 2025-12-04 14:20:24.717624+00:00 + expires_at: 2026-01-11 16:07:02.677916+00:00 flightcontrol_release: latest gc_branch: main ip_allowlist: @@ -2479,7 +2486,7 @@ paths: created: 2024-04-01T06:14:32.602Z experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -2525,6 +2532,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -2567,7 +2575,7 @@ paths: value: collection_branch: my-branch experience_branch: main - expires_at: 2025-12-04 14:20:24.717624+00:00 + expires_at: 2026-01-11 16:07:02.677916+00:00 flightcontrol_release: latest gc_branch: main ip_allowlist: @@ -2608,7 +2616,7 @@ paths: created: 2024-04-01T06:14:32.602Z experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc experience_branch: main - expires_at: 2025-11-07 14:20:24.717454+00:00 + expires_at: 2025-12-15 16:07:02.677687+00:00 flightcontrol_release: latest garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd gc_branch: main @@ -2654,6 +2662,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git sales_created_date: 2025-04-10T15:08:47.381700Z sales_id: a6ZYx000001234 sales_owner_email: john.smith@nvidia.com @@ -2730,6 +2739,56 @@ paths: - TokenAuthentication: [] tags: - catalog/deployments + /v1/catalog/deployments/{id}/pipelines/trigger/: + post: + operationId: v1_catalog_deployments_pipelines_trigger_create + parameters: + - explode: false + in: path + name: id + required: true + schema: + format: uuid + type: string + style: simple + requestBody: + content: + application/json: + examples: + DeploymentPipelineTriggerRequest: + summary: DeploymentPipelineTrigger Request + value: + action: apply + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + required: true + responses: + "201": + content: + application/json: + examples: + DeploymentPipelineTriggerResponse: + summary: DeploymentPipelineTrigger Response + value: + action: apply + created: 2024-04-01T06:14:32.602Z + id: 05971347-30d6-410c-aff5-fa3513771d77 + modified: 2024-05-03T17:03:45.380Z + pipeline_id: 2101675389 + url: https://gitlab.com/my-project/-/pipelines/2101675389 + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + description: "" + security: + - TokenAuthentication: [] + tags: + - catalog/deployments /v1/catalog/deployments/bulk/: patch: operationId: v1_catalog_deployments_bulk_partial_update @@ -2742,7 +2801,7 @@ paths: value: collection_branch: my-branch experience_branch: main - expires_at: 2025-12-04 14:20:24.717624+00:00 + expires_at: 2026-01-11 16:07:02.677916+00:00 flightcontrol_release: latest gc_branch: main ids: @@ -2902,6 +2961,13 @@ paths: schema: type: string style: form + - explode: true + in: query + name: featured + required: false + schema: + type: boolean + style: form - description: Include only the specified fields in the response explode: true in: query @@ -2967,6 +3033,14 @@ paths: schema: type: integer style: form + - explode: true + in: query + name: oem + required: false + schema: + format: uuid + type: string + style: form - description: Exclude the specified fields in the response explode: true in: query @@ -3022,6 +3096,7 @@ paths: * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift + * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 @@ -3038,6 +3113,7 @@ paths: - lp-vmware-platform - minimal - openshift + - proxmox - vsphere - vsphere7 - vsphere8 @@ -3079,6 +3155,14 @@ paths: schema: type: string style: form + - explode: true + in: query + name: runtime + required: false + schema: + format: uuid + type: string + style: form - explode: true in: query name: sa_lab @@ -3088,8 +3172,9 @@ paths: style: form - description: "Search for experiences by assignee, catalog_id, catalog_id_alias,\ \ category, collection_branch, description, experience, experience_branch,\ - \ gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, persona, pipeline,\ - \ platform, provider name, required_gpus model, system_arch, title, vgpu_profile" + \ gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, oem name,\ + \ persona, pipeline, platform, provider name, required_gpus model, runtime\ + \ name, system_arch, title, vgpu_profile" explode: true in: query name: search @@ -3112,42 +3197,11 @@ paths: - arm64 type: string style: form - - description: |- - vGPU profile name used by the experience - - * `air` - NVIDIA Air - * `bright_cluster` - Bright Cluster - * `bright-cluster` - Bright Cluster (legacy option) - * `flight_deck` - Flight Deck - * `flight-deck` - Flight Deck (legacy option) - * `nvidia_a40-48q` - nvidia_a40-48q - * `nvidia-ai-enterprise` - NVIDIA AI Enterprise - * `nvidia_l40s-48q` - nvidia_l40s-48q - * `nvidia_rtx_pro_6000_blackwell_dc-4-96q` - nvidia_rtx_pro_6000_blackwell_dc-4-96q - * `nvidia_rtx_pro_6000_blackwell_dc-96q` - nvidia_rtx_pro_6000_blackwell_dc-96q - * `openshift` - OpenShift - * `platform_only` - platform_only - * `vmware_itadmin` - VMware IT admin - explode: true + - explode: true in: query name: vgpu_profile required: false schema: - enum: - - air - - bright-cluster - - bright_cluster - - flight-deck - - flight_deck - - nvidia-ai-enterprise - - nvidia_a40-48q - - nvidia_l40s-48q - - nvidia_rtx_pro_6000_blackwell_dc-4-96q - - nvidia_rtx_pro_6000_blackwell_dc-96q - - openshift - - platform_only - - vmware_itadmin - nullable: true type: string style: form responses: @@ -3186,6 +3240,7 @@ paths: lifetime: 3 modified: 2024-05-03T17:03:45.380Z node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -3235,6 +3290,7 @@ paths: inactivity_max: 3 lifetime: 3 node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -3288,6 +3344,7 @@ paths: lifetime: 3 modified: 2024-05-03T17:03:45.380Z node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -3421,7 +3478,7 @@ paths: security: - TokenAuthentication: [] tags: - - catalog/deployments + - catalog/experiences post: operationId: v1_catalog_experiences_notes_create parameters: @@ -3471,7 +3528,7 @@ paths: security: - TokenAuthentication: [] tags: - - catalog/deployments + - catalog/experiences /v1/catalog/experiences/{experience_id}/notes/{id}/: delete: operationId: v1_catalog_experiences_notes_destroy @@ -3498,7 +3555,7 @@ paths: security: - TokenAuthentication: [] tags: - - catalog/deployments + - catalog/experiences get: operationId: v1_catalog_experiences_notes_retrieve parameters: @@ -3554,7 +3611,7 @@ paths: security: - TokenAuthentication: [] tags: - - catalog/deployments + - catalog/experiences patch: operationId: v1_catalog_experiences_notes_partial_update parameters: @@ -3612,7 +3669,7 @@ paths: security: - TokenAuthentication: [] tags: - - catalog/deployments + - catalog/experiences put: operationId: v1_catalog_experiences_notes_update parameters: @@ -3670,7 +3727,7 @@ paths: security: - TokenAuthentication: [] tags: - - catalog/deployments + - catalog/experiences /v1/catalog/experiences/{id}/: delete: operationId: v1_catalog_experiences_destroy @@ -3760,6 +3817,7 @@ paths: lifetime: 3 modified: 2024-05-03T17:03:45.380Z node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -3819,6 +3877,7 @@ paths: inactivity_max: 3 lifetime: 3 node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -3872,6 +3931,7 @@ paths: lifetime: 3 modified: 2024-05-03T17:03:45.380Z node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -3931,6 +3991,7 @@ paths: inactivity_max: 3 lifetime: 3 node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -3984,6 +4045,7 @@ paths: lifetime: 3 modified: 2024-05-03T17:03:45.380Z node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -4090,6 +4152,7 @@ paths: inactivity_max: 3 lifetime: 3 node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e persona: developer pipeline: 5443221 platform: flight_deck @@ -4942,6 +5005,119 @@ paths: - TokenAuthentication: [] tags: - catalog/runtimes + /v1/catalog/vgpu-profile-choices/: + get: + operationId: v1_catalog_vgpu_profile_choices_list + parameters: + - description: Include only the specified fields in the response + explode: true + in: query + name: fields + required: false + schema: + type: string + style: form + - description: Exclude the specified fields in the response + explode: true + in: query + name: omit + required: false + schema: + type: string + style: form + - description: Which field to use when ordering the results. + explode: true + in: query + name: ordering + required: false + schema: + type: string + style: form + - description: A page number within the paginated result set. + explode: true + in: query + name: page + required: false + schema: + type: integer + style: form + - description: Number of results to return per page. + explode: true + in: query + name: page_size + required: false + schema: + type: integer + style: form + - description: "Search for vgpuprofilechoices by id, name" + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + responses: + "200": + content: + application/json: + examples: + VGPUProfileChoiceResponse: + summary: vGPU Profile Choice Response + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: 2024-04-01T06:14:32.602Z + id: 15 + modified: 2024-05-03T17:03:45.380Z + name: flight_deck + schema: + $ref: '#/components/schemas/PaginatedVGpuProfileChoiceList' + description: "" + security: + - TokenAuthentication: [] + tags: + - catalog/vgpu-profile-choices + post: + operationId: v1_catalog_vgpu_profile_choices_create + requestBody: + content: + application/json: + examples: + VGPUProfileChoiceRequest: + summary: vGPU Profile Choice Request + value: + name: flight_deck + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + multipart/form-data: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + required: true + responses: + "201": + content: + application/json: + examples: + VGPUProfileChoiceResponse: + summary: vGPU Profile Choice Response + value: + created: 2024-04-01T06:14:32.602Z + id: 15 + modified: 2024-05-03T17:03:45.380Z + name: flight_deck + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + description: "" + security: + - TokenAuthentication: [] + tags: + - catalog/vgpu-profile-choices /v1/identity/profile/: get: operationId: v1_identity_profile_retrieve @@ -4954,6 +5130,7 @@ paths: summary: Profile Response value: created: 2024-10-01T07:24:42.702Z + display_name: John Doe groups: - Reporters id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc @@ -5003,6 +5180,7 @@ paths: summary: Profile Response value: created: 2024-10-01T07:24:42.702Z + display_name: John Doe groups: - Reporters id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc @@ -5372,6 +5550,33 @@ paths: type: string type: array style: form + - description: |- + Multiple values may be separated by commas. + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + explode: false + in: query + name: provisioning_state_not + required: false + schema: + items: + enum: + - deployed + - deploying + - destroying + - pending + - ready + - reserved + - unprovisioned + type: string + type: array + style: form - explode: true in: query name: public_address @@ -5473,6 +5678,7 @@ paths: gpus: - c77f399a-8f69-4a07-b1f5-e35f8654cdfc id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: 2024-05-03T17:03:45.380Z last_used: 2024-05-03T15:04:44.410Z maintenance: false mgmt_ip: 172.16.0.11 @@ -5562,6 +5768,7 @@ paths: gpus: - c77f399a-8f69-4a07-b1f5-e35f8654cdfc id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: 2024-05-03T17:03:45.380Z last_used: 2024-05-03T15:04:44.410Z maintenance: false mgmt_ip: 172.16.0.11 @@ -5594,6 +5801,117 @@ paths: - TokenAuthentication: [] tags: - inventory/clusters + /v1/inventory/clusters/{cluster_id}/pipelines/: + get: + operationId: v1_inventory_clusters_pipelines_list + parameters: + - description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + explode: true + in: query + name: action + required: false + schema: + enum: + - apply + - destroy + - notify + type: string + style: form + - explode: false + in: path + name: cluster_id + required: true + schema: + format: uuid + type: string + style: simple + - explode: true + in: query + name: id + required: false + schema: + format: uuid + type: string + style: form + - description: Which field to use when ordering the results. + explode: true + in: query + name: ordering + required: false + schema: + type: string + style: form + - description: A page number within the paginated result set. + explode: true + in: query + name: page + required: false + schema: + type: integer + style: form + - description: Number of results to return per page. + explode: true + in: query + name: page_size + required: false + schema: + type: integer + style: form + - explode: true + in: query + name: pipeline_id + required: false + schema: + type: integer + style: form + - explode: true + in: query + name: request_id + required: false + schema: + type: string + style: form + - description: "Search for cluster-pipelines by action, id, pipeline_id, request_id,\ + \ url" + explode: true + in: query + name: search + required: false + schema: + type: string + style: form + responses: + "200": + content: + application/json: + examples: + ClusterPipelineResponse: + summary: ClusterPipeline Response + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - action: apply + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: 2024-04-01T06:14:32.602Z + id: 6d736f2c-d6b8-4e44-86a0-e6e2b7b9eaf4 + modified: 2024-05-03T17:03:45.380Z + pipeline_id: 5316124135 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/5316124135 + schema: + $ref: '#/components/schemas/PaginatedClusterPipelineList' + description: "" + security: + - TokenAuthentication: [] + tags: + - inventory/clusters /v1/inventory/clusters/{cluster_id}/tenants/: post: operationId: v1_inventory_clusters_tenants_create @@ -5638,6 +5956,7 @@ paths: gpus: - c77f399a-8f69-4a07-b1f5-e35f8654cdfc id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: 2024-05-03T17:03:45.380Z last_used: 2024-05-03T15:04:44.410Z maintenance: false mgmt_ip: 172.16.0.11 @@ -5775,6 +6094,7 @@ paths: gpus: - c77f399a-8f69-4a07-b1f5-e35f8654cdfc id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: 2024-05-03T17:03:45.380Z last_used: 2024-05-03T15:04:44.410Z maintenance: false mgmt_ip: 172.16.0.11 @@ -5874,6 +6194,7 @@ paths: gpus: - c77f399a-8f69-4a07-b1f5-e35f8654cdfc id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: 2024-05-03T17:03:45.380Z last_used: 2024-05-03T15:04:44.410Z maintenance: false mgmt_ip: 172.16.0.11 @@ -5973,6 +6294,7 @@ paths: gpus: - c77f399a-8f69-4a07-b1f5-e35f8654cdfc id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: 2024-05-03T17:03:45.380Z last_used: 2024-05-03T15:04:44.410Z maintenance: false mgmt_ip: 172.16.0.11 @@ -6152,6 +6474,7 @@ paths: gpus: - c77f399a-8f69-4a07-b1f5-e35f8654cdfc id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: 2024-05-03T17:03:45.380Z last_used: 2024-05-03T15:04:44.410Z maintenance: false mgmt_ip: 172.16.0.11 @@ -6237,6 +6560,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git workshop: false workshop_id: January training workshop_override_password: nvidia @@ -6278,6 +6602,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git workshop: false workshop_id: January training workshop_override_password: nvidia @@ -6319,6 +6644,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git workshop: false workshop_id: January training workshop_override_password: nvidia @@ -6390,6 +6716,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git workshop: false workshop_id: January training workshop_override_password: nvidia @@ -6512,6 +6839,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git workshop: false workshop_id: January training workshop_override_password: nvidia @@ -6553,6 +6881,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git workshop: false workshop_id: January training workshop_override_password: nvidia @@ -6594,6 +6923,7 @@ paths: runtime_cns_version: "16.0" runtime_mig: true runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git workshop: false workshop_id: January training workshop_override_password: nvidia @@ -6628,48 +6958,57 @@ paths: content: application/json: examples: - SuccessfulResponse: - summary: Successful Response + ClusterProvisionResponse: + summary: ClusterProvision Response value: - bastion_operating_system: ubuntu_22_04 - cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b - collection_branch: my-branch - experience_branch: main - flightcontrol_release: latest - garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd - gc_branch: main - gpu_alias: nvidia3.l40sx2.medium - gpu_count: 4 - gpu_model: l40s - gpu_os_name: ubuntu - gpu_os_release: jammy - gpu_os_version: "22.04" - min_gpu_count: 2 - node_count: 1 - oem_name: NVIDIA - persist_on_failure: false - persona: developer - pipeline: 5443221 - pipeline_branch: main - platform: flight_deck - provider_name: dmz - region: pdx - request_id: TRY-123 - runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 - runtime_branch: main - runtime_cns_addon_pack: false - runtime_cns_docker: true - runtime_cns_driver_version: 580.65.06 - runtime_cns_k8s: true - runtime_cns_nvidia_driver: true - runtime_cns_version: "16.0" - runtime_mig: true - runtime_mig_profile: all-2g.20gb - workshop: false - workshop_id: January training - workshop_override_password: nvidia + pipeline: + action: apply + created: 2024-04-01T06:14:32.602Z + id: 6d736f2c-d6b8-4e44-86a0-e6e2b7b9eaf4 + modified: 2024-05-03T17:03:45.380Z + pipeline_id: 5316124135 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/5316124135 + provisioning_config: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: noble + gpu_os_version: "24.04" + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: "16.0" + runtime_mig: true + runtime_mig_profile: all-2g.20gb + workshop: false + workshop_id: January training + workshop_override_password: nvidia schema: - $ref: '#/components/schemas/ProvisioningRequest' + $ref: '#/components/schemas/ClusterProvisionCreateResponse' description: "" security: - TokenAuthentication: [] @@ -9827,6 +10166,7 @@ components: provisioning_config: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enabled: true + last_provisioning_state_change: 2000-01-23T04:56:07.000+00:00 netmask: 19 gpu_alias: gpu_alias modified: 2000-01-23T04:56:07.000+00:00 @@ -9906,6 +10246,13 @@ components: $ref: '#/components/schemas/Cluster_instances_inner' type: array x-go-json-tag: "instances,omitempty" + last_provisioning_state_change: + description: Timestamp of the last time the cluster's provisioning_state + changed + format: date-time + nullable: true + readOnly: true + type: string last_used: description: Timestamp of when the cluster was last in use format: date-time @@ -10031,6 +10378,7 @@ components: - gpus - id - instances + - last_provisioning_state_change - last_used - modified - provider_capacity @@ -10051,6 +10399,7 @@ components: provisioning_config: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enabled: true + last_provisioning_state_change: 2000-01-23T04:56:07.000+00:00 result: result netmask: 19 gpu_alias: gpu_alias @@ -10144,6 +10493,14 @@ components: $ref: '#/components/schemas/Cluster_instances_inner' type: array x-go-json-tag: "instances,omitempty" + last_provisioning_state_change: + description: Timestamp of the last time the cluster's provisioning_state + changed + format: date-time + nullable: true + readOnly: true + type: string + writeOnly: true last_used: description: Timestamp of when the cluster was last in use format: date-time @@ -10307,6 +10664,7 @@ components: - id - ids - instances + - last_provisioning_state_change - last_used - modified - node_count @@ -10315,6 +10673,65 @@ components: - request_id - result - tenant_ids + ClusterPipeline: + example: + cluster: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + created: 2000-01-23T04:56:07.000+00:00 + pipeline_id: 0 + action: "" + modified: 2000-01-23T04:56:07.000+00:00 + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + request_id: request_id + url: https://openapi-generator.tech + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + readOnly: true + cluster: + $ref: '#/components/schemas/ClusterPipeline_cluster' + created: + description: Timestamp of when the object was created + format: date-time + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + modified: + description: Timestamp of when the object was last modified + format: date-time + readOnly: true + type: string + pipeline_id: + description: GitLab pipeline ID + readOnly: true + type: integer + request_id: + description: Request ID that the pipeline was triggered for + readOnly: true + type: string + url: + description: URL for the pipeline details + format: uri + readOnly: true + type: string + required: + - action + - cluster + - created + - id + - modified + - pipeline_id + - request_id + - url ClusterPipelineTrigger: example: created: 2000-01-23T04:56:07.000+00:00 @@ -10369,6 +10786,22 @@ components: - pipeline_id - request_id - url + ClusterProvisionCreateResponse: + example: + pipeline: "" + provisioning_config: "" + properties: + pipeline: + allOf: + - $ref: '#/components/schemas/ClusterPipeline' + readOnly: true + provisioning_config: + allOf: + - $ref: '#/components/schemas/ProvisioningRequest' + readOnly: true + required: + - pipeline + - provisioning_config CpuManufacturerEnum: description: |- * `amd` - AMD @@ -10472,7 +10905,7 @@ components: type: string writeOnly: true cluster: - $ref: '#/components/schemas/Deployment_cluster' + $ref: '#/components/schemas/ClusterPipeline_cluster' collection_branch: description: Override the Ansible collection branch initialized within the pipeline @@ -11528,6 +11961,54 @@ components: - modified - pipeline_id - url + DeploymentPipelineTrigger: + example: + created: 2000-01-23T04:56:07.000+00:00 + pipeline_id: 0 + action: "" + modified: 2000-01-23T04:56:07.000+00:00 + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + url: https://openapi-generator.tech + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + created: + description: Timestamp of when the object was created + format: date-time + readOnly: true + type: string + id: + format: uuid + readOnly: true + type: string + modified: + description: Timestamp of when the object was last modified + format: date-time + readOnly: true + type: string + pipeline_id: + description: GitLab pipeline ID + readOnly: true + type: integer + url: + description: URL for the pipeline details + format: uri + readOnly: true + type: string + required: + - action + - created + - id + - modified + - pipeline_id + - url DeploymentService: example: created: 2000-01-23T04:56:07.000+00:00 @@ -12217,7 +12698,7 @@ components: type: string writeOnly: true cluster: - $ref: '#/components/schemas/Deployment_cluster' + $ref: '#/components/schemas/ClusterPipeline_cluster' collection_branch: description: Override the Ansible collection branch initialized within the pipeline @@ -12564,6 +13045,7 @@ components: - state Experience: example: + featured: true inactivity_max: 1294386358 repo: https://openapi-generator.tech lifetime: 314780940 @@ -12574,10 +13056,11 @@ components: bootstrap: true experience: experience title: title - vgpu_profile: air + vgpu_profile: vgpu_profile platform: "" system_arch: "" provider: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + oem: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience_branch: experience_branch gc_branch: gc_branch modified: 2000-01-23T04:56:07.000+00:00 @@ -12669,6 +13152,10 @@ components: description: Does the experience support Flight Control? type: boolean writeOnly: true + featured: + description: Is the experience featured in the catalog? + readOnly: true + type: boolean garage_id: description: ID of the garage where nodes for this experience should be selected from @@ -12714,6 +13201,12 @@ components: maximum: 2147483647 minimum: 0 type: integer + oem: + description: "If set, the experience must be provisioned to hardware manufactured\ + \ by the given OEM" + format: uuid + nullable: true + type: string persona: type: string pipeline: @@ -12734,6 +13227,7 @@ components: * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift + * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 @@ -12786,12 +13280,14 @@ components: title: type: string vgpu_profile: - $ref: '#/components/schemas/VgpuProfileEnum' + nullable: true + type: string required: - catalog_id - category - created - experience + - featured - gpu_os - id - modified @@ -12804,7 +13300,8 @@ components: example: csv_file: https://openapi-generator.tech experiences: - - inactivity_max: 1294386358 + - featured: true + inactivity_max: 1294386358 repo: https://openapi-generator.tech lifetime: 314780940 required_gpus: @@ -12814,10 +13311,11 @@ components: bootstrap: true experience: experience title: title - vgpu_profile: air + vgpu_profile: vgpu_profile platform: "" system_arch: "" provider: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + oem: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience_branch: experience_branch gc_branch: gc_branch modified: 2000-01-23T04:56:07.000+00:00 @@ -12844,7 +13342,8 @@ components: assignee: assignee catalog_id_alias: catalog_id_alias category: "" - - inactivity_max: 1294386358 + - featured: true + inactivity_max: 1294386358 repo: https://openapi-generator.tech lifetime: 314780940 required_gpus: @@ -12854,10 +13353,11 @@ components: bootstrap: true experience: experience title: title - vgpu_profile: air + vgpu_profile: vgpu_profile platform: "" system_arch: "" provider: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + oem: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience_branch: experience_branch gc_branch: gc_branch modified: 2000-01-23T04:56:07.000+00:00 @@ -12898,6 +13398,7 @@ components: - experiences ExperienceBulkUpdate: example: + featured: true inactivity_max: 1294386358 repo: https://openapi-generator.tech lifetime: 314780940 @@ -12908,11 +13409,12 @@ components: bootstrap: true experience: experience title: title - vgpu_profile: air + vgpu_profile: vgpu_profile platform: "" result: result system_arch: "" provider: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + oem: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience_branch: experience_branch gc_branch: gc_branch modified: 2000-01-23T04:56:07.000+00:00 @@ -13019,6 +13521,11 @@ components: description: Does the experience support Flight Control? type: boolean writeOnly: true + featured: + description: Is the experience featured in the catalog? + readOnly: true + type: boolean + writeOnly: true garage_id: description: ID of the garage where nodes for this experience should be selected from @@ -13074,6 +13581,13 @@ components: minimum: 0 type: integer writeOnly: true + oem: + description: "If set, the experience must be provisioned to hardware manufactured\ + \ by the given OEM" + format: uuid + nullable: true + type: string + writeOnly: true persona: type: string writeOnly: true @@ -13096,6 +13610,7 @@ components: * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift + * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 @@ -13155,7 +13670,9 @@ components: type: string writeOnly: true vgpu_profile: - $ref: '#/components/schemas/VgpuProfileEnum' + nullable: true + type: string + writeOnly: true count: readOnly: true type: integer @@ -13174,6 +13691,7 @@ components: - count - created - experience + - featured - gpu_os - id - ids @@ -13457,7 +13975,7 @@ components: - tags properties: cluster: - $ref: '#/components/schemas/Deployment_cluster' + $ref: '#/components/schemas/ClusterPipeline_cluster' created: description: Timestamp of when the object was created format: date-time @@ -13529,7 +14047,7 @@ components: - tags properties: cluster: - $ref: '#/components/schemas/Deployment_cluster' + $ref: '#/components/schemas/ClusterPipeline_cluster' created: description: Timestamp of when the object was created format: date-time @@ -14711,6 +15229,7 @@ components: provisioning_config: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enabled: true + last_provisioning_state_change: 2000-01-23T04:56:07.000+00:00 netmask: 19 gpu_alias: gpu_alias modified: 2000-01-23T04:56:07.000+00:00 @@ -14754,6 +15273,7 @@ components: provisioning_config: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enabled: true + last_provisioning_state_change: 2000-01-23T04:56:07.000+00:00 netmask: 19 gpu_alias: gpu_alias modified: 2000-01-23T04:56:07.000+00:00 @@ -14804,6 +15324,49 @@ components: required: - count - results + PaginatedClusterPipelineList: + example: + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + count: 123 + results: + - cluster: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + created: 2000-01-23T04:56:07.000+00:00 + pipeline_id: 0 + action: "" + modified: 2000-01-23T04:56:07.000+00:00 + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + request_id: request_id + url: https://openapi-generator.tech + - cluster: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + created: 2000-01-23T04:56:07.000+00:00 + pipeline_id: 0 + action: "" + modified: 2000-01-23T04:56:07.000+00:00 + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + request_id: request_id + url: https://openapi-generator.tech + properties: + count: + example: 123 + type: integer + next: + example: https://launchpad.api.nvidia.com/example/?page=4 + format: uri + type: string + nullable: true + previous: + example: https://launchpad.api.nvidia.com/example/?page=2 + format: uri + type: string + nullable: true + results: + items: + $ref: '#/components/schemas/ClusterPipeline' + type: array + required: + - count + - results PaginatedDeploymentInstanceList: example: next: https://launchpad.api.nvidia.com/example/?page=4 @@ -15229,7 +15792,8 @@ components: previous: https://launchpad.api.nvidia.com/example/?page=2 count: 123 results: - - inactivity_max: 1294386358 + - featured: true + inactivity_max: 1294386358 repo: https://openapi-generator.tech lifetime: 314780940 required_gpus: @@ -15239,10 +15803,11 @@ components: bootstrap: true experience: experience title: title - vgpu_profile: air + vgpu_profile: vgpu_profile platform: "" system_arch: "" provider: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + oem: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience_branch: experience_branch gc_branch: gc_branch modified: 2000-01-23T04:56:07.000+00:00 @@ -15269,7 +15834,8 @@ components: assignee: assignee catalog_id_alias: catalog_id_alias category: "" - - inactivity_max: 1294386358 + - featured: true + inactivity_max: 1294386358 repo: https://openapi-generator.tech lifetime: 314780940 required_gpus: @@ -15279,10 +15845,11 @@ components: bootstrap: true experience: experience title: title - vgpu_profile: air + vgpu_profile: vgpu_profile platform: "" system_arch: "" provider: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + oem: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 experience_branch: experience_branch gc_branch: gc_branch modified: 2000-01-23T04:56:07.000+00:00 @@ -15940,6 +16507,41 @@ components: required: - count - results + PaginatedVGpuProfileChoiceList: + example: + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + count: 123 + results: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + modified: 2000-01-23T04:56:07.000+00:00 + id: 0 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + modified: 2000-01-23T04:56:07.000+00:00 + id: 0 + properties: + count: + example: 123 + type: integer + next: + example: https://launchpad.api.nvidia.com/example/?page=4 + format: uri + type: string + nullable: true + previous: + example: https://launchpad.api.nvidia.com/example/?page=2 + format: uri + type: string + nullable: true + results: + items: + $ref: '#/components/schemas/VGpuProfileChoice' + type: array + required: + - count + - results PasswordChange: example: result: Password changed successfully. @@ -16015,6 +16617,7 @@ components: * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift + * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 @@ -16026,6 +16629,7 @@ components: - lp-vmware-platform - minimal - openshift + - proxmox - vsphere - vsphere_horizon - vsphere7 @@ -16038,6 +16642,7 @@ components: - PlatformLpVmwarePlatformLegacy - PlatformMinimal - PlatformOpenshift + - PlatformProxmox - PlatformVsphere - PlatformVsphereHorizon - PlatformVsphere7 @@ -16079,6 +16684,7 @@ components: - groups modified: 2000-01-23T04:56:07.000+00:00 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + display_name: display_name preferred_view_settings: "" username: username properties: @@ -16087,6 +16693,11 @@ components: format: date-time readOnly: true type: string + display_name: + description: Display name of the user + nullable: true + readOnly: true + type: string groups: items: type: string @@ -16107,6 +16718,7 @@ components: type: string required: - created + - display_name - groups - id - modified @@ -16684,50 +17296,34 @@ components: x-enum-varnames: - TypeNVMe - TypeSSD - VgpuProfileEnum: - description: |- - * `air` - NVIDIA Air - * `bright_cluster` - Bright Cluster - * `bright-cluster` - Bright Cluster (legacy option) - * `flight_deck` - Flight Deck - * `flight-deck` - Flight Deck (legacy option) - * `nvidia_a40-48q` - nvidia_a40-48q - * `nvidia-ai-enterprise` - NVIDIA AI Enterprise - * `nvidia_l40s-48q` - nvidia_l40s-48q - * `nvidia_rtx_pro_6000_blackwell_dc-4-96q` - nvidia_rtx_pro_6000_blackwell_dc-4-96q - * `nvidia_rtx_pro_6000_blackwell_dc-96q` - nvidia_rtx_pro_6000_blackwell_dc-96q - * `openshift` - OpenShift - * `platform_only` - platform_only - * `vmware_itadmin` - VMware IT admin - enum: - - air - - bright_cluster - - bright-cluster - - flight_deck - - flight-deck - - nvidia_a40-48q - - nvidia-ai-enterprise - - nvidia_l40s-48q - - nvidia_rtx_pro_6000_blackwell_dc-4-96q - - nvidia_rtx_pro_6000_blackwell_dc-96q - - openshift - - platform_only - - vmware_itadmin - type: string - x-enum-varnames: - - VgpuProfileAir - - VgpuProfileBrightCluster - - VgpuProfileBrightClusterLegacy - - VgpuProfileFlightDeck - - VgpuProfileFlightDeckLegacy - - VgpuProfileNvidiaA4048QLegacy - - VgpuProfileNvidiaAiEnterpriseLegacy - - VgpuProfileNvidiaL40s48QLegacy - - VgpuProfileNvidiaRtxPro6000BlackwellDc496QLegacy - - VgpuProfileNvidiaRtxPro6000BlackwellDc96QLegacy - - VgpuProfileOpenshift - - VgpuProfilePlatformOnly - - VgpuProfileVmwareItadmin + VGpuProfileChoice: + example: + created: 2000-01-23T04:56:07.000+00:00 + name: name + modified: 2000-01-23T04:56:07.000+00:00 + id: 0 + properties: + created: + description: Timestamp of when the object was created + format: date-time + readOnly: true + type: string + id: + readOnly: true + type: integer + modified: + description: Timestamp of when the object was last modified + format: date-time + readOnly: true + type: string + name: + maxLength: 64 + type: string + required: + - created + - id + - modified + - name health_retrieve_200_response_components: example: database: database @@ -16786,7 +17382,7 @@ components: type: string - $ref: '#/components/schemas/Node' x-go-json-tag: "node,omitempty" - Deployment_cluster: + ClusterPipeline_cluster: oneOf: - format: uuid type: string diff --git a/v1/providers/launchpad/gen/launchpad/api_auth.go b/v1/providers/launchpad/gen/launchpad/api_auth.go index 1130dcc..1784c5a 100644 --- a/v1/providers/launchpad/gen/launchpad/api_auth.go +++ b/v1/providers/launchpad/gen/launchpad/api_auth.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_catalog_deployments.go b/v1/providers/launchpad/gen/launchpad/api_catalog_deployments.go index e179331..d33ff1a 100644 --- a/v1/providers/launchpad/gen/launchpad/api_catalog_deployments.go +++ b/v1/providers/launchpad/gen/launchpad/api_catalog_deployments.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -2655,6 +2655,133 @@ func (a *CatalogDeploymentsAPIService) V1CatalogDeploymentsPipelinesListExecute( return localVarReturnValue, localVarHTTPResponse, nil } +type ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest struct { + ctx context.Context + ApiService *CatalogDeploymentsAPIService + id string + deploymentPipelineTrigger *DeploymentPipelineTrigger +} + +func (r ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest) DeploymentPipelineTrigger(deploymentPipelineTrigger DeploymentPipelineTrigger) ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest { + r.deploymentPipelineTrigger = &deploymentPipelineTrigger + return r +} + +func (r ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest) Execute() (*DeploymentPipelineTrigger, *http.Response, error) { + return r.ApiService.V1CatalogDeploymentsPipelinesTriggerCreateExecute(r) +} + +/* +V1CatalogDeploymentsPipelinesTriggerCreate Method for V1CatalogDeploymentsPipelinesTriggerCreate + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param id + @return ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest +*/ +func (a *CatalogDeploymentsAPIService) V1CatalogDeploymentsPipelinesTriggerCreate(ctx context.Context, id string) ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest { + return ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest{ + ApiService: a, + ctx: ctx, + id: id, + } +} + +// Execute executes the request +// +// @return DeploymentPipelineTrigger +func (a *CatalogDeploymentsAPIService) V1CatalogDeploymentsPipelinesTriggerCreateExecute(r ApiV1CatalogDeploymentsPipelinesTriggerCreateRequest) (*DeploymentPipelineTrigger, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *DeploymentPipelineTrigger + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogDeploymentsAPIService.V1CatalogDeploymentsPipelinesTriggerCreate") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/deployments/{id}/pipelines/trigger/" + localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.deploymentPipelineTrigger == nil { + return localVarReturnValue, nil, reportError("deploymentPipelineTrigger is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.deploymentPipelineTrigger + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type ApiV1CatalogDeploymentsRetrieveRequest struct { ctx context.Context ApiService *CatalogDeploymentsAPIService @@ -4176,852 +4303,3 @@ func (a *CatalogDeploymentsAPIService) V1CatalogDeploymentsUpdateExecute(r ApiV1 return localVarReturnValue, localVarHTTPResponse, nil } - -type ApiV1CatalogExperiencesNotesCreateRequest struct { - ctx context.Context - ApiService *CatalogDeploymentsAPIService - experienceId string - experienceNote *ExperienceNote -} - -func (r ApiV1CatalogExperiencesNotesCreateRequest) ExperienceNote(experienceNote ExperienceNote) ApiV1CatalogExperiencesNotesCreateRequest { - r.experienceNote = &experienceNote - return r -} - -func (r ApiV1CatalogExperiencesNotesCreateRequest) Execute() (*ExperienceNote, *http.Response, error) { - return r.ApiService.V1CatalogExperiencesNotesCreateExecute(r) -} - -/* -V1CatalogExperiencesNotesCreate Method for V1CatalogExperiencesNotesCreate - - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param experienceId - @return ApiV1CatalogExperiencesNotesCreateRequest -*/ -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesCreate(ctx context.Context, experienceId string) ApiV1CatalogExperiencesNotesCreateRequest { - return ApiV1CatalogExperiencesNotesCreateRequest{ - ApiService: a, - ctx: ctx, - experienceId: experienceId, - } -} - -// Execute executes the request -// -// @return ExperienceNote -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesCreateExecute(r ApiV1CatalogExperiencesNotesCreateRequest) (*ExperienceNote, *http.Response, error) { - var ( - localVarHTTPMethod = http.MethodPost - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue *ExperienceNote - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogDeploymentsAPIService.V1CatalogExperiencesNotesCreate") - if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/" - localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := url.Values{} - localVarFormParams := url.Values{} - if r.experienceNote == nil { - return localVarReturnValue, nil, reportError("experienceNote is required and must be specified") - } - - // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - // body params - localVarPostBody = r.experienceNote - if r.ctx != nil { - // API Key Authentication - if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { - if apiKey, ok := auth["TokenAuthentication"]; ok { - var key string - if apiKey.Prefix != "" { - key = apiKey.Prefix + " " + apiKey.Key - } else { - key = apiKey.Key - } - localVarHeaderParams["Authorization"] = key - } - } - } - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) - if err != nil { - return localVarReturnValue, nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type ApiV1CatalogExperiencesNotesDestroyRequest struct { - ctx context.Context - ApiService *CatalogDeploymentsAPIService - experienceId string - id string -} - -func (r ApiV1CatalogExperiencesNotesDestroyRequest) Execute() (*http.Response, error) { - return r.ApiService.V1CatalogExperiencesNotesDestroyExecute(r) -} - -/* -V1CatalogExperiencesNotesDestroy Method for V1CatalogExperiencesNotesDestroy - - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param experienceId - @param id - @return ApiV1CatalogExperiencesNotesDestroyRequest -*/ -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesDestroy(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesDestroyRequest { - return ApiV1CatalogExperiencesNotesDestroyRequest{ - ApiService: a, - ctx: ctx, - experienceId: experienceId, - id: id, - } -} - -// Execute executes the request -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesDestroyExecute(r ApiV1CatalogExperiencesNotesDestroyRequest) (*http.Response, error) { - var ( - localVarHTTPMethod = http.MethodDelete - localVarPostBody interface{} - formFiles []formFile - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogDeploymentsAPIService.V1CatalogExperiencesNotesDestroy") - if err != nil { - return nil, &GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" - localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := url.Values{} - localVarFormParams := url.Values{} - - // to determine the Content-Type header - localVarHTTPContentTypes := []string{} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - if r.ctx != nil { - // API Key Authentication - if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { - if apiKey, ok := auth["TokenAuthentication"]; ok { - var key string - if apiKey.Prefix != "" { - key = apiKey.Prefix + " " + apiKey.Key - } else { - key = apiKey.Key - } - localVarHeaderParams["Authorization"] = key - } - } - } - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) - if err != nil { - return nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarHTTPResponse, err - } - - localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarHTTPResponse, newErr - } - - return localVarHTTPResponse, nil -} - -type ApiV1CatalogExperiencesNotesListRequest struct { - ctx context.Context - ApiService *CatalogDeploymentsAPIService - experienceId string - createdBy *int32 - experience *string - fields *string - id *string - modifiedBy *int32 - omit *string - ordering *string - page *int32 - pageSize *int32 - search *string -} - -func (r ApiV1CatalogExperiencesNotesListRequest) CreatedBy(createdBy int32) ApiV1CatalogExperiencesNotesListRequest { - r.createdBy = &createdBy - return r -} - -func (r ApiV1CatalogExperiencesNotesListRequest) Experience(experience string) ApiV1CatalogExperiencesNotesListRequest { - r.experience = &experience - return r -} - -// Include only the specified fields in the response -func (r ApiV1CatalogExperiencesNotesListRequest) Fields(fields string) ApiV1CatalogExperiencesNotesListRequest { - r.fields = &fields - return r -} - -func (r ApiV1CatalogExperiencesNotesListRequest) Id(id string) ApiV1CatalogExperiencesNotesListRequest { - r.id = &id - return r -} - -func (r ApiV1CatalogExperiencesNotesListRequest) ModifiedBy(modifiedBy int32) ApiV1CatalogExperiencesNotesListRequest { - r.modifiedBy = &modifiedBy - return r -} - -// Exclude the specified fields in the response -func (r ApiV1CatalogExperiencesNotesListRequest) Omit(omit string) ApiV1CatalogExperiencesNotesListRequest { - r.omit = &omit - return r -} - -// Which field to use when ordering the results. -func (r ApiV1CatalogExperiencesNotesListRequest) Ordering(ordering string) ApiV1CatalogExperiencesNotesListRequest { - r.ordering = &ordering - return r -} - -// A page number within the paginated result set. -func (r ApiV1CatalogExperiencesNotesListRequest) Page(page int32) ApiV1CatalogExperiencesNotesListRequest { - r.page = &page - return r -} - -// Number of results to return per page. -func (r ApiV1CatalogExperiencesNotesListRequest) PageSize(pageSize int32) ApiV1CatalogExperiencesNotesListRequest { - r.pageSize = &pageSize - return r -} - -// Search for experience-notes by content -func (r ApiV1CatalogExperiencesNotesListRequest) Search(search string) ApiV1CatalogExperiencesNotesListRequest { - r.search = &search - return r -} - -func (r ApiV1CatalogExperiencesNotesListRequest) Execute() (*PaginatedExperienceNoteList, *http.Response, error) { - return r.ApiService.V1CatalogExperiencesNotesListExecute(r) -} - -/* -V1CatalogExperiencesNotesList Method for V1CatalogExperiencesNotesList - - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param experienceId - @return ApiV1CatalogExperiencesNotesListRequest -*/ -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesList(ctx context.Context, experienceId string) ApiV1CatalogExperiencesNotesListRequest { - return ApiV1CatalogExperiencesNotesListRequest{ - ApiService: a, - ctx: ctx, - experienceId: experienceId, - } -} - -// Execute executes the request -// -// @return PaginatedExperienceNoteList -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesListExecute(r ApiV1CatalogExperiencesNotesListRequest) (*PaginatedExperienceNoteList, *http.Response, error) { - var ( - localVarHTTPMethod = http.MethodGet - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue *PaginatedExperienceNoteList - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogDeploymentsAPIService.V1CatalogExperiencesNotesList") - if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/" - localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := url.Values{} - localVarFormParams := url.Values{} - - if r.createdBy != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "created_by", r.createdBy, "form", "") - } - if r.experience != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "experience", r.experience, "form", "") - } - if r.fields != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "fields", r.fields, "form", "") - } - if r.id != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "") - } - if r.modifiedBy != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "modified_by", r.modifiedBy, "form", "") - } - if r.omit != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "omit", r.omit, "form", "") - } - if r.ordering != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "ordering", r.ordering, "form", "") - } - if r.page != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "page", r.page, "form", "") - } - if r.pageSize != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "page_size", r.pageSize, "form", "") - } - if r.search != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "search", r.search, "form", "") - } - // to determine the Content-Type header - localVarHTTPContentTypes := []string{} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - if r.ctx != nil { - // API Key Authentication - if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { - if apiKey, ok := auth["TokenAuthentication"]; ok { - var key string - if apiKey.Prefix != "" { - key = apiKey.Prefix + " " + apiKey.Key - } else { - key = apiKey.Key - } - localVarHeaderParams["Authorization"] = key - } - } - } - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) - if err != nil { - return localVarReturnValue, nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type ApiV1CatalogExperiencesNotesPartialUpdateRequest struct { - ctx context.Context - ApiService *CatalogDeploymentsAPIService - experienceId string - id string - experienceNote *ExperienceNote -} - -func (r ApiV1CatalogExperiencesNotesPartialUpdateRequest) ExperienceNote(experienceNote ExperienceNote) ApiV1CatalogExperiencesNotesPartialUpdateRequest { - r.experienceNote = &experienceNote - return r -} - -func (r ApiV1CatalogExperiencesNotesPartialUpdateRequest) Execute() (*ExperienceNote, *http.Response, error) { - return r.ApiService.V1CatalogExperiencesNotesPartialUpdateExecute(r) -} - -/* -V1CatalogExperiencesNotesPartialUpdate Method for V1CatalogExperiencesNotesPartialUpdate - - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param experienceId - @param id - @return ApiV1CatalogExperiencesNotesPartialUpdateRequest -*/ -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesPartialUpdate(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesPartialUpdateRequest { - return ApiV1CatalogExperiencesNotesPartialUpdateRequest{ - ApiService: a, - ctx: ctx, - experienceId: experienceId, - id: id, - } -} - -// Execute executes the request -// -// @return ExperienceNote -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesPartialUpdateExecute(r ApiV1CatalogExperiencesNotesPartialUpdateRequest) (*ExperienceNote, *http.Response, error) { - var ( - localVarHTTPMethod = http.MethodPatch - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue *ExperienceNote - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogDeploymentsAPIService.V1CatalogExperiencesNotesPartialUpdate") - if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" - localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := url.Values{} - localVarFormParams := url.Values{} - if r.experienceNote == nil { - return localVarReturnValue, nil, reportError("experienceNote is required and must be specified") - } - - // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - // body params - localVarPostBody = r.experienceNote - if r.ctx != nil { - // API Key Authentication - if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { - if apiKey, ok := auth["TokenAuthentication"]; ok { - var key string - if apiKey.Prefix != "" { - key = apiKey.Prefix + " " + apiKey.Key - } else { - key = apiKey.Key - } - localVarHeaderParams["Authorization"] = key - } - } - } - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) - if err != nil { - return localVarReturnValue, nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type ApiV1CatalogExperiencesNotesRetrieveRequest struct { - ctx context.Context - ApiService *CatalogDeploymentsAPIService - experienceId string - id string - fields *string - omit *string -} - -// Include only the specified fields in the response -func (r ApiV1CatalogExperiencesNotesRetrieveRequest) Fields(fields string) ApiV1CatalogExperiencesNotesRetrieveRequest { - r.fields = &fields - return r -} - -// Exclude the specified fields in the response -func (r ApiV1CatalogExperiencesNotesRetrieveRequest) Omit(omit string) ApiV1CatalogExperiencesNotesRetrieveRequest { - r.omit = &omit - return r -} - -func (r ApiV1CatalogExperiencesNotesRetrieveRequest) Execute() (*ExperienceNote, *http.Response, error) { - return r.ApiService.V1CatalogExperiencesNotesRetrieveExecute(r) -} - -/* -V1CatalogExperiencesNotesRetrieve Method for V1CatalogExperiencesNotesRetrieve - - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param experienceId - @param id - @return ApiV1CatalogExperiencesNotesRetrieveRequest -*/ -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesRetrieve(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesRetrieveRequest { - return ApiV1CatalogExperiencesNotesRetrieveRequest{ - ApiService: a, - ctx: ctx, - experienceId: experienceId, - id: id, - } -} - -// Execute executes the request -// -// @return ExperienceNote -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesRetrieveExecute(r ApiV1CatalogExperiencesNotesRetrieveRequest) (*ExperienceNote, *http.Response, error) { - var ( - localVarHTTPMethod = http.MethodGet - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue *ExperienceNote - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogDeploymentsAPIService.V1CatalogExperiencesNotesRetrieve") - if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" - localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := url.Values{} - localVarFormParams := url.Values{} - - if r.fields != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "fields", r.fields, "form", "") - } - if r.omit != nil { - parameterAddToHeaderOrQuery(localVarQueryParams, "omit", r.omit, "form", "") - } - // to determine the Content-Type header - localVarHTTPContentTypes := []string{} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - if r.ctx != nil { - // API Key Authentication - if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { - if apiKey, ok := auth["TokenAuthentication"]; ok { - var key string - if apiKey.Prefix != "" { - key = apiKey.Prefix + " " + apiKey.Key - } else { - key = apiKey.Key - } - localVarHeaderParams["Authorization"] = key - } - } - } - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) - if err != nil { - return localVarReturnValue, nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type ApiV1CatalogExperiencesNotesUpdateRequest struct { - ctx context.Context - ApiService *CatalogDeploymentsAPIService - experienceId string - id string - experienceNote *ExperienceNote -} - -func (r ApiV1CatalogExperiencesNotesUpdateRequest) ExperienceNote(experienceNote ExperienceNote) ApiV1CatalogExperiencesNotesUpdateRequest { - r.experienceNote = &experienceNote - return r -} - -func (r ApiV1CatalogExperiencesNotesUpdateRequest) Execute() (*ExperienceNote, *http.Response, error) { - return r.ApiService.V1CatalogExperiencesNotesUpdateExecute(r) -} - -/* -V1CatalogExperiencesNotesUpdate Method for V1CatalogExperiencesNotesUpdate - - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param experienceId - @param id - @return ApiV1CatalogExperiencesNotesUpdateRequest -*/ -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesUpdate(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesUpdateRequest { - return ApiV1CatalogExperiencesNotesUpdateRequest{ - ApiService: a, - ctx: ctx, - experienceId: experienceId, - id: id, - } -} - -// Execute executes the request -// -// @return ExperienceNote -func (a *CatalogDeploymentsAPIService) V1CatalogExperiencesNotesUpdateExecute(r ApiV1CatalogExperiencesNotesUpdateRequest) (*ExperienceNote, *http.Response, error) { - var ( - localVarHTTPMethod = http.MethodPut - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue *ExperienceNote - ) - - localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogDeploymentsAPIService.V1CatalogExperiencesNotesUpdate") - if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} - } - - localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" - localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) - - localVarHeaderParams := make(map[string]string) - localVarQueryParams := url.Values{} - localVarFormParams := url.Values{} - if r.experienceNote == nil { - return localVarReturnValue, nil, reportError("experienceNote is required and must be specified") - } - - // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} - - // set Content-Type header - localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) - if localVarHTTPContentType != "" { - localVarHeaderParams["Content-Type"] = localVarHTTPContentType - } - - // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} - - // set Accept header - localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) - if localVarHTTPHeaderAccept != "" { - localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept - } - // body params - localVarPostBody = r.experienceNote - if r.ctx != nil { - // API Key Authentication - if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { - if apiKey, ok := auth["TokenAuthentication"]; ok { - var key string - if apiKey.Prefix != "" { - key = apiKey.Prefix + " " + apiKey.Key - } else { - key = apiKey.Key - } - localVarHeaderParams["Authorization"] = key - } - } - } - req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) - if err != nil { - return localVarReturnValue, nil, err - } - - localVarHTTPResponse, err := a.client.callAPI(req) - if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) - localVarHTTPResponse.Body.Close() - localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) - if err != nil { - return localVarReturnValue, localVarHTTPResponse, err - } - - if localVarHTTPResponse.StatusCode >= 300 { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: localVarHTTPResponse.Status, - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} diff --git a/v1/providers/launchpad/gen/launchpad/api_catalog_experiences.go b/v1/providers/launchpad/gen/launchpad/api_catalog_experiences.go index 7f37609..968dd12 100644 --- a/v1/providers/launchpad/gen/launchpad/api_catalog_experiences.go +++ b/v1/providers/launchpad/gen/launchpad/api_catalog_experiences.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -661,6 +661,7 @@ type ApiV1CatalogExperiencesListRequest struct { expand *string experience *string experienceBranch *string + featured *bool fields *string garageId *string gcBranch *string @@ -670,6 +671,7 @@ type ApiV1CatalogExperiencesListRequest struct { gpuOsVersion *string id *string nodeCount *int32 + oem *string omit *string ordering *string page *int32 @@ -680,6 +682,7 @@ type ApiV1CatalogExperiencesListRequest struct { provider *string published *[]string requiresGpu *string + runtime *string saLab *bool search *string systemArch *string @@ -743,6 +746,11 @@ func (r ApiV1CatalogExperiencesListRequest) ExperienceBranch(experienceBranch st return r } +func (r ApiV1CatalogExperiencesListRequest) Featured(featured bool) ApiV1CatalogExperiencesListRequest { + r.featured = &featured + return r +} + // Include only the specified fields in the response func (r ApiV1CatalogExperiencesListRequest) Fields(fields string) ApiV1CatalogExperiencesListRequest { r.fields = &fields @@ -789,6 +797,11 @@ func (r ApiV1CatalogExperiencesListRequest) NodeCount(nodeCount int32) ApiV1Cata return r } +func (r ApiV1CatalogExperiencesListRequest) Oem(oem string) ApiV1CatalogExperiencesListRequest { + r.oem = &oem + return r +} + // Exclude the specified fields in the response func (r ApiV1CatalogExperiencesListRequest) Omit(omit string) ApiV1CatalogExperiencesListRequest { r.omit = &omit @@ -823,7 +836,7 @@ func (r ApiV1CatalogExperiencesListRequest) Pipeline(pipeline int32) ApiV1Catalo return r } -// Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 +// Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 func (r ApiV1CatalogExperiencesListRequest) Platform(platform string) ApiV1CatalogExperiencesListRequest { r.platform = &platform return r @@ -846,12 +859,17 @@ func (r ApiV1CatalogExperiencesListRequest) RequiresGpu(requiresGpu string) ApiV return r } +func (r ApiV1CatalogExperiencesListRequest) Runtime(runtime string) ApiV1CatalogExperiencesListRequest { + r.runtime = &runtime + return r +} + func (r ApiV1CatalogExperiencesListRequest) SaLab(saLab bool) ApiV1CatalogExperiencesListRequest { r.saLab = &saLab return r } -// Search for experiences by assignee, catalog_id, catalog_id_alias, category, collection_branch, description, experience, experience_branch, gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, persona, pipeline, platform, provider name, required_gpus model, system_arch, title, vgpu_profile +// Search for experiences by assignee, catalog_id, catalog_id_alias, category, collection_branch, description, experience, experience_branch, gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, oem name, persona, pipeline, platform, provider name, required_gpus model, runtime name, system_arch, title, vgpu_profile func (r ApiV1CatalogExperiencesListRequest) Search(search string) ApiV1CatalogExperiencesListRequest { r.search = &search return r @@ -863,7 +881,6 @@ func (r ApiV1CatalogExperiencesListRequest) SystemArch(systemArch string) ApiV1C return r } -// vGPU profile name used by the experience * `air` - NVIDIA Air * `bright_cluster` - Bright Cluster * `bright-cluster` - Bright Cluster (legacy option) * `flight_deck` - Flight Deck * `flight-deck` - Flight Deck (legacy option) * `nvidia_a40-48q` - nvidia_a40-48q * `nvidia-ai-enterprise` - NVIDIA AI Enterprise * `nvidia_l40s-48q` - nvidia_l40s-48q * `nvidia_rtx_pro_6000_blackwell_dc-4-96q` - nvidia_rtx_pro_6000_blackwell_dc-4-96q * `nvidia_rtx_pro_6000_blackwell_dc-96q` - nvidia_rtx_pro_6000_blackwell_dc-96q * `openshift` - OpenShift * `platform_only` - platform_only * `vmware_itadmin` - VMware IT admin func (r ApiV1CatalogExperiencesListRequest) VgpuProfile(vgpuProfile string) ApiV1CatalogExperiencesListRequest { r.vgpuProfile = &vgpuProfile return r @@ -941,6 +958,9 @@ func (a *CatalogExperiencesAPIService) V1CatalogExperiencesListExecute(r ApiV1Ca if r.experienceBranch != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "experience_branch", r.experienceBranch, "form", "") } + if r.featured != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "featured", r.featured, "form", "") + } if r.fields != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "fields", r.fields, "form", "") } @@ -968,6 +988,9 @@ func (a *CatalogExperiencesAPIService) V1CatalogExperiencesListExecute(r ApiV1Ca if r.nodeCount != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "node_count", r.nodeCount, "form", "") } + if r.oem != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "oem", r.oem, "form", "") + } if r.omit != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "omit", r.omit, "form", "") } @@ -998,6 +1021,9 @@ func (a *CatalogExperiencesAPIService) V1CatalogExperiencesListExecute(r ApiV1Ca if r.requiresGpu != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "requires_gpu", r.requiresGpu, "form", "") } + if r.runtime != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "runtime", r.runtime, "form", "") + } if r.saLab != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "sa_lab", r.saLab, "form", "") } @@ -1078,6 +1104,855 @@ func (a *CatalogExperiencesAPIService) V1CatalogExperiencesListExecute(r ApiV1Ca return localVarReturnValue, localVarHTTPResponse, nil } +type ApiV1CatalogExperiencesNotesCreateRequest struct { + ctx context.Context + ApiService *CatalogExperiencesAPIService + experienceId string + experienceNote *ExperienceNote +} + +func (r ApiV1CatalogExperiencesNotesCreateRequest) ExperienceNote(experienceNote ExperienceNote) ApiV1CatalogExperiencesNotesCreateRequest { + r.experienceNote = &experienceNote + return r +} + +func (r ApiV1CatalogExperiencesNotesCreateRequest) Execute() (*ExperienceNote, *http.Response, error) { + return r.ApiService.V1CatalogExperiencesNotesCreateExecute(r) +} + +/* +V1CatalogExperiencesNotesCreate Method for V1CatalogExperiencesNotesCreate + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param experienceId + @return ApiV1CatalogExperiencesNotesCreateRequest +*/ +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesCreate(ctx context.Context, experienceId string) ApiV1CatalogExperiencesNotesCreateRequest { + return ApiV1CatalogExperiencesNotesCreateRequest{ + ApiService: a, + ctx: ctx, + experienceId: experienceId, + } +} + +// Execute executes the request +// +// @return ExperienceNote +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesCreateExecute(r ApiV1CatalogExperiencesNotesCreateRequest) (*ExperienceNote, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *ExperienceNote + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogExperiencesAPIService.V1CatalogExperiencesNotesCreate") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/" + localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.experienceNote == nil { + return localVarReturnValue, nil, reportError("experienceNote is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.experienceNote + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiV1CatalogExperiencesNotesDestroyRequest struct { + ctx context.Context + ApiService *CatalogExperiencesAPIService + experienceId string + id string +} + +func (r ApiV1CatalogExperiencesNotesDestroyRequest) Execute() (*http.Response, error) { + return r.ApiService.V1CatalogExperiencesNotesDestroyExecute(r) +} + +/* +V1CatalogExperiencesNotesDestroy Method for V1CatalogExperiencesNotesDestroy + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param experienceId + @param id + @return ApiV1CatalogExperiencesNotesDestroyRequest +*/ +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesDestroy(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesDestroyRequest { + return ApiV1CatalogExperiencesNotesDestroyRequest{ + ApiService: a, + ctx: ctx, + experienceId: experienceId, + id: id, + } +} + +// Execute executes the request +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesDestroyExecute(r ApiV1CatalogExperiencesNotesDestroyRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogExperiencesAPIService.V1CatalogExperiencesNotesDestroy") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" + localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiV1CatalogExperiencesNotesListRequest struct { + ctx context.Context + ApiService *CatalogExperiencesAPIService + experienceId string + createdBy *int32 + experience *string + fields *string + id *string + modifiedBy *int32 + omit *string + ordering *string + page *int32 + pageSize *int32 + search *string +} + +func (r ApiV1CatalogExperiencesNotesListRequest) CreatedBy(createdBy int32) ApiV1CatalogExperiencesNotesListRequest { + r.createdBy = &createdBy + return r +} + +func (r ApiV1CatalogExperiencesNotesListRequest) Experience(experience string) ApiV1CatalogExperiencesNotesListRequest { + r.experience = &experience + return r +} + +// Include only the specified fields in the response +func (r ApiV1CatalogExperiencesNotesListRequest) Fields(fields string) ApiV1CatalogExperiencesNotesListRequest { + r.fields = &fields + return r +} + +func (r ApiV1CatalogExperiencesNotesListRequest) Id(id string) ApiV1CatalogExperiencesNotesListRequest { + r.id = &id + return r +} + +func (r ApiV1CatalogExperiencesNotesListRequest) ModifiedBy(modifiedBy int32) ApiV1CatalogExperiencesNotesListRequest { + r.modifiedBy = &modifiedBy + return r +} + +// Exclude the specified fields in the response +func (r ApiV1CatalogExperiencesNotesListRequest) Omit(omit string) ApiV1CatalogExperiencesNotesListRequest { + r.omit = &omit + return r +} + +// Which field to use when ordering the results. +func (r ApiV1CatalogExperiencesNotesListRequest) Ordering(ordering string) ApiV1CatalogExperiencesNotesListRequest { + r.ordering = &ordering + return r +} + +// A page number within the paginated result set. +func (r ApiV1CatalogExperiencesNotesListRequest) Page(page int32) ApiV1CatalogExperiencesNotesListRequest { + r.page = &page + return r +} + +// Number of results to return per page. +func (r ApiV1CatalogExperiencesNotesListRequest) PageSize(pageSize int32) ApiV1CatalogExperiencesNotesListRequest { + r.pageSize = &pageSize + return r +} + +// Search for experience-notes by content +func (r ApiV1CatalogExperiencesNotesListRequest) Search(search string) ApiV1CatalogExperiencesNotesListRequest { + r.search = &search + return r +} + +func (r ApiV1CatalogExperiencesNotesListRequest) Execute() (*PaginatedExperienceNoteList, *http.Response, error) { + return r.ApiService.V1CatalogExperiencesNotesListExecute(r) +} + +/* +V1CatalogExperiencesNotesList Method for V1CatalogExperiencesNotesList + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param experienceId + @return ApiV1CatalogExperiencesNotesListRequest +*/ +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesList(ctx context.Context, experienceId string) ApiV1CatalogExperiencesNotesListRequest { + return ApiV1CatalogExperiencesNotesListRequest{ + ApiService: a, + ctx: ctx, + experienceId: experienceId, + } +} + +// Execute executes the request +// +// @return PaginatedExperienceNoteList +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesListExecute(r ApiV1CatalogExperiencesNotesListRequest) (*PaginatedExperienceNoteList, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PaginatedExperienceNoteList + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogExperiencesAPIService.V1CatalogExperiencesNotesList") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/" + localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + if r.createdBy != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "created_by", r.createdBy, "form", "") + } + if r.experience != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "experience", r.experience, "form", "") + } + if r.fields != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "fields", r.fields, "form", "") + } + if r.id != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "") + } + if r.modifiedBy != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "modified_by", r.modifiedBy, "form", "") + } + if r.omit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "omit", r.omit, "form", "") + } + if r.ordering != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "ordering", r.ordering, "form", "") + } + if r.page != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "page", r.page, "form", "") + } + if r.pageSize != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "page_size", r.pageSize, "form", "") + } + if r.search != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "search", r.search, "form", "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiV1CatalogExperiencesNotesPartialUpdateRequest struct { + ctx context.Context + ApiService *CatalogExperiencesAPIService + experienceId string + id string + experienceNote *ExperienceNote +} + +func (r ApiV1CatalogExperiencesNotesPartialUpdateRequest) ExperienceNote(experienceNote ExperienceNote) ApiV1CatalogExperiencesNotesPartialUpdateRequest { + r.experienceNote = &experienceNote + return r +} + +func (r ApiV1CatalogExperiencesNotesPartialUpdateRequest) Execute() (*ExperienceNote, *http.Response, error) { + return r.ApiService.V1CatalogExperiencesNotesPartialUpdateExecute(r) +} + +/* +V1CatalogExperiencesNotesPartialUpdate Method for V1CatalogExperiencesNotesPartialUpdate + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param experienceId + @param id + @return ApiV1CatalogExperiencesNotesPartialUpdateRequest +*/ +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesPartialUpdate(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesPartialUpdateRequest { + return ApiV1CatalogExperiencesNotesPartialUpdateRequest{ + ApiService: a, + ctx: ctx, + experienceId: experienceId, + id: id, + } +} + +// Execute executes the request +// +// @return ExperienceNote +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesPartialUpdateExecute(r ApiV1CatalogExperiencesNotesPartialUpdateRequest) (*ExperienceNote, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPatch + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *ExperienceNote + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogExperiencesAPIService.V1CatalogExperiencesNotesPartialUpdate") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" + localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.experienceNote == nil { + return localVarReturnValue, nil, reportError("experienceNote is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.experienceNote + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiV1CatalogExperiencesNotesRetrieveRequest struct { + ctx context.Context + ApiService *CatalogExperiencesAPIService + experienceId string + id string + fields *string + omit *string +} + +// Include only the specified fields in the response +func (r ApiV1CatalogExperiencesNotesRetrieveRequest) Fields(fields string) ApiV1CatalogExperiencesNotesRetrieveRequest { + r.fields = &fields + return r +} + +// Exclude the specified fields in the response +func (r ApiV1CatalogExperiencesNotesRetrieveRequest) Omit(omit string) ApiV1CatalogExperiencesNotesRetrieveRequest { + r.omit = &omit + return r +} + +func (r ApiV1CatalogExperiencesNotesRetrieveRequest) Execute() (*ExperienceNote, *http.Response, error) { + return r.ApiService.V1CatalogExperiencesNotesRetrieveExecute(r) +} + +/* +V1CatalogExperiencesNotesRetrieve Method for V1CatalogExperiencesNotesRetrieve + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param experienceId + @param id + @return ApiV1CatalogExperiencesNotesRetrieveRequest +*/ +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesRetrieve(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesRetrieveRequest { + return ApiV1CatalogExperiencesNotesRetrieveRequest{ + ApiService: a, + ctx: ctx, + experienceId: experienceId, + id: id, + } +} + +// Execute executes the request +// +// @return ExperienceNote +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesRetrieveExecute(r ApiV1CatalogExperiencesNotesRetrieveRequest) (*ExperienceNote, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *ExperienceNote + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogExperiencesAPIService.V1CatalogExperiencesNotesRetrieve") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" + localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + if r.fields != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "fields", r.fields, "form", "") + } + if r.omit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "omit", r.omit, "form", "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiV1CatalogExperiencesNotesUpdateRequest struct { + ctx context.Context + ApiService *CatalogExperiencesAPIService + experienceId string + id string + experienceNote *ExperienceNote +} + +func (r ApiV1CatalogExperiencesNotesUpdateRequest) ExperienceNote(experienceNote ExperienceNote) ApiV1CatalogExperiencesNotesUpdateRequest { + r.experienceNote = &experienceNote + return r +} + +func (r ApiV1CatalogExperiencesNotesUpdateRequest) Execute() (*ExperienceNote, *http.Response, error) { + return r.ApiService.V1CatalogExperiencesNotesUpdateExecute(r) +} + +/* +V1CatalogExperiencesNotesUpdate Method for V1CatalogExperiencesNotesUpdate + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param experienceId + @param id + @return ApiV1CatalogExperiencesNotesUpdateRequest +*/ +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesUpdate(ctx context.Context, experienceId string, id string) ApiV1CatalogExperiencesNotesUpdateRequest { + return ApiV1CatalogExperiencesNotesUpdateRequest{ + ApiService: a, + ctx: ctx, + experienceId: experienceId, + id: id, + } +} + +// Execute executes the request +// +// @return ExperienceNote +func (a *CatalogExperiencesAPIService) V1CatalogExperiencesNotesUpdateExecute(r ApiV1CatalogExperiencesNotesUpdateRequest) (*ExperienceNote, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPut + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *ExperienceNote + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogExperiencesAPIService.V1CatalogExperiencesNotesUpdate") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/experiences/{experience_id}/notes/{id}/" + localVarPath = strings.Replace(localVarPath, "{"+"experience_id"+"}", url.PathEscape(parameterValueToString(r.experienceId, "experienceId")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.experienceNote == nil { + return localVarReturnValue, nil, reportError("experienceNote is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.experienceNote + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type ApiV1CatalogExperiencesPartialUpdateRequest struct { ctx context.Context ApiService *CatalogExperiencesAPIService diff --git a/v1/providers/launchpad/gen/launchpad/api_catalog_gpu_os_choices.go b/v1/providers/launchpad/gen/launchpad/api_catalog_gpu_os_choices.go index f68b141..d505f66 100644 --- a/v1/providers/launchpad/gen/launchpad/api_catalog_gpu_os_choices.go +++ b/v1/providers/launchpad/gen/launchpad/api_catalog_gpu_os_choices.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_catalog_instance_types.go b/v1/providers/launchpad/gen/launchpad/api_catalog_instance_types.go index 9d08314..126b14d 100644 --- a/v1/providers/launchpad/gen/launchpad/api_catalog_instance_types.go +++ b/v1/providers/launchpad/gen/launchpad/api_catalog_instance_types.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_catalog_persona_choices.go b/v1/providers/launchpad/gen/launchpad/api_catalog_persona_choices.go index 1b1f6bd..8ead7e7 100644 --- a/v1/providers/launchpad/gen/launchpad/api_catalog_persona_choices.go +++ b/v1/providers/launchpad/gen/launchpad/api_catalog_persona_choices.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_catalog_runtimes.go b/v1/providers/launchpad/gen/launchpad/api_catalog_runtimes.go index 41335cc..985cb98 100644 --- a/v1/providers/launchpad/gen/launchpad/api_catalog_runtimes.go +++ b/v1/providers/launchpad/gen/launchpad/api_catalog_runtimes.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_catalog_vgpu_profile_choices.go b/v1/providers/launchpad/gen/launchpad/api_catalog_vgpu_profile_choices.go new file mode 100644 index 0000000..346ce2c --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/api_catalog_vgpu_profile_choices.go @@ -0,0 +1,317 @@ +/* +NVIDIA LaunchPad API + +RESTful API for interacting with the NVIDIA LaunchPad platform + +API version: 2.40.9 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package openapi + +import ( + "bytes" + "context" + "io" + "net/http" + "net/url" +) + +// CatalogVgpuProfileChoicesAPIService CatalogVgpuProfileChoicesAPI service +type CatalogVgpuProfileChoicesAPIService service + +type ApiV1CatalogVgpuProfileChoicesCreateRequest struct { + ctx context.Context + ApiService *CatalogVgpuProfileChoicesAPIService + vGpuProfileChoice *VGpuProfileChoice +} + +func (r ApiV1CatalogVgpuProfileChoicesCreateRequest) VGpuProfileChoice(vGpuProfileChoice VGpuProfileChoice) ApiV1CatalogVgpuProfileChoicesCreateRequest { + r.vGpuProfileChoice = &vGpuProfileChoice + return r +} + +func (r ApiV1CatalogVgpuProfileChoicesCreateRequest) Execute() (*VGpuProfileChoice, *http.Response, error) { + return r.ApiService.V1CatalogVgpuProfileChoicesCreateExecute(r) +} + +/* +V1CatalogVgpuProfileChoicesCreate Method for V1CatalogVgpuProfileChoicesCreate + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiV1CatalogVgpuProfileChoicesCreateRequest +*/ +func (a *CatalogVgpuProfileChoicesAPIService) V1CatalogVgpuProfileChoicesCreate(ctx context.Context) ApiV1CatalogVgpuProfileChoicesCreateRequest { + return ApiV1CatalogVgpuProfileChoicesCreateRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// +// @return VGpuProfileChoice +func (a *CatalogVgpuProfileChoicesAPIService) V1CatalogVgpuProfileChoicesCreateExecute(r ApiV1CatalogVgpuProfileChoicesCreateRequest) (*VGpuProfileChoice, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *VGpuProfileChoice + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogVgpuProfileChoicesAPIService.V1CatalogVgpuProfileChoicesCreate") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/vgpu-profile-choices/" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.vGpuProfileChoice == nil { + return localVarReturnValue, nil, reportError("vGpuProfileChoice is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded", "multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.vGpuProfileChoice + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiV1CatalogVgpuProfileChoicesListRequest struct { + ctx context.Context + ApiService *CatalogVgpuProfileChoicesAPIService + fields *string + omit *string + ordering *string + page *int32 + pageSize *int32 + search *string +} + +// Include only the specified fields in the response +func (r ApiV1CatalogVgpuProfileChoicesListRequest) Fields(fields string) ApiV1CatalogVgpuProfileChoicesListRequest { + r.fields = &fields + return r +} + +// Exclude the specified fields in the response +func (r ApiV1CatalogVgpuProfileChoicesListRequest) Omit(omit string) ApiV1CatalogVgpuProfileChoicesListRequest { + r.omit = &omit + return r +} + +// Which field to use when ordering the results. +func (r ApiV1CatalogVgpuProfileChoicesListRequest) Ordering(ordering string) ApiV1CatalogVgpuProfileChoicesListRequest { + r.ordering = &ordering + return r +} + +// A page number within the paginated result set. +func (r ApiV1CatalogVgpuProfileChoicesListRequest) Page(page int32) ApiV1CatalogVgpuProfileChoicesListRequest { + r.page = &page + return r +} + +// Number of results to return per page. +func (r ApiV1CatalogVgpuProfileChoicesListRequest) PageSize(pageSize int32) ApiV1CatalogVgpuProfileChoicesListRequest { + r.pageSize = &pageSize + return r +} + +// Search for vgpuprofilechoices by id, name +func (r ApiV1CatalogVgpuProfileChoicesListRequest) Search(search string) ApiV1CatalogVgpuProfileChoicesListRequest { + r.search = &search + return r +} + +func (r ApiV1CatalogVgpuProfileChoicesListRequest) Execute() (*PaginatedVGpuProfileChoiceList, *http.Response, error) { + return r.ApiService.V1CatalogVgpuProfileChoicesListExecute(r) +} + +/* +V1CatalogVgpuProfileChoicesList Method for V1CatalogVgpuProfileChoicesList + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiV1CatalogVgpuProfileChoicesListRequest +*/ +func (a *CatalogVgpuProfileChoicesAPIService) V1CatalogVgpuProfileChoicesList(ctx context.Context) ApiV1CatalogVgpuProfileChoicesListRequest { + return ApiV1CatalogVgpuProfileChoicesListRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// +// @return PaginatedVGpuProfileChoiceList +func (a *CatalogVgpuProfileChoicesAPIService) V1CatalogVgpuProfileChoicesListExecute(r ApiV1CatalogVgpuProfileChoicesListRequest) (*PaginatedVGpuProfileChoiceList, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PaginatedVGpuProfileChoiceList + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "CatalogVgpuProfileChoicesAPIService.V1CatalogVgpuProfileChoicesList") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/catalog/vgpu-profile-choices/" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + if r.fields != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "fields", r.fields, "form", "") + } + if r.omit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "omit", r.omit, "form", "") + } + if r.ordering != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "ordering", r.ordering, "form", "") + } + if r.page != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "page", r.page, "form", "") + } + if r.pageSize != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "page_size", r.pageSize, "form", "") + } + if r.search != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "search", r.search, "form", "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} diff --git a/v1/providers/launchpad/gen/launchpad/api_health.go b/v1/providers/launchpad/gen/launchpad/api_health.go index bdc5cb2..7c65c11 100644 --- a/v1/providers/launchpad/gen/launchpad/api_health.go +++ b/v1/providers/launchpad/gen/launchpad/api_health.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_identity_profile.go b/v1/providers/launchpad/gen/launchpad/api_identity_profile.go index b3c2f86..351ce62 100644 --- a/v1/providers/launchpad/gen/launchpad/api_identity_profile.go +++ b/v1/providers/launchpad/gen/launchpad/api_identity_profile.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_inventory_clusters.go b/v1/providers/launchpad/gen/launchpad/api_inventory_clusters.go index cd777ab..477db17 100644 --- a/v1/providers/launchpad/gen/launchpad/api_inventory_clusters.go +++ b/v1/providers/launchpad/gen/launchpad/api_inventory_clusters.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -549,6 +549,7 @@ type ApiV1InventoryClustersListRequest struct { provisionUser *string provisioningAttempts *int32 provisioningState *[]string + provisioningStateNot *[]string publicAddress *string rack *string requestId *string @@ -788,6 +789,12 @@ func (r ApiV1InventoryClustersListRequest) ProvisioningState(provisioningState [ return r } +// Multiple values may be separated by commas. * `deployed` - Cluster is in use by a deployment * `deploying` - Provisioning is in progress * `destroying` - Cluster is being destroyed * `pending` - Provisioning will begin soon * `ready` - Provisioning has completed and is ready for a deployment * `reserved` - Cluster is unprovisioned but reserved for later use * `unprovisioned` - Cluster has not yet been provisioned +func (r ApiV1InventoryClustersListRequest) ProvisioningStateNot(provisioningStateNot []string) ApiV1InventoryClustersListRequest { + r.provisioningStateNot = &provisioningStateNot + return r +} + func (r ApiV1InventoryClustersListRequest) PublicAddress(publicAddress string) ApiV1InventoryClustersListRequest { r.publicAddress = &publicAddress return r @@ -1003,6 +1010,9 @@ func (a *InventoryClustersAPIService) V1InventoryClustersListExecute(r ApiV1Inve if r.provisioningState != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "provisioning_state", r.provisioningState, "form", "csv") } + if r.provisioningStateNot != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "provisioning_state_not", r.provisioningStateNot, "form", "csv") + } if r.publicAddress != nil { parameterAddToHeaderOrQuery(localVarQueryParams, "public_address", r.publicAddress, "form", "") } @@ -1225,6 +1235,199 @@ func (a *InventoryClustersAPIService) V1InventoryClustersPartialUpdateExecute(r return localVarReturnValue, localVarHTTPResponse, nil } +type ApiV1InventoryClustersPipelinesListRequest struct { + ctx context.Context + ApiService *InventoryClustersAPIService + clusterId string + action *string + id *string + ordering *string + page *int32 + pageSize *int32 + pipelineId *int32 + requestId *string + search *string +} + +// Action for the pipeline to run * `apply` - apply * `destroy` - destroy * `notify` - notify +func (r ApiV1InventoryClustersPipelinesListRequest) Action(action string) ApiV1InventoryClustersPipelinesListRequest { + r.action = &action + return r +} + +func (r ApiV1InventoryClustersPipelinesListRequest) Id(id string) ApiV1InventoryClustersPipelinesListRequest { + r.id = &id + return r +} + +// Which field to use when ordering the results. +func (r ApiV1InventoryClustersPipelinesListRequest) Ordering(ordering string) ApiV1InventoryClustersPipelinesListRequest { + r.ordering = &ordering + return r +} + +// A page number within the paginated result set. +func (r ApiV1InventoryClustersPipelinesListRequest) Page(page int32) ApiV1InventoryClustersPipelinesListRequest { + r.page = &page + return r +} + +// Number of results to return per page. +func (r ApiV1InventoryClustersPipelinesListRequest) PageSize(pageSize int32) ApiV1InventoryClustersPipelinesListRequest { + r.pageSize = &pageSize + return r +} + +func (r ApiV1InventoryClustersPipelinesListRequest) PipelineId(pipelineId int32) ApiV1InventoryClustersPipelinesListRequest { + r.pipelineId = &pipelineId + return r +} + +func (r ApiV1InventoryClustersPipelinesListRequest) RequestId(requestId string) ApiV1InventoryClustersPipelinesListRequest { + r.requestId = &requestId + return r +} + +// Search for cluster-pipelines by action, id, pipeline_id, request_id, url +func (r ApiV1InventoryClustersPipelinesListRequest) Search(search string) ApiV1InventoryClustersPipelinesListRequest { + r.search = &search + return r +} + +func (r ApiV1InventoryClustersPipelinesListRequest) Execute() (*PaginatedClusterPipelineList, *http.Response, error) { + return r.ApiService.V1InventoryClustersPipelinesListExecute(r) +} + +/* +V1InventoryClustersPipelinesList Method for V1InventoryClustersPipelinesList + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param clusterId + @return ApiV1InventoryClustersPipelinesListRequest +*/ +func (a *InventoryClustersAPIService) V1InventoryClustersPipelinesList(ctx context.Context, clusterId string) ApiV1InventoryClustersPipelinesListRequest { + return ApiV1InventoryClustersPipelinesListRequest{ + ApiService: a, + ctx: ctx, + clusterId: clusterId, + } +} + +// Execute executes the request +// +// @return PaginatedClusterPipelineList +func (a *InventoryClustersAPIService) V1InventoryClustersPipelinesListExecute(r ApiV1InventoryClustersPipelinesListRequest) (*PaginatedClusterPipelineList, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PaginatedClusterPipelineList + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "InventoryClustersAPIService.V1InventoryClustersPipelinesList") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/inventory/clusters/{cluster_id}/pipelines/" + localVarPath = strings.Replace(localVarPath, "{"+"cluster_id"+"}", url.PathEscape(parameterValueToString(r.clusterId, "clusterId")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + if r.action != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "action", r.action, "form", "") + } + if r.id != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "") + } + if r.ordering != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "ordering", r.ordering, "form", "") + } + if r.page != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "page", r.page, "form", "") + } + if r.pageSize != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "page_size", r.pageSize, "form", "") + } + if r.pipelineId != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "pipeline_id", r.pipelineId, "form", "") + } + if r.requestId != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "request_id", r.requestId, "form", "") + } + if r.search != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "search", r.search, "form", "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["TokenAuthentication"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type ApiV1InventoryClustersPipelinesTriggerCreateRequest struct { ctx context.Context ApiService *InventoryClustersAPIService @@ -1370,7 +1573,7 @@ func (r ApiV1InventoryClustersProvisionCreateRequest) Expand(expand string) ApiV return r } -func (r ApiV1InventoryClustersProvisionCreateRequest) Execute() (*ProvisioningRequest, *http.Response, error) { +func (r ApiV1InventoryClustersProvisionCreateRequest) Execute() (*ClusterProvisionCreateResponse, *http.Response, error) { return r.ApiService.V1InventoryClustersProvisionCreateExecute(r) } @@ -1389,13 +1592,13 @@ func (a *InventoryClustersAPIService) V1InventoryClustersProvisionCreate(ctx con // Execute executes the request // -// @return ProvisioningRequest -func (a *InventoryClustersAPIService) V1InventoryClustersProvisionCreateExecute(r ApiV1InventoryClustersProvisionCreateRequest) (*ProvisioningRequest, *http.Response, error) { +// @return ClusterProvisionCreateResponse +func (a *InventoryClustersAPIService) V1InventoryClustersProvisionCreateExecute(r ApiV1InventoryClustersProvisionCreateRequest) (*ClusterProvisionCreateResponse, *http.Response, error) { var ( localVarHTTPMethod = http.MethodPost localVarPostBody interface{} formFiles []formFile - localVarReturnValue *ProvisioningRequest + localVarReturnValue *ClusterProvisionCreateResponse ) localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "InventoryClustersAPIService.V1InventoryClustersProvisionCreate") diff --git a/v1/providers/launchpad/gen/launchpad/api_inventory_gpus.go b/v1/providers/launchpad/gen/launchpad/api_inventory_gpus.go index 8f7c94a..d686204 100644 --- a/v1/providers/launchpad/gen/launchpad/api_inventory_gpus.go +++ b/v1/providers/launchpad/gen/launchpad/api_inventory_gpus.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_inventory_instances.go b/v1/providers/launchpad/gen/launchpad/api_inventory_instances.go index 36d94e6..0f1c66c 100644 --- a/v1/providers/launchpad/gen/launchpad/api_inventory_instances.go +++ b/v1/providers/launchpad/gen/launchpad/api_inventory_instances.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_inventory_locations.go b/v1/providers/launchpad/gen/launchpad/api_inventory_locations.go index 27784e1..0e7c3e0 100644 --- a/v1/providers/launchpad/gen/launchpad/api_inventory_locations.go +++ b/v1/providers/launchpad/gen/launchpad/api_inventory_locations.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_inventory_nodes.go b/v1/providers/launchpad/gen/launchpad/api_inventory_nodes.go index d591f38..03e7785 100644 --- a/v1/providers/launchpad/gen/launchpad/api_inventory_nodes.go +++ b/v1/providers/launchpad/gen/launchpad/api_inventory_nodes.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_inventory_oems.go b/v1/providers/launchpad/gen/launchpad/api_inventory_oems.go index b173c40..8bdb761 100644 --- a/v1/providers/launchpad/gen/launchpad/api_inventory_oems.go +++ b/v1/providers/launchpad/gen/launchpad/api_inventory_oems.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_inventory_providers.go b/v1/providers/launchpad/gen/launchpad/api_inventory_providers.go index 429a283..92ca330 100644 --- a/v1/providers/launchpad/gen/launchpad/api_inventory_providers.go +++ b/v1/providers/launchpad/gen/launchpad/api_inventory_providers.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/api_version.go b/v1/providers/launchpad/gen/launchpad/api_version.go index 6388ec8..41e0978 100644 --- a/v1/providers/launchpad/gen/launchpad/api_version.go +++ b/v1/providers/launchpad/gen/launchpad/api_version.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/client.go b/v1/providers/launchpad/gen/launchpad/client.go index 9ee1ded..86197e6 100644 --- a/v1/providers/launchpad/gen/launchpad/client.go +++ b/v1/providers/launchpad/gen/launchpad/client.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -40,7 +40,7 @@ var ( queryDescape = strings.NewReplacer("%5B", "[", "%5D", "]") ) -// APIClient manages communication with the NVIDIA LaunchPad API API v2.39.5 +// APIClient manages communication with the NVIDIA LaunchPad API API v2.40.9 // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration @@ -62,6 +62,8 @@ type APIClient struct { CatalogRuntimesAPI *CatalogRuntimesAPIService + CatalogVgpuProfileChoicesAPI *CatalogVgpuProfileChoicesAPIService + HealthAPI *HealthAPIService IdentityProfileAPI *IdentityProfileAPIService @@ -106,6 +108,7 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.CatalogInstanceTypesAPI = (*CatalogInstanceTypesAPIService)(&c.common) c.CatalogPersonaChoicesAPI = (*CatalogPersonaChoicesAPIService)(&c.common) c.CatalogRuntimesAPI = (*CatalogRuntimesAPIService)(&c.common) + c.CatalogVgpuProfileChoicesAPI = (*CatalogVgpuProfileChoicesAPIService)(&c.common) c.HealthAPI = (*HealthAPIService)(&c.common) c.IdentityProfileAPI = (*IdentityProfileAPIService)(&c.common) c.InventoryClustersAPI = (*InventoryClustersAPIService)(&c.common) diff --git a/v1/providers/launchpad/gen/launchpad/configuration.go b/v1/providers/launchpad/gen/launchpad/configuration.go index 0024c58..5a336ef 100644 --- a/v1/providers/launchpad/gen/launchpad/configuration.go +++ b/v1/providers/launchpad/gen/launchpad/configuration.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/docs/CatalogDeploymentsAPI.md b/v1/providers/launchpad/gen/launchpad/docs/CatalogDeploymentsAPI.md index 2a90cfa..858b4cf 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/CatalogDeploymentsAPI.md +++ b/v1/providers/launchpad/gen/launchpad/docs/CatalogDeploymentsAPI.md @@ -19,6 +19,7 @@ Method | HTTP request | Description [**V1CatalogDeploymentsPartialUpdate**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsPartialUpdate) | **Patch** /v1/catalog/deployments/{id}/ | [**V1CatalogDeploymentsPipelinesCreate**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsPipelinesCreate) | **Post** /v1/catalog/deployments/{deployment_id}/pipelines/ | [**V1CatalogDeploymentsPipelinesList**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsPipelinesList) | **Get** /v1/catalog/deployments/{deployment_id}/pipelines/ | +[**V1CatalogDeploymentsPipelinesTriggerCreate**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsPipelinesTriggerCreate) | **Post** /v1/catalog/deployments/{id}/pipelines/trigger/ | [**V1CatalogDeploymentsRetrieve**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsRetrieve) | **Get** /v1/catalog/deployments/{id}/ | [**V1CatalogDeploymentsServicesCreate**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsServicesCreate) | **Post** /v1/catalog/deployments/{deployment_id}/services/ | [**V1CatalogDeploymentsServicesList**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsServicesList) | **Get** /v1/catalog/deployments/{deployment_id}/services/ | @@ -30,12 +31,6 @@ Method | HTTP request | Description [**V1CatalogDeploymentsTasksList**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsTasksList) | **Get** /v1/catalog/deployments/{deployment_id}/tasks/ | 🚧 [Beta Feature] [**V1CatalogDeploymentsTasksRetrieve**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsTasksRetrieve) | **Get** /v1/catalog/deployments/{deployment_id}/tasks/{id}/ | 🚧 [Beta Feature] [**V1CatalogDeploymentsUpdate**](CatalogDeploymentsAPI.md#V1CatalogDeploymentsUpdate) | **Put** /v1/catalog/deployments/{id}/ | -[**V1CatalogExperiencesNotesCreate**](CatalogDeploymentsAPI.md#V1CatalogExperiencesNotesCreate) | **Post** /v1/catalog/experiences/{experience_id}/notes/ | -[**V1CatalogExperiencesNotesDestroy**](CatalogDeploymentsAPI.md#V1CatalogExperiencesNotesDestroy) | **Delete** /v1/catalog/experiences/{experience_id}/notes/{id}/ | -[**V1CatalogExperiencesNotesList**](CatalogDeploymentsAPI.md#V1CatalogExperiencesNotesList) | **Get** /v1/catalog/experiences/{experience_id}/notes/ | -[**V1CatalogExperiencesNotesPartialUpdate**](CatalogDeploymentsAPI.md#V1CatalogExperiencesNotesPartialUpdate) | **Patch** /v1/catalog/experiences/{experience_id}/notes/{id}/ | -[**V1CatalogExperiencesNotesRetrieve**](CatalogDeploymentsAPI.md#V1CatalogExperiencesNotesRetrieve) | **Get** /v1/catalog/experiences/{experience_id}/notes/{id}/ | -[**V1CatalogExperiencesNotesUpdate**](CatalogDeploymentsAPI.md#V1CatalogExperiencesNotesUpdate) | **Put** /v1/catalog/experiences/{experience_id}/notes/{id}/ | @@ -1249,6 +1244,77 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## V1CatalogDeploymentsPipelinesTriggerCreate + +> DeploymentPipelineTrigger V1CatalogDeploymentsPipelinesTriggerCreate(ctx, id).DeploymentPipelineTrigger(deploymentPipelineTrigger).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + deploymentPipelineTrigger := *openapiclient.NewDeploymentPipelineTrigger(openapiclient.PipelineAction("apply"), time.Now(), "Id_example", time.Now(), int32(123), "Url_example") // DeploymentPipelineTrigger | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsPipelinesTriggerCreate(context.Background(), id).DeploymentPipelineTrigger(deploymentPipelineTrigger).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogDeploymentsAPI.V1CatalogDeploymentsPipelinesTriggerCreate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogDeploymentsPipelinesTriggerCreate`: DeploymentPipelineTrigger + fmt.Fprintf(os.Stdout, "Response from `CatalogDeploymentsAPI.V1CatalogDeploymentsPipelinesTriggerCreate`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogDeploymentsPipelinesTriggerCreateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **deploymentPipelineTrigger** | [**DeploymentPipelineTrigger**](DeploymentPipelineTrigger.md) | | + +### Return type + +[**DeploymentPipelineTrigger**](DeploymentPipelineTrigger.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## V1CatalogDeploymentsRetrieve > Deployment V1CatalogDeploymentsRetrieve(ctx, id).Expand(expand).Expiring(expiring).Fields(fields).Omit(omit).Execute() @@ -2047,454 +2113,3 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -## V1CatalogExperiencesNotesCreate - -> ExperienceNote V1CatalogExperiencesNotesCreate(ctx, experienceId).ExperienceNote(experienceNote).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - "time" - openapiclient "github.com/brevdev/cloud" -) - -func main() { - experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - experienceNote := *openapiclient.NewExperienceNote(time.Now(), "CreatedBy_example", openapiclient.ExperienceNote_experience{Experience: openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example")}, "Id_example", time.Now(), "ModifiedBy_example") // ExperienceNote | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesCreate(context.Background(), experienceId).ExperienceNote(experienceNote).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `CatalogDeploymentsAPI.V1CatalogExperiencesNotesCreate``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `V1CatalogExperiencesNotesCreate`: ExperienceNote - fmt.Fprintf(os.Stdout, "Response from `CatalogDeploymentsAPI.V1CatalogExperiencesNotesCreate`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**experienceId** | **string** | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesCreateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **experienceNote** | [**ExperienceNote**](ExperienceNote.md) | | - -### Return type - -[**ExperienceNote**](ExperienceNote.md) - -### Authorization - -[TokenAuthentication](../README.md#TokenAuthentication) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## V1CatalogExperiencesNotesDestroy - -> V1CatalogExperiencesNotesDestroy(ctx, experienceId, id).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/brevdev/cloud" -) - -func main() { - experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - r, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesDestroy(context.Background(), experienceId, id).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `CatalogDeploymentsAPI.V1CatalogExperiencesNotesDestroy``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**experienceId** | **string** | | -**id** | **string** | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesDestroyRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - -### Return type - - (empty response body) - -### Authorization - -[TokenAuthentication](../README.md#TokenAuthentication) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: Not defined - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## V1CatalogExperiencesNotesList - -> PaginatedExperienceNoteList V1CatalogExperiencesNotesList(ctx, experienceId).CreatedBy(createdBy).Experience(experience).Fields(fields).Id(id).ModifiedBy(modifiedBy).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/brevdev/cloud" -) - -func main() { - experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - createdBy := int32(56) // int32 | (optional) - experience := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) - fields := "fields_example" // string | Include only the specified fields in the response (optional) - id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) - modifiedBy := int32(56) // int32 | (optional) - omit := "omit_example" // string | Exclude the specified fields in the response (optional) - ordering := "ordering_example" // string | Which field to use when ordering the results. (optional) - page := int32(56) // int32 | A page number within the paginated result set. (optional) - pageSize := int32(56) // int32 | Number of results to return per page. (optional) - search := "search_example" // string | Search for experience-notes by content (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesList(context.Background(), experienceId).CreatedBy(createdBy).Experience(experience).Fields(fields).Id(id).ModifiedBy(modifiedBy).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `CatalogDeploymentsAPI.V1CatalogExperiencesNotesList``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `V1CatalogExperiencesNotesList`: PaginatedExperienceNoteList - fmt.Fprintf(os.Stdout, "Response from `CatalogDeploymentsAPI.V1CatalogExperiencesNotesList`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**experienceId** | **string** | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesListRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **createdBy** | **int32** | | - **experience** | **string** | | - **fields** | **string** | Include only the specified fields in the response | - **id** | **string** | | - **modifiedBy** | **int32** | | - **omit** | **string** | Exclude the specified fields in the response | - **ordering** | **string** | Which field to use when ordering the results. | - **page** | **int32** | A page number within the paginated result set. | - **pageSize** | **int32** | Number of results to return per page. | - **search** | **string** | Search for experience-notes by content | - -### Return type - -[**PaginatedExperienceNoteList**](PaginatedExperienceNoteList.md) - -### Authorization - -[TokenAuthentication](../README.md#TokenAuthentication) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## V1CatalogExperiencesNotesPartialUpdate - -> ExperienceNote V1CatalogExperiencesNotesPartialUpdate(ctx, experienceId, id).ExperienceNote(experienceNote).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - "time" - openapiclient "github.com/brevdev/cloud" -) - -func main() { - experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - experienceNote := *openapiclient.NewExperienceNote(time.Now(), "CreatedBy_example", openapiclient.ExperienceNote_experience{Experience: openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example")}, "Id_example", time.Now(), "ModifiedBy_example") // ExperienceNote | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesPartialUpdate(context.Background(), experienceId, id).ExperienceNote(experienceNote).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `CatalogDeploymentsAPI.V1CatalogExperiencesNotesPartialUpdate``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `V1CatalogExperiencesNotesPartialUpdate`: ExperienceNote - fmt.Fprintf(os.Stdout, "Response from `CatalogDeploymentsAPI.V1CatalogExperiencesNotesPartialUpdate`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**experienceId** | **string** | | -**id** | **string** | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesPartialUpdateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **experienceNote** | [**ExperienceNote**](ExperienceNote.md) | | - -### Return type - -[**ExperienceNote**](ExperienceNote.md) - -### Authorization - -[TokenAuthentication](../README.md#TokenAuthentication) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## V1CatalogExperiencesNotesRetrieve - -> ExperienceNote V1CatalogExperiencesNotesRetrieve(ctx, experienceId, id).Fields(fields).Omit(omit).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - openapiclient "github.com/brevdev/cloud" -) - -func main() { - experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - fields := "fields_example" // string | Include only the specified fields in the response (optional) - omit := "omit_example" // string | Exclude the specified fields in the response (optional) - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesRetrieve(context.Background(), experienceId, id).Fields(fields).Omit(omit).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `CatalogDeploymentsAPI.V1CatalogExperiencesNotesRetrieve``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `V1CatalogExperiencesNotesRetrieve`: ExperienceNote - fmt.Fprintf(os.Stdout, "Response from `CatalogDeploymentsAPI.V1CatalogExperiencesNotesRetrieve`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**experienceId** | **string** | | -**id** | **string** | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesRetrieveRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **fields** | **string** | Include only the specified fields in the response | - **omit** | **string** | Exclude the specified fields in the response | - -### Return type - -[**ExperienceNote**](ExperienceNote.md) - -### Authorization - -[TokenAuthentication](../README.md#TokenAuthentication) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## V1CatalogExperiencesNotesUpdate - -> ExperienceNote V1CatalogExperiencesNotesUpdate(ctx, experienceId, id).ExperienceNote(experienceNote).Execute() - - - -### Example - -```go -package main - -import ( - "context" - "fmt" - "os" - "time" - openapiclient "github.com/brevdev/cloud" -) - -func main() { - experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | - experienceNote := *openapiclient.NewExperienceNote(time.Now(), "CreatedBy_example", openapiclient.ExperienceNote_experience{Experience: openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example")}, "Id_example", time.Now(), "ModifiedBy_example") // ExperienceNote | - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesUpdate(context.Background(), experienceId, id).ExperienceNote(experienceNote).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `CatalogDeploymentsAPI.V1CatalogExperiencesNotesUpdate``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `V1CatalogExperiencesNotesUpdate`: ExperienceNote - fmt.Fprintf(os.Stdout, "Response from `CatalogDeploymentsAPI.V1CatalogExperiencesNotesUpdate`: %v\n", resp) -} -``` - -### Path Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**experienceId** | **string** | | -**id** | **string** | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesUpdateRequest struct via the builder pattern - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **experienceNote** | [**ExperienceNote**](ExperienceNote.md) | | - -### Return type - -[**ExperienceNote**](ExperienceNote.md) - -### Authorization - -[TokenAuthentication](../README.md#TokenAuthentication) - -### HTTP request headers - -- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/v1/providers/launchpad/gen/launchpad/docs/CatalogExperiencesAPI.md b/v1/providers/launchpad/gen/launchpad/docs/CatalogExperiencesAPI.md index d0500a6..698e980 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/CatalogExperiencesAPI.md +++ b/v1/providers/launchpad/gen/launchpad/docs/CatalogExperiencesAPI.md @@ -10,6 +10,12 @@ Method | HTTP request | Description [**V1CatalogExperiencesDestroy**](CatalogExperiencesAPI.md#V1CatalogExperiencesDestroy) | **Delete** /v1/catalog/experiences/{id}/ | [**V1CatalogExperiencesHistoryList**](CatalogExperiencesAPI.md#V1CatalogExperiencesHistoryList) | **Get** /v1/catalog/experiences/{id}/history/ | [**V1CatalogExperiencesList**](CatalogExperiencesAPI.md#V1CatalogExperiencesList) | **Get** /v1/catalog/experiences/ | +[**V1CatalogExperiencesNotesCreate**](CatalogExperiencesAPI.md#V1CatalogExperiencesNotesCreate) | **Post** /v1/catalog/experiences/{experience_id}/notes/ | +[**V1CatalogExperiencesNotesDestroy**](CatalogExperiencesAPI.md#V1CatalogExperiencesNotesDestroy) | **Delete** /v1/catalog/experiences/{experience_id}/notes/{id}/ | +[**V1CatalogExperiencesNotesList**](CatalogExperiencesAPI.md#V1CatalogExperiencesNotesList) | **Get** /v1/catalog/experiences/{experience_id}/notes/ | +[**V1CatalogExperiencesNotesPartialUpdate**](CatalogExperiencesAPI.md#V1CatalogExperiencesNotesPartialUpdate) | **Patch** /v1/catalog/experiences/{experience_id}/notes/{id}/ | +[**V1CatalogExperiencesNotesRetrieve**](CatalogExperiencesAPI.md#V1CatalogExperiencesNotesRetrieve) | **Get** /v1/catalog/experiences/{experience_id}/notes/{id}/ | +[**V1CatalogExperiencesNotesUpdate**](CatalogExperiencesAPI.md#V1CatalogExperiencesNotesUpdate) | **Put** /v1/catalog/experiences/{experience_id}/notes/{id}/ | [**V1CatalogExperiencesPartialUpdate**](CatalogExperiencesAPI.md#V1CatalogExperiencesPartialUpdate) | **Patch** /v1/catalog/experiences/{id}/ | [**V1CatalogExperiencesRetrieve**](CatalogExperiencesAPI.md#V1CatalogExperiencesRetrieve) | **Get** /v1/catalog/experiences/{id}/ | [**V1CatalogExperiencesStatsRetrieve**](CatalogExperiencesAPI.md#V1CatalogExperiencesStatsRetrieve) | **Get** /v1/catalog/experiences/stats/ | 🚧 [Beta Feature] @@ -103,7 +109,7 @@ import ( ) func main() { - experienceBulkUpdate := *openapiclient.NewExperienceBulkUpdate("CatalogId_example", "CatalogIdAlias_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example", int32(123), []string{"Ids_example"}, "Result_example") // ExperienceBulkUpdate | + experienceBulkUpdate := *openapiclient.NewExperienceBulkUpdate("CatalogId_example", "CatalogIdAlias_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", false, *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example", int32(123), []string{"Ids_example"}, "Result_example") // ExperienceBulkUpdate | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -168,7 +174,7 @@ import ( ) func main() { - experience := *openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example") // Experience | + experience := *openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", false, *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example") // Experience | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -353,7 +359,7 @@ Name | Type | Description | Notes ## V1CatalogExperiencesList -> PaginatedExperienceList V1CatalogExperiencesList(ctx).Assignee(assignee).Autoapprove(autoapprove).Autoprovision(autoprovision).Bootstrap(bootstrap).CatalogId(catalogId).CatalogIdAlias(catalogIdAlias).Category(category).CollectionBranch(collectionBranch).Expand(expand).Experience(experience).ExperienceBranch(experienceBranch).Fields(fields).GarageId(garageId).GcBranch(gcBranch).GpuCount(gpuCount).GpuOsName(gpuOsName).GpuOsRelease(gpuOsRelease).GpuOsVersion(gpuOsVersion).Id(id).NodeCount(nodeCount).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persona(persona).Pipeline(pipeline).Platform(platform).Provider(provider).Published(published).RequiresGpu(requiresGpu).SaLab(saLab).Search(search).SystemArch(systemArch).VgpuProfile(vgpuProfile).Execute() +> PaginatedExperienceList V1CatalogExperiencesList(ctx).Assignee(assignee).Autoapprove(autoapprove).Autoprovision(autoprovision).Bootstrap(bootstrap).CatalogId(catalogId).CatalogIdAlias(catalogIdAlias).Category(category).CollectionBranch(collectionBranch).Expand(expand).Experience(experience).ExperienceBranch(experienceBranch).Featured(featured).Fields(fields).GarageId(garageId).GcBranch(gcBranch).GpuCount(gpuCount).GpuOsName(gpuOsName).GpuOsRelease(gpuOsRelease).GpuOsVersion(gpuOsVersion).Id(id).NodeCount(nodeCount).Oem(oem).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persona(persona).Pipeline(pipeline).Platform(platform).Provider(provider).Published(published).RequiresGpu(requiresGpu).Runtime(runtime).SaLab(saLab).Search(search).SystemArch(systemArch).VgpuProfile(vgpuProfile).Execute() @@ -381,6 +387,7 @@ func main() { expand := "expand_example" // string | Expand related field(s) instead of only showing a UUID (ex: \"required_gpus\"). (optional) experience := "experience_example" // string | (optional) experienceBranch := "experienceBranch_example" // string | (optional) + featured := true // bool | (optional) fields := "fields_example" // string | Include only the specified fields in the response (optional) garageId := "garageId_example" // string | (optional) gcBranch := "gcBranch_example" // string | (optional) @@ -390,24 +397,26 @@ func main() { gpuOsVersion := "gpuOsVersion_example" // string | (optional) id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) nodeCount := int32(56) // int32 | (optional) + oem := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) omit := "omit_example" // string | Exclude the specified fields in the response (optional) ordering := "ordering_example" // string | Which field to use when ordering the results. (optional) page := int32(56) // int32 | A page number within the paginated result set. (optional) pageSize := int32(56) // int32 | Number of results to return per page. (optional) persona := "persona_example" // string | (optional) pipeline := int32(56) // int32 | (optional) - platform := "platform_example" // string | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 (optional) + platform := "platform_example" // string | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 (optional) provider := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) published := []string{"Published_example"} // []string | Multiple values may be separated by commas. * `draft` - draft * `no` - no * `yes` - yes (optional) requiresGpu := "requiresGpu_example" // string | Only include experiences that require a given GPU ID or model (optional) + runtime := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) saLab := true // bool | (optional) - search := "search_example" // string | Search for experiences by assignee, catalog_id, catalog_id_alias, category, collection_branch, description, experience, experience_branch, gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, persona, pipeline, platform, provider name, required_gpus model, system_arch, title, vgpu_profile (optional) + search := "search_example" // string | Search for experiences by assignee, catalog_id, catalog_id_alias, category, collection_branch, description, experience, experience_branch, gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, oem name, persona, pipeline, platform, provider name, required_gpus model, runtime name, system_arch, title, vgpu_profile (optional) systemArch := "systemArch_example" // string | Required CPU architecture * `amd64` - amd64 * `arm64` - arm64 (optional) - vgpuProfile := "vgpuProfile_example" // string | vGPU profile name used by the experience * `air` - NVIDIA Air * `bright_cluster` - Bright Cluster * `bright-cluster` - Bright Cluster (legacy option) * `flight_deck` - Flight Deck * `flight-deck` - Flight Deck (legacy option) * `nvidia_a40-48q` - nvidia_a40-48q * `nvidia-ai-enterprise` - NVIDIA AI Enterprise * `nvidia_l40s-48q` - nvidia_l40s-48q * `nvidia_rtx_pro_6000_blackwell_dc-4-96q` - nvidia_rtx_pro_6000_blackwell_dc-4-96q * `nvidia_rtx_pro_6000_blackwell_dc-96q` - nvidia_rtx_pro_6000_blackwell_dc-96q * `openshift` - OpenShift * `platform_only` - platform_only * `vmware_itadmin` - VMware IT admin (optional) + vgpuProfile := "vgpuProfile_example" // string | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesList(context.Background()).Assignee(assignee).Autoapprove(autoapprove).Autoprovision(autoprovision).Bootstrap(bootstrap).CatalogId(catalogId).CatalogIdAlias(catalogIdAlias).Category(category).CollectionBranch(collectionBranch).Expand(expand).Experience(experience).ExperienceBranch(experienceBranch).Fields(fields).GarageId(garageId).GcBranch(gcBranch).GpuCount(gpuCount).GpuOsName(gpuOsName).GpuOsRelease(gpuOsRelease).GpuOsVersion(gpuOsVersion).Id(id).NodeCount(nodeCount).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persona(persona).Pipeline(pipeline).Platform(platform).Provider(provider).Published(published).RequiresGpu(requiresGpu).SaLab(saLab).Search(search).SystemArch(systemArch).VgpuProfile(vgpuProfile).Execute() + resp, r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesList(context.Background()).Assignee(assignee).Autoapprove(autoapprove).Autoprovision(autoprovision).Bootstrap(bootstrap).CatalogId(catalogId).CatalogIdAlias(catalogIdAlias).Category(category).CollectionBranch(collectionBranch).Expand(expand).Experience(experience).ExperienceBranch(experienceBranch).Featured(featured).Fields(fields).GarageId(garageId).GcBranch(gcBranch).GpuCount(gpuCount).GpuOsName(gpuOsName).GpuOsRelease(gpuOsRelease).GpuOsVersion(gpuOsVersion).Id(id).NodeCount(nodeCount).Oem(oem).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persona(persona).Pipeline(pipeline).Platform(platform).Provider(provider).Published(published).RequiresGpu(requiresGpu).Runtime(runtime).SaLab(saLab).Search(search).SystemArch(systemArch).VgpuProfile(vgpuProfile).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CatalogExperiencesAPI.V1CatalogExperiencesList``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -439,6 +448,7 @@ Name | Type | Description | Notes **expand** | **string** | Expand related field(s) instead of only showing a UUID (ex: \"required_gpus\"). | **experience** | **string** | | **experienceBranch** | **string** | | + **featured** | **bool** | | **fields** | **string** | Include only the specified fields in the response | **garageId** | **string** | | **gcBranch** | **string** | | @@ -448,20 +458,22 @@ Name | Type | Description | Notes **gpuOsVersion** | **string** | | **id** | **string** | | **nodeCount** | **int32** | | + **oem** | **string** | | **omit** | **string** | Exclude the specified fields in the response | **ordering** | **string** | Which field to use when ordering the results. | **page** | **int32** | A page number within the paginated result set. | **pageSize** | **int32** | Number of results to return per page. | **persona** | **string** | | **pipeline** | **int32** | | - **platform** | **string** | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | + **platform** | **string** | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | **provider** | **string** | | **published** | **[]string** | Multiple values may be separated by commas. * `draft` - draft * `no` - no * `yes` - yes | **requiresGpu** | **string** | Only include experiences that require a given GPU ID or model | + **runtime** | **string** | | **saLab** | **bool** | | - **search** | **string** | Search for experiences by assignee, catalog_id, catalog_id_alias, category, collection_branch, description, experience, experience_branch, gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, persona, pipeline, platform, provider name, required_gpus model, system_arch, title, vgpu_profile | + **search** | **string** | Search for experiences by assignee, catalog_id, catalog_id_alias, category, collection_branch, description, experience, experience_branch, gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, oem name, persona, pipeline, platform, provider name, required_gpus model, runtime name, system_arch, title, vgpu_profile | **systemArch** | **string** | Required CPU architecture * `amd64` - amd64 * `arm64` - arm64 | - **vgpuProfile** | **string** | vGPU profile name used by the experience * `air` - NVIDIA Air * `bright_cluster` - Bright Cluster * `bright-cluster` - Bright Cluster (legacy option) * `flight_deck` - Flight Deck * `flight-deck` - Flight Deck (legacy option) * `nvidia_a40-48q` - nvidia_a40-48q * `nvidia-ai-enterprise` - NVIDIA AI Enterprise * `nvidia_l40s-48q` - nvidia_l40s-48q * `nvidia_rtx_pro_6000_blackwell_dc-4-96q` - nvidia_rtx_pro_6000_blackwell_dc-4-96q * `nvidia_rtx_pro_6000_blackwell_dc-96q` - nvidia_rtx_pro_6000_blackwell_dc-96q * `openshift` - OpenShift * `platform_only` - platform_only * `vmware_itadmin` - VMware IT admin | + **vgpuProfile** | **string** | | ### Return type @@ -481,6 +493,457 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## V1CatalogExperiencesNotesCreate + +> ExperienceNote V1CatalogExperiencesNotesCreate(ctx, experienceId).ExperienceNote(experienceNote).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + experienceNote := *openapiclient.NewExperienceNote(time.Now(), "CreatedBy_example", openapiclient.ExperienceNote_experience{Experience: openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", false, *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example")}, "Id_example", time.Now(), "ModifiedBy_example") // ExperienceNote | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesCreate(context.Background(), experienceId).ExperienceNote(experienceNote).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogExperiencesAPI.V1CatalogExperiencesNotesCreate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogExperiencesNotesCreate`: ExperienceNote + fmt.Fprintf(os.Stdout, "Response from `CatalogExperiencesAPI.V1CatalogExperiencesNotesCreate`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**experienceId** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesCreateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **experienceNote** | [**ExperienceNote**](ExperienceNote.md) | | + +### Return type + +[**ExperienceNote**](ExperienceNote.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## V1CatalogExperiencesNotesDestroy + +> V1CatalogExperiencesNotesDestroy(ctx, experienceId, id).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesDestroy(context.Background(), experienceId, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogExperiencesAPI.V1CatalogExperiencesNotesDestroy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**experienceId** | **string** | | +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesDestroyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## V1CatalogExperiencesNotesList + +> PaginatedExperienceNoteList V1CatalogExperiencesNotesList(ctx, experienceId).CreatedBy(createdBy).Experience(experience).Fields(fields).Id(id).ModifiedBy(modifiedBy).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + createdBy := int32(56) // int32 | (optional) + experience := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) + fields := "fields_example" // string | Include only the specified fields in the response (optional) + id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) + modifiedBy := int32(56) // int32 | (optional) + omit := "omit_example" // string | Exclude the specified fields in the response (optional) + ordering := "ordering_example" // string | Which field to use when ordering the results. (optional) + page := int32(56) // int32 | A page number within the paginated result set. (optional) + pageSize := int32(56) // int32 | Number of results to return per page. (optional) + search := "search_example" // string | Search for experience-notes by content (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesList(context.Background(), experienceId).CreatedBy(createdBy).Experience(experience).Fields(fields).Id(id).ModifiedBy(modifiedBy).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogExperiencesAPI.V1CatalogExperiencesNotesList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogExperiencesNotesList`: PaginatedExperienceNoteList + fmt.Fprintf(os.Stdout, "Response from `CatalogExperiencesAPI.V1CatalogExperiencesNotesList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**experienceId** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createdBy** | **int32** | | + **experience** | **string** | | + **fields** | **string** | Include only the specified fields in the response | + **id** | **string** | | + **modifiedBy** | **int32** | | + **omit** | **string** | Exclude the specified fields in the response | + **ordering** | **string** | Which field to use when ordering the results. | + **page** | **int32** | A page number within the paginated result set. | + **pageSize** | **int32** | Number of results to return per page. | + **search** | **string** | Search for experience-notes by content | + +### Return type + +[**PaginatedExperienceNoteList**](PaginatedExperienceNoteList.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## V1CatalogExperiencesNotesPartialUpdate + +> ExperienceNote V1CatalogExperiencesNotesPartialUpdate(ctx, experienceId, id).ExperienceNote(experienceNote).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + experienceNote := *openapiclient.NewExperienceNote(time.Now(), "CreatedBy_example", openapiclient.ExperienceNote_experience{Experience: openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", false, *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example")}, "Id_example", time.Now(), "ModifiedBy_example") // ExperienceNote | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesPartialUpdate(context.Background(), experienceId, id).ExperienceNote(experienceNote).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogExperiencesAPI.V1CatalogExperiencesNotesPartialUpdate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogExperiencesNotesPartialUpdate`: ExperienceNote + fmt.Fprintf(os.Stdout, "Response from `CatalogExperiencesAPI.V1CatalogExperiencesNotesPartialUpdate`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**experienceId** | **string** | | +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesPartialUpdateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **experienceNote** | [**ExperienceNote**](ExperienceNote.md) | | + +### Return type + +[**ExperienceNote**](ExperienceNote.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## V1CatalogExperiencesNotesRetrieve + +> ExperienceNote V1CatalogExperiencesNotesRetrieve(ctx, experienceId, id).Fields(fields).Omit(omit).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + fields := "fields_example" // string | Include only the specified fields in the response (optional) + omit := "omit_example" // string | Exclude the specified fields in the response (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesRetrieve(context.Background(), experienceId, id).Fields(fields).Omit(omit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogExperiencesAPI.V1CatalogExperiencesNotesRetrieve``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogExperiencesNotesRetrieve`: ExperienceNote + fmt.Fprintf(os.Stdout, "Response from `CatalogExperiencesAPI.V1CatalogExperiencesNotesRetrieve`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**experienceId** | **string** | | +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesRetrieveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **fields** | **string** | Include only the specified fields in the response | + **omit** | **string** | Exclude the specified fields in the response | + +### Return type + +[**ExperienceNote**](ExperienceNote.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## V1CatalogExperiencesNotesUpdate + +> ExperienceNote V1CatalogExperiencesNotesUpdate(ctx, experienceId, id).ExperienceNote(experienceNote).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + experienceId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + experienceNote := *openapiclient.NewExperienceNote(time.Now(), "CreatedBy_example", openapiclient.ExperienceNote_experience{Experience: openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", false, *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example")}, "Id_example", time.Now(), "ModifiedBy_example") // ExperienceNote | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesUpdate(context.Background(), experienceId, id).ExperienceNote(experienceNote).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogExperiencesAPI.V1CatalogExperiencesNotesUpdate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogExperiencesNotesUpdate`: ExperienceNote + fmt.Fprintf(os.Stdout, "Response from `CatalogExperiencesAPI.V1CatalogExperiencesNotesUpdate`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**experienceId** | **string** | | +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogExperiencesNotesUpdateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **experienceNote** | [**ExperienceNote**](ExperienceNote.md) | | + +### Return type + +[**ExperienceNote**](ExperienceNote.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## V1CatalogExperiencesPartialUpdate > Experience V1CatalogExperiencesPartialUpdate(ctx, id).Experience(experience).Execute() @@ -502,7 +965,7 @@ import ( func main() { id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this experience. - experience := *openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example") // Experience | + experience := *openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", false, *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example") // Experience | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -704,7 +1167,7 @@ import ( func main() { id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this experience. - experience := *openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example") // Experience | + experience := *openapiclient.NewExperience("CatalogId_example", openapiclient.CategoryEnum("AI"), time.Now(), "Experience_example", false, *openapiclient.NewGpuOs("Name_example", "Release_example", "Version_example"), "Id_example", time.Now(), "Persona_example", int64(123), openapiclient.PlatformEnum("air"), openapiclient.SystemArchEnum("amd64"), "Title_example") // Experience | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) diff --git a/v1/providers/launchpad/gen/launchpad/docs/CatalogVgpuProfileChoicesAPI.md b/v1/providers/launchpad/gen/launchpad/docs/CatalogVgpuProfileChoicesAPI.md new file mode 100644 index 0000000..58e8ec1 --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/docs/CatalogVgpuProfileChoicesAPI.md @@ -0,0 +1,149 @@ +# \CatalogVgpuProfileChoicesAPI + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**V1CatalogVgpuProfileChoicesCreate**](CatalogVgpuProfileChoicesAPI.md#V1CatalogVgpuProfileChoicesCreate) | **Post** /v1/catalog/vgpu-profile-choices/ | +[**V1CatalogVgpuProfileChoicesList**](CatalogVgpuProfileChoicesAPI.md#V1CatalogVgpuProfileChoicesList) | **Get** /v1/catalog/vgpu-profile-choices/ | + + + +## V1CatalogVgpuProfileChoicesCreate + +> VGpuProfileChoice V1CatalogVgpuProfileChoicesCreate(ctx).VGpuProfileChoice(vGpuProfileChoice).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + vGpuProfileChoice := *openapiclient.NewVGpuProfileChoice(time.Now(), int32(123), time.Now(), "Name_example") // VGpuProfileChoice | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesCreate(context.Background()).VGpuProfileChoice(vGpuProfileChoice).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesCreate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogVgpuProfileChoicesCreate`: VGpuProfileChoice + fmt.Fprintf(os.Stdout, "Response from `CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesCreate`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogVgpuProfileChoicesCreateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vGpuProfileChoice** | [**VGpuProfileChoice**](VGpuProfileChoice.md) | | + +### Return type + +[**VGpuProfileChoice**](VGpuProfileChoice.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## V1CatalogVgpuProfileChoicesList + +> PaginatedVGpuProfileChoiceList V1CatalogVgpuProfileChoicesList(ctx).Fields(fields).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + fields := "fields_example" // string | Include only the specified fields in the response (optional) + omit := "omit_example" // string | Exclude the specified fields in the response (optional) + ordering := "ordering_example" // string | Which field to use when ordering the results. (optional) + page := int32(56) // int32 | A page number within the paginated result set. (optional) + pageSize := int32(56) // int32 | Number of results to return per page. (optional) + search := "search_example" // string | Search for vgpuprofilechoices by id, name (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesList(context.Background()).Fields(fields).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1CatalogVgpuProfileChoicesList`: PaginatedVGpuProfileChoiceList + fmt.Fprintf(os.Stdout, "Response from `CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1CatalogVgpuProfileChoicesListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **fields** | **string** | Include only the specified fields in the response | + **omit** | **string** | Exclude the specified fields in the response | + **ordering** | **string** | Which field to use when ordering the results. | + **page** | **int32** | A page number within the paginated result set. | + **pageSize** | **int32** | Number of results to return per page. | + **search** | **string** | Search for vgpuprofilechoices by id, name | + +### Return type + +[**PaginatedVGpuProfileChoiceList**](PaginatedVGpuProfileChoiceList.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/v1/providers/launchpad/gen/launchpad/docs/Cluster.md b/v1/providers/launchpad/gen/launchpad/docs/Cluster.md index 471a9cc..5434ade 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/Cluster.md +++ b/v1/providers/launchpad/gen/launchpad/docs/Cluster.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **GpuCount** | Pointer to **int32** | | [optional] [readonly] **Id** | **string** | | [readonly] **Instances** | [**[]ClusterInstancesInner**](ClusterInstancesInner.md) | | +**LastProvisioningStateChange** | **NullableTime** | Timestamp of the last time the cluster's provisioning_state changed | [readonly] **LastUsed** | **NullableTime** | Timestamp of when the cluster was last in use | [readonly] **Maintenance** | Pointer to **bool** | Is the cluster in maintenance mode? | [optional] **MgmtIp** | Pointer to **string** | Management IP address | [optional] @@ -44,7 +45,7 @@ Name | Type | Description | Notes ### NewCluster -`func NewCluster(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, id string, instances []ClusterInstancesInner, lastUsed NullableTime, modified time.Time, providerCapacity bool, tenantIds []string, ) *Cluster` +`func NewCluster(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, id string, instances []ClusterInstancesInner, lastProvisioningStateChange NullableTime, lastUsed NullableTime, modified time.Time, providerCapacity bool, tenantIds []string, ) *Cluster` NewCluster instantiates a new Cluster object This constructor will assign default values to properties that have it defined, @@ -359,6 +360,36 @@ and a boolean to check if the value has been set. SetInstances sets Instances field to given value. +### GetLastProvisioningStateChange + +`func (o *Cluster) GetLastProvisioningStateChange() time.Time` + +GetLastProvisioningStateChange returns the LastProvisioningStateChange field if non-nil, zero value otherwise. + +### GetLastProvisioningStateChangeOk + +`func (o *Cluster) GetLastProvisioningStateChangeOk() (*time.Time, bool)` + +GetLastProvisioningStateChangeOk returns a tuple with the LastProvisioningStateChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastProvisioningStateChange + +`func (o *Cluster) SetLastProvisioningStateChange(v time.Time)` + +SetLastProvisioningStateChange sets LastProvisioningStateChange field to given value. + + +### SetLastProvisioningStateChangeNil + +`func (o *Cluster) SetLastProvisioningStateChangeNil(b bool)` + + SetLastProvisioningStateChangeNil sets the value for LastProvisioningStateChange to be an explicit nil + +### UnsetLastProvisioningStateChange +`func (o *Cluster) UnsetLastProvisioningStateChange()` + +UnsetLastProvisioningStateChange ensures that no value is present for LastProvisioningStateChange, not even an explicit nil ### GetLastUsed `func (o *Cluster) GetLastUsed() time.Time` diff --git a/v1/providers/launchpad/gen/launchpad/docs/ClusterBulkUpdate.md b/v1/providers/launchpad/gen/launchpad/docs/ClusterBulkUpdate.md index 44f0c1d..7bac322 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/ClusterBulkUpdate.md +++ b/v1/providers/launchpad/gen/launchpad/docs/ClusterBulkUpdate.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **GpuCount** | **int32** | | [readonly] **Id** | **string** | | [readonly] **Instances** | [**[]ClusterInstancesInner**](ClusterInstancesInner.md) | | +**LastProvisioningStateChange** | **NullableTime** | Timestamp of the last time the cluster's provisioning_state changed | [readonly] **LastUsed** | **NullableTime** | Timestamp of when the cluster was last in use | [readonly] **Maintenance** | Pointer to **bool** | Is the cluster in maintenance mode? | [optional] **MgmtIp** | Pointer to **string** | Management IP address | [optional] @@ -47,7 +48,7 @@ Name | Type | Description | Notes ### NewClusterBulkUpdate -`func NewClusterBulkUpdate(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, gpuAlias string, gpuCount int32, id string, instances []ClusterInstancesInner, lastUsed NullableTime, modified time.Time, nodeCount int32, providerCapacity bool, publicAddress NullableString, requestId NullableString, tenantIds []string, count int32, ids []string, result string, ) *ClusterBulkUpdate` +`func NewClusterBulkUpdate(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, gpuAlias string, gpuCount int32, id string, instances []ClusterInstancesInner, lastProvisioningStateChange NullableTime, lastUsed NullableTime, modified time.Time, nodeCount int32, providerCapacity bool, publicAddress NullableString, requestId NullableString, tenantIds []string, count int32, ids []string, result string, ) *ClusterBulkUpdate` NewClusterBulkUpdate instantiates a new ClusterBulkUpdate object This constructor will assign default values to properties that have it defined, @@ -352,6 +353,36 @@ and a boolean to check if the value has been set. SetInstances sets Instances field to given value. +### GetLastProvisioningStateChange + +`func (o *ClusterBulkUpdate) GetLastProvisioningStateChange() time.Time` + +GetLastProvisioningStateChange returns the LastProvisioningStateChange field if non-nil, zero value otherwise. + +### GetLastProvisioningStateChangeOk + +`func (o *ClusterBulkUpdate) GetLastProvisioningStateChangeOk() (*time.Time, bool)` + +GetLastProvisioningStateChangeOk returns a tuple with the LastProvisioningStateChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastProvisioningStateChange + +`func (o *ClusterBulkUpdate) SetLastProvisioningStateChange(v time.Time)` + +SetLastProvisioningStateChange sets LastProvisioningStateChange field to given value. + + +### SetLastProvisioningStateChangeNil + +`func (o *ClusterBulkUpdate) SetLastProvisioningStateChangeNil(b bool)` + + SetLastProvisioningStateChangeNil sets the value for LastProvisioningStateChange to be an explicit nil + +### UnsetLastProvisioningStateChange +`func (o *ClusterBulkUpdate) UnsetLastProvisioningStateChange()` + +UnsetLastProvisioningStateChange ensures that no value is present for LastProvisioningStateChange, not even an explicit nil ### GetLastUsed `func (o *ClusterBulkUpdate) GetLastUsed() time.Time` diff --git a/v1/providers/launchpad/gen/launchpad/docs/ClusterDeployment.md b/v1/providers/launchpad/gen/launchpad/docs/ClusterDeployment.md index 32da7b0..7b46196 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/ClusterDeployment.md +++ b/v1/providers/launchpad/gen/launchpad/docs/ClusterDeployment.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **BastionOperatingSystem** | Pointer to **string** | Override bastion operating system provisioned and/or configured by Liftoff | [optional] **CatalogId** | Pointer to **string** | Catalog ID of the experience provisioned to the cluster | [optional] **CatalogIdAlias** | Pointer to **string** | Catalog ID alias of the experience provisioned to the cluster | [optional] -**Cluster** | Pointer to [**DeploymentCluster**](DeploymentCluster.md) | | [optional] +**Cluster** | Pointer to [**ClusterPipelineCluster**](ClusterPipelineCluster.md) | | [optional] **CollectionBranch** | Pointer to **string** | Override the Ansible collection branch initialized within the pipeline | [optional] **Created** | **time.Time** | Timestamp of when the object was created | [readonly] **Experience** | Pointer to **string** | The experience being deployed for use | [optional] [readonly] @@ -166,20 +166,20 @@ HasCatalogIdAlias returns a boolean if a field has been set. ### GetCluster -`func (o *ClusterDeployment) GetCluster() DeploymentCluster` +`func (o *ClusterDeployment) GetCluster() ClusterPipelineCluster` GetCluster returns the Cluster field if non-nil, zero value otherwise. ### GetClusterOk -`func (o *ClusterDeployment) GetClusterOk() (*DeploymentCluster, bool)` +`func (o *ClusterDeployment) GetClusterOk() (*ClusterPipelineCluster, bool)` GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetCluster -`func (o *ClusterDeployment) SetCluster(v DeploymentCluster)` +`func (o *ClusterDeployment) SetCluster(v ClusterPipelineCluster)` SetCluster sets Cluster field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/ClusterInstancesInner.md b/v1/providers/launchpad/gen/launchpad/docs/ClusterInstancesInner.md index 37e99aa..ae0f5c5 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/ClusterInstancesInner.md +++ b/v1/providers/launchpad/gen/launchpad/docs/ClusterInstancesInner.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Cluster** | [**DeploymentCluster**](DeploymentCluster.md) | | +**Cluster** | [**ClusterPipelineCluster**](ClusterPipelineCluster.md) | | **Created** | **time.Time** | Timestamp of when the object was created | [readonly] **Id** | **string** | | [readonly] **InstanceId** | **string** | Unique ID for this instance assigned by its provider | @@ -18,7 +18,7 @@ Name | Type | Description | Notes ### NewClusterInstancesInner -`func NewClusterInstancesInner(cluster DeploymentCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, ) *ClusterInstancesInner` +`func NewClusterInstancesInner(cluster ClusterPipelineCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, ) *ClusterInstancesInner` NewClusterInstancesInner instantiates a new ClusterInstancesInner object This constructor will assign default values to properties that have it defined, @@ -35,20 +35,20 @@ but it doesn't guarantee that properties required by API are set ### GetCluster -`func (o *ClusterInstancesInner) GetCluster() DeploymentCluster` +`func (o *ClusterInstancesInner) GetCluster() ClusterPipelineCluster` GetCluster returns the Cluster field if non-nil, zero value otherwise. ### GetClusterOk -`func (o *ClusterInstancesInner) GetClusterOk() (*DeploymentCluster, bool)` +`func (o *ClusterInstancesInner) GetClusterOk() (*ClusterPipelineCluster, bool)` GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetCluster -`func (o *ClusterInstancesInner) SetCluster(v DeploymentCluster)` +`func (o *ClusterInstancesInner) SetCluster(v ClusterPipelineCluster)` SetCluster sets Cluster field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/ClusterPipeline.md b/v1/providers/launchpad/gen/launchpad/docs/ClusterPipeline.md new file mode 100644 index 0000000..30ccbea --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/docs/ClusterPipeline.md @@ -0,0 +1,198 @@ +# ClusterPipeline + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Action** | [**PipelineAction**](PipelineAction.md) | Action for the pipeline to run * `apply` - apply * `destroy` - destroy * `notify` - notify | [readonly] +**Cluster** | [**ClusterPipelineCluster**](ClusterPipelineCluster.md) | | +**Created** | **time.Time** | Timestamp of when the object was created | [readonly] +**Id** | **string** | | [readonly] +**Modified** | **time.Time** | Timestamp of when the object was last modified | [readonly] +**PipelineId** | **int32** | GitLab pipeline ID | [readonly] +**RequestId** | **string** | Request ID that the pipeline was triggered for | [readonly] +**Url** | **string** | URL for the pipeline details | [readonly] + +## Methods + +### NewClusterPipeline + +`func NewClusterPipeline(action PipelineAction, cluster ClusterPipelineCluster, created time.Time, id string, modified time.Time, pipelineId int32, requestId string, url string, ) *ClusterPipeline` + +NewClusterPipeline instantiates a new ClusterPipeline object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterPipelineWithDefaults + +`func NewClusterPipelineWithDefaults() *ClusterPipeline` + +NewClusterPipelineWithDefaults instantiates a new ClusterPipeline object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAction + +`func (o *ClusterPipeline) GetAction() PipelineAction` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *ClusterPipeline) GetActionOk() (*PipelineAction, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *ClusterPipeline) SetAction(v PipelineAction)` + +SetAction sets Action field to given value. + + +### GetCluster + +`func (o *ClusterPipeline) GetCluster() ClusterPipelineCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *ClusterPipeline) GetClusterOk() (*ClusterPipelineCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *ClusterPipeline) SetCluster(v ClusterPipelineCluster)` + +SetCluster sets Cluster field to given value. + + +### GetCreated + +`func (o *ClusterPipeline) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ClusterPipeline) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ClusterPipeline) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetId + +`func (o *ClusterPipeline) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ClusterPipeline) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ClusterPipeline) SetId(v string)` + +SetId sets Id field to given value. + + +### GetModified + +`func (o *ClusterPipeline) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ClusterPipeline) GetModifiedOk() (*time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ClusterPipeline) SetModified(v time.Time)` + +SetModified sets Modified field to given value. + + +### GetPipelineId + +`func (o *ClusterPipeline) GetPipelineId() int32` + +GetPipelineId returns the PipelineId field if non-nil, zero value otherwise. + +### GetPipelineIdOk + +`func (o *ClusterPipeline) GetPipelineIdOk() (*int32, bool)` + +GetPipelineIdOk returns a tuple with the PipelineId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPipelineId + +`func (o *ClusterPipeline) SetPipelineId(v int32)` + +SetPipelineId sets PipelineId field to given value. + + +### GetRequestId + +`func (o *ClusterPipeline) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *ClusterPipeline) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *ClusterPipeline) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + + +### GetUrl + +`func (o *ClusterPipeline) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *ClusterPipeline) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *ClusterPipeline) SetUrl(v string)` + +SetUrl sets Url field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/providers/launchpad/gen/launchpad/docs/DeploymentCluster.md b/v1/providers/launchpad/gen/launchpad/docs/ClusterPipelineCluster.md similarity index 65% rename from v1/providers/launchpad/gen/launchpad/docs/DeploymentCluster.md rename to v1/providers/launchpad/gen/launchpad/docs/ClusterPipelineCluster.md index 1b39db0..9325d5c 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/DeploymentCluster.md +++ b/v1/providers/launchpad/gen/launchpad/docs/ClusterPipelineCluster.md @@ -1,4 +1,4 @@ -# DeploymentCluster +# ClusterPipelineCluster ## Properties @@ -16,6 +16,7 @@ Name | Type | Description | Notes **GpuCount** | Pointer to **int32** | | [optional] [readonly] **Id** | **string** | | [readonly] **Instances** | [**[]ClusterInstancesInner**](ClusterInstancesInner.md) | | +**LastProvisioningStateChange** | **time.Time** | Timestamp of the last time the cluster's provisioning_state changed | [readonly] **LastUsed** | **time.Time** | Timestamp of when the cluster was last in use | [readonly] **Maintenance** | Pointer to **bool** | Is the cluster in maintenance mode? | [optional] **MgmtIp** | Pointer to **string** | Management IP address | [optional] @@ -42,845 +43,865 @@ Name | Type | Description | Notes ## Methods -### NewDeploymentCluster +### NewClusterPipelineCluster -`func NewDeploymentCluster(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, id string, instances []ClusterInstancesInner, lastUsed time.Time, modified time.Time, providerCapacity bool, tenantIds []string, ) *DeploymentCluster` +`func NewClusterPipelineCluster(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, id string, instances []ClusterInstancesInner, lastProvisioningStateChange time.Time, lastUsed time.Time, modified time.Time, providerCapacity bool, tenantIds []string, ) *ClusterPipelineCluster` -NewDeploymentCluster instantiates a new DeploymentCluster object +NewClusterPipelineCluster instantiates a new ClusterPipelineCluster object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed -### NewDeploymentClusterWithDefaults +### NewClusterPipelineClusterWithDefaults -`func NewDeploymentClusterWithDefaults() *DeploymentCluster` +`func NewClusterPipelineClusterWithDefaults() *ClusterPipelineCluster` -NewDeploymentClusterWithDefaults instantiates a new DeploymentCluster object +NewClusterPipelineClusterWithDefaults instantiates a new ClusterPipelineCluster object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set ### GetAvailable -`func (o *DeploymentCluster) GetAvailable() bool` +`func (o *ClusterPipelineCluster) GetAvailable() bool` GetAvailable returns the Available field if non-nil, zero value otherwise. ### GetAvailableOk -`func (o *DeploymentCluster) GetAvailableOk() (*bool, bool)` +`func (o *ClusterPipelineCluster) GetAvailableOk() (*bool, bool)` GetAvailableOk returns a tuple with the Available field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetAvailable -`func (o *DeploymentCluster) SetAvailable(v bool)` +`func (o *ClusterPipelineCluster) SetAvailable(v bool)` SetAvailable sets Available field to given value. ### GetBastionName -`func (o *DeploymentCluster) GetBastionName() string` +`func (o *ClusterPipelineCluster) GetBastionName() string` GetBastionName returns the BastionName field if non-nil, zero value otherwise. ### GetBastionNameOk -`func (o *DeploymentCluster) GetBastionNameOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetBastionNameOk() (*string, bool)` GetBastionNameOk returns a tuple with the BastionName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetBastionName -`func (o *DeploymentCluster) SetBastionName(v string)` +`func (o *ClusterPipelineCluster) SetBastionName(v string)` SetBastionName sets BastionName field to given value. ### HasBastionName -`func (o *DeploymentCluster) HasBastionName() bool` +`func (o *ClusterPipelineCluster) HasBastionName() bool` HasBastionName returns a boolean if a field has been set. ### GetCreated -`func (o *DeploymentCluster) GetCreated() time.Time` +`func (o *ClusterPipelineCluster) GetCreated() time.Time` GetCreated returns the Created field if non-nil, zero value otherwise. ### GetCreatedOk -`func (o *DeploymentCluster) GetCreatedOk() (*time.Time, bool)` +`func (o *ClusterPipelineCluster) GetCreatedOk() (*time.Time, bool)` GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetCreated -`func (o *DeploymentCluster) SetCreated(v time.Time)` +`func (o *ClusterPipelineCluster) SetCreated(v time.Time)` SetCreated sets Created field to given value. ### GetDeployment -`func (o *DeploymentCluster) GetDeployment() ClusterDeployment` +`func (o *ClusterPipelineCluster) GetDeployment() ClusterDeployment` GetDeployment returns the Deployment field if non-nil, zero value otherwise. ### GetDeploymentOk -`func (o *DeploymentCluster) GetDeploymentOk() (*ClusterDeployment, bool)` +`func (o *ClusterPipelineCluster) GetDeploymentOk() (*ClusterDeployment, bool)` GetDeploymentOk returns a tuple with the Deployment field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetDeployment -`func (o *DeploymentCluster) SetDeployment(v ClusterDeployment)` +`func (o *ClusterPipelineCluster) SetDeployment(v ClusterDeployment)` SetDeployment sets Deployment field to given value. ### GetEnabled -`func (o *DeploymentCluster) GetEnabled() bool` +`func (o *ClusterPipelineCluster) GetEnabled() bool` GetEnabled returns the Enabled field if non-nil, zero value otherwise. ### GetEnabledOk -`func (o *DeploymentCluster) GetEnabledOk() (*bool, bool)` +`func (o *ClusterPipelineCluster) GetEnabledOk() (*bool, bool)` GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetEnabled -`func (o *DeploymentCluster) SetEnabled(v bool)` +`func (o *ClusterPipelineCluster) SetEnabled(v bool)` SetEnabled sets Enabled field to given value. ### HasEnabled -`func (o *DeploymentCluster) HasEnabled() bool` +`func (o *ClusterPipelineCluster) HasEnabled() bool` HasEnabled returns a boolean if a field has been set. ### GetExperience -`func (o *DeploymentCluster) GetExperience() string` +`func (o *ClusterPipelineCluster) GetExperience() string` GetExperience returns the Experience field if non-nil, zero value otherwise. ### GetExperienceOk -`func (o *DeploymentCluster) GetExperienceOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetExperienceOk() (*string, bool)` GetExperienceOk returns a tuple with the Experience field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetExperience -`func (o *DeploymentCluster) SetExperience(v string)` +`func (o *ClusterPipelineCluster) SetExperience(v string)` SetExperience sets Experience field to given value. ### HasExperience -`func (o *DeploymentCluster) HasExperience() bool` +`func (o *ClusterPipelineCluster) HasExperience() bool` HasExperience returns a boolean if a field has been set. ### GetFreeBy -`func (o *DeploymentCluster) GetFreeBy() time.Time` +`func (o *ClusterPipelineCluster) GetFreeBy() time.Time` GetFreeBy returns the FreeBy field if non-nil, zero value otherwise. ### GetFreeByOk -`func (o *DeploymentCluster) GetFreeByOk() (*time.Time, bool)` +`func (o *ClusterPipelineCluster) GetFreeByOk() (*time.Time, bool)` GetFreeByOk returns a tuple with the FreeBy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetFreeBy -`func (o *DeploymentCluster) SetFreeBy(v time.Time)` +`func (o *ClusterPipelineCluster) SetFreeBy(v time.Time)` SetFreeBy sets FreeBy field to given value. ### HasFreeBy -`func (o *DeploymentCluster) HasFreeBy() bool` +`func (o *ClusterPipelineCluster) HasFreeBy() bool` HasFreeBy returns a boolean if a field has been set. ### GetGpus -`func (o *DeploymentCluster) GetGpus() []ClusterGpusInner` +`func (o *ClusterPipelineCluster) GetGpus() []ClusterGpusInner` GetGpus returns the Gpus field if non-nil, zero value otherwise. ### GetGpusOk -`func (o *DeploymentCluster) GetGpusOk() (*[]ClusterGpusInner, bool)` +`func (o *ClusterPipelineCluster) GetGpusOk() (*[]ClusterGpusInner, bool)` GetGpusOk returns a tuple with the Gpus field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetGpus -`func (o *DeploymentCluster) SetGpus(v []ClusterGpusInner)` +`func (o *ClusterPipelineCluster) SetGpus(v []ClusterGpusInner)` SetGpus sets Gpus field to given value. ### GetGpuAlias -`func (o *DeploymentCluster) GetGpuAlias() string` +`func (o *ClusterPipelineCluster) GetGpuAlias() string` GetGpuAlias returns the GpuAlias field if non-nil, zero value otherwise. ### GetGpuAliasOk -`func (o *DeploymentCluster) GetGpuAliasOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetGpuAliasOk() (*string, bool)` GetGpuAliasOk returns a tuple with the GpuAlias field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetGpuAlias -`func (o *DeploymentCluster) SetGpuAlias(v string)` +`func (o *ClusterPipelineCluster) SetGpuAlias(v string)` SetGpuAlias sets GpuAlias field to given value. ### HasGpuAlias -`func (o *DeploymentCluster) HasGpuAlias() bool` +`func (o *ClusterPipelineCluster) HasGpuAlias() bool` HasGpuAlias returns a boolean if a field has been set. ### GetGpuCount -`func (o *DeploymentCluster) GetGpuCount() int32` +`func (o *ClusterPipelineCluster) GetGpuCount() int32` GetGpuCount returns the GpuCount field if non-nil, zero value otherwise. ### GetGpuCountOk -`func (o *DeploymentCluster) GetGpuCountOk() (*int32, bool)` +`func (o *ClusterPipelineCluster) GetGpuCountOk() (*int32, bool)` GetGpuCountOk returns a tuple with the GpuCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetGpuCount -`func (o *DeploymentCluster) SetGpuCount(v int32)` +`func (o *ClusterPipelineCluster) SetGpuCount(v int32)` SetGpuCount sets GpuCount field to given value. ### HasGpuCount -`func (o *DeploymentCluster) HasGpuCount() bool` +`func (o *ClusterPipelineCluster) HasGpuCount() bool` HasGpuCount returns a boolean if a field has been set. ### GetId -`func (o *DeploymentCluster) GetId() string` +`func (o *ClusterPipelineCluster) GetId() string` GetId returns the Id field if non-nil, zero value otherwise. ### GetIdOk -`func (o *DeploymentCluster) GetIdOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetIdOk() (*string, bool)` GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetId -`func (o *DeploymentCluster) SetId(v string)` +`func (o *ClusterPipelineCluster) SetId(v string)` SetId sets Id field to given value. ### GetInstances -`func (o *DeploymentCluster) GetInstances() []ClusterInstancesInner` +`func (o *ClusterPipelineCluster) GetInstances() []ClusterInstancesInner` GetInstances returns the Instances field if non-nil, zero value otherwise. ### GetInstancesOk -`func (o *DeploymentCluster) GetInstancesOk() (*[]ClusterInstancesInner, bool)` +`func (o *ClusterPipelineCluster) GetInstancesOk() (*[]ClusterInstancesInner, bool)` GetInstancesOk returns a tuple with the Instances field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetInstances -`func (o *DeploymentCluster) SetInstances(v []ClusterInstancesInner)` +`func (o *ClusterPipelineCluster) SetInstances(v []ClusterInstancesInner)` SetInstances sets Instances field to given value. +### GetLastProvisioningStateChange + +`func (o *ClusterPipelineCluster) GetLastProvisioningStateChange() time.Time` + +GetLastProvisioningStateChange returns the LastProvisioningStateChange field if non-nil, zero value otherwise. + +### GetLastProvisioningStateChangeOk + +`func (o *ClusterPipelineCluster) GetLastProvisioningStateChangeOk() (*time.Time, bool)` + +GetLastProvisioningStateChangeOk returns a tuple with the LastProvisioningStateChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastProvisioningStateChange + +`func (o *ClusterPipelineCluster) SetLastProvisioningStateChange(v time.Time)` + +SetLastProvisioningStateChange sets LastProvisioningStateChange field to given value. + + ### GetLastUsed -`func (o *DeploymentCluster) GetLastUsed() time.Time` +`func (o *ClusterPipelineCluster) GetLastUsed() time.Time` GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. ### GetLastUsedOk -`func (o *DeploymentCluster) GetLastUsedOk() (*time.Time, bool)` +`func (o *ClusterPipelineCluster) GetLastUsedOk() (*time.Time, bool)` GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetLastUsed -`func (o *DeploymentCluster) SetLastUsed(v time.Time)` +`func (o *ClusterPipelineCluster) SetLastUsed(v time.Time)` SetLastUsed sets LastUsed field to given value. ### GetMaintenance -`func (o *DeploymentCluster) GetMaintenance() bool` +`func (o *ClusterPipelineCluster) GetMaintenance() bool` GetMaintenance returns the Maintenance field if non-nil, zero value otherwise. ### GetMaintenanceOk -`func (o *DeploymentCluster) GetMaintenanceOk() (*bool, bool)` +`func (o *ClusterPipelineCluster) GetMaintenanceOk() (*bool, bool)` GetMaintenanceOk returns a tuple with the Maintenance field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetMaintenance -`func (o *DeploymentCluster) SetMaintenance(v bool)` +`func (o *ClusterPipelineCluster) SetMaintenance(v bool)` SetMaintenance sets Maintenance field to given value. ### HasMaintenance -`func (o *DeploymentCluster) HasMaintenance() bool` +`func (o *ClusterPipelineCluster) HasMaintenance() bool` HasMaintenance returns a boolean if a field has been set. ### GetMgmtIp -`func (o *DeploymentCluster) GetMgmtIp() string` +`func (o *ClusterPipelineCluster) GetMgmtIp() string` GetMgmtIp returns the MgmtIp field if non-nil, zero value otherwise. ### GetMgmtIpOk -`func (o *DeploymentCluster) GetMgmtIpOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetMgmtIpOk() (*string, bool)` GetMgmtIpOk returns a tuple with the MgmtIp field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetMgmtIp -`func (o *DeploymentCluster) SetMgmtIp(v string)` +`func (o *ClusterPipelineCluster) SetMgmtIp(v string)` SetMgmtIp sets MgmtIp field to given value. ### HasMgmtIp -`func (o *DeploymentCluster) HasMgmtIp() bool` +`func (o *ClusterPipelineCluster) HasMgmtIp() bool` HasMgmtIp returns a boolean if a field has been set. ### GetMgmtMac -`func (o *DeploymentCluster) GetMgmtMac() string` +`func (o *ClusterPipelineCluster) GetMgmtMac() string` GetMgmtMac returns the MgmtMac field if non-nil, zero value otherwise. ### GetMgmtMacOk -`func (o *DeploymentCluster) GetMgmtMacOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetMgmtMacOk() (*string, bool)` GetMgmtMacOk returns a tuple with the MgmtMac field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetMgmtMac -`func (o *DeploymentCluster) SetMgmtMac(v string)` +`func (o *ClusterPipelineCluster) SetMgmtMac(v string)` SetMgmtMac sets MgmtMac field to given value. ### HasMgmtMac -`func (o *DeploymentCluster) HasMgmtMac() bool` +`func (o *ClusterPipelineCluster) HasMgmtMac() bool` HasMgmtMac returns a boolean if a field has been set. ### GetModified -`func (o *DeploymentCluster) GetModified() time.Time` +`func (o *ClusterPipelineCluster) GetModified() time.Time` GetModified returns the Modified field if non-nil, zero value otherwise. ### GetModifiedOk -`func (o *DeploymentCluster) GetModifiedOk() (*time.Time, bool)` +`func (o *ClusterPipelineCluster) GetModifiedOk() (*time.Time, bool)` GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetModified -`func (o *DeploymentCluster) SetModified(v time.Time)` +`func (o *ClusterPipelineCluster) SetModified(v time.Time)` SetModified sets Modified field to given value. ### GetNetmask -`func (o *DeploymentCluster) GetNetmask() int32` +`func (o *ClusterPipelineCluster) GetNetmask() int32` GetNetmask returns the Netmask field if non-nil, zero value otherwise. ### GetNetmaskOk -`func (o *DeploymentCluster) GetNetmaskOk() (*int32, bool)` +`func (o *ClusterPipelineCluster) GetNetmaskOk() (*int32, bool)` GetNetmaskOk returns a tuple with the Netmask field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetNetmask -`func (o *DeploymentCluster) SetNetmask(v int32)` +`func (o *ClusterPipelineCluster) SetNetmask(v int32)` SetNetmask sets Netmask field to given value. ### HasNetmask -`func (o *DeploymentCluster) HasNetmask() bool` +`func (o *ClusterPipelineCluster) HasNetmask() bool` HasNetmask returns a boolean if a field has been set. ### GetNodeCount -`func (o *DeploymentCluster) GetNodeCount() int32` +`func (o *ClusterPipelineCluster) GetNodeCount() int32` GetNodeCount returns the NodeCount field if non-nil, zero value otherwise. ### GetNodeCountOk -`func (o *DeploymentCluster) GetNodeCountOk() (*int32, bool)` +`func (o *ClusterPipelineCluster) GetNodeCountOk() (*int32, bool)` GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetNodeCount -`func (o *DeploymentCluster) SetNodeCount(v int32)` +`func (o *ClusterPipelineCluster) SetNodeCount(v int32)` SetNodeCount sets NodeCount field to given value. ### HasNodeCount -`func (o *DeploymentCluster) HasNodeCount() bool` +`func (o *ClusterPipelineCluster) HasNodeCount() bool` HasNodeCount returns a boolean if a field has been set. ### GetNodes -`func (o *DeploymentCluster) GetNodes() []ClusterNodesInner` +`func (o *ClusterPipelineCluster) GetNodes() []ClusterNodesInner` GetNodes returns the Nodes field if non-nil, zero value otherwise. ### GetNodesOk -`func (o *DeploymentCluster) GetNodesOk() (*[]ClusterNodesInner, bool)` +`func (o *ClusterPipelineCluster) GetNodesOk() (*[]ClusterNodesInner, bool)` GetNodesOk returns a tuple with the Nodes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetNodes -`func (o *DeploymentCluster) SetNodes(v []ClusterNodesInner)` +`func (o *ClusterPipelineCluster) SetNodes(v []ClusterNodesInner)` SetNodes sets Nodes field to given value. ### HasNodes -`func (o *DeploymentCluster) HasNodes() bool` +`func (o *ClusterPipelineCluster) HasNodes() bool` HasNodes returns a boolean if a field has been set. ### GetNotes -`func (o *DeploymentCluster) GetNotes() string` +`func (o *ClusterPipelineCluster) GetNotes() string` GetNotes returns the Notes field if non-nil, zero value otherwise. ### GetNotesOk -`func (o *DeploymentCluster) GetNotesOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetNotesOk() (*string, bool)` GetNotesOk returns a tuple with the Notes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetNotes -`func (o *DeploymentCluster) SetNotes(v string)` +`func (o *ClusterPipelineCluster) SetNotes(v string)` SetNotes sets Notes field to given value. ### HasNotes -`func (o *DeploymentCluster) HasNotes() bool` +`func (o *ClusterPipelineCluster) HasNotes() bool` HasNotes returns a boolean if a field has been set. ### GetPersist -`func (o *DeploymentCluster) GetPersist() bool` +`func (o *ClusterPipelineCluster) GetPersist() bool` GetPersist returns the Persist field if non-nil, zero value otherwise. ### GetPersistOk -`func (o *DeploymentCluster) GetPersistOk() (*bool, bool)` +`func (o *ClusterPipelineCluster) GetPersistOk() (*bool, bool)` GetPersistOk returns a tuple with the Persist field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetPersist -`func (o *DeploymentCluster) SetPersist(v bool)` +`func (o *ClusterPipelineCluster) SetPersist(v bool)` SetPersist sets Persist field to given value. ### HasPersist -`func (o *DeploymentCluster) HasPersist() bool` +`func (o *ClusterPipelineCluster) HasPersist() bool` HasPersist returns a boolean if a field has been set. ### GetProviderCapacity -`func (o *DeploymentCluster) GetProviderCapacity() bool` +`func (o *ClusterPipelineCluster) GetProviderCapacity() bool` GetProviderCapacity returns the ProviderCapacity field if non-nil, zero value otherwise. ### GetProviderCapacityOk -`func (o *DeploymentCluster) GetProviderCapacityOk() (*bool, bool)` +`func (o *ClusterPipelineCluster) GetProviderCapacityOk() (*bool, bool)` GetProviderCapacityOk returns a tuple with the ProviderCapacity field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetProviderCapacity -`func (o *DeploymentCluster) SetProviderCapacity(v bool)` +`func (o *ClusterPipelineCluster) SetProviderCapacity(v bool)` SetProviderCapacity sets ProviderCapacity field to given value. ### GetProvisionUser -`func (o *DeploymentCluster) GetProvisionUser() string` +`func (o *ClusterPipelineCluster) GetProvisionUser() string` GetProvisionUser returns the ProvisionUser field if non-nil, zero value otherwise. ### GetProvisionUserOk -`func (o *DeploymentCluster) GetProvisionUserOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetProvisionUserOk() (*string, bool)` GetProvisionUserOk returns a tuple with the ProvisionUser field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetProvisionUser -`func (o *DeploymentCluster) SetProvisionUser(v string)` +`func (o *ClusterPipelineCluster) SetProvisionUser(v string)` SetProvisionUser sets ProvisionUser field to given value. ### HasProvisionUser -`func (o *DeploymentCluster) HasProvisionUser() bool` +`func (o *ClusterPipelineCluster) HasProvisionUser() bool` HasProvisionUser returns a boolean if a field has been set. ### GetProvisioningAttempts -`func (o *DeploymentCluster) GetProvisioningAttempts() int32` +`func (o *ClusterPipelineCluster) GetProvisioningAttempts() int32` GetProvisioningAttempts returns the ProvisioningAttempts field if non-nil, zero value otherwise. ### GetProvisioningAttemptsOk -`func (o *DeploymentCluster) GetProvisioningAttemptsOk() (*int32, bool)` +`func (o *ClusterPipelineCluster) GetProvisioningAttemptsOk() (*int32, bool)` GetProvisioningAttemptsOk returns a tuple with the ProvisioningAttempts field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetProvisioningAttempts -`func (o *DeploymentCluster) SetProvisioningAttempts(v int32)` +`func (o *ClusterPipelineCluster) SetProvisioningAttempts(v int32)` SetProvisioningAttempts sets ProvisioningAttempts field to given value. ### HasProvisioningAttempts -`func (o *DeploymentCluster) HasProvisioningAttempts() bool` +`func (o *ClusterPipelineCluster) HasProvisioningAttempts() bool` HasProvisioningAttempts returns a boolean if a field has been set. ### GetProvisioningConfig -`func (o *DeploymentCluster) GetProvisioningConfig() string` +`func (o *ClusterPipelineCluster) GetProvisioningConfig() string` GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. ### GetProvisioningConfigOk -`func (o *DeploymentCluster) GetProvisioningConfigOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetProvisioningConfigOk() (*string, bool)` GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetProvisioningConfig -`func (o *DeploymentCluster) SetProvisioningConfig(v string)` +`func (o *ClusterPipelineCluster) SetProvisioningConfig(v string)` SetProvisioningConfig sets ProvisioningConfig field to given value. ### HasProvisioningConfig -`func (o *DeploymentCluster) HasProvisioningConfig() bool` +`func (o *ClusterPipelineCluster) HasProvisioningConfig() bool` HasProvisioningConfig returns a boolean if a field has been set. ### GetProvisioningRequest -`func (o *DeploymentCluster) GetProvisioningRequest() string` +`func (o *ClusterPipelineCluster) GetProvisioningRequest() string` GetProvisioningRequest returns the ProvisioningRequest field if non-nil, zero value otherwise. ### GetProvisioningRequestOk -`func (o *DeploymentCluster) GetProvisioningRequestOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetProvisioningRequestOk() (*string, bool)` GetProvisioningRequestOk returns a tuple with the ProvisioningRequest field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetProvisioningRequest -`func (o *DeploymentCluster) SetProvisioningRequest(v string)` +`func (o *ClusterPipelineCluster) SetProvisioningRequest(v string)` SetProvisioningRequest sets ProvisioningRequest field to given value. ### HasProvisioningRequest -`func (o *DeploymentCluster) HasProvisioningRequest() bool` +`func (o *ClusterPipelineCluster) HasProvisioningRequest() bool` HasProvisioningRequest returns a boolean if a field has been set. ### GetProvisioningState -`func (o *DeploymentCluster) GetProvisioningState() ProvisioningStateEnum` +`func (o *ClusterPipelineCluster) GetProvisioningState() ProvisioningStateEnum` GetProvisioningState returns the ProvisioningState field if non-nil, zero value otherwise. ### GetProvisioningStateOk -`func (o *DeploymentCluster) GetProvisioningStateOk() (*ProvisioningStateEnum, bool)` +`func (o *ClusterPipelineCluster) GetProvisioningStateOk() (*ProvisioningStateEnum, bool)` GetProvisioningStateOk returns a tuple with the ProvisioningState field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetProvisioningState -`func (o *DeploymentCluster) SetProvisioningState(v ProvisioningStateEnum)` +`func (o *ClusterPipelineCluster) SetProvisioningState(v ProvisioningStateEnum)` SetProvisioningState sets ProvisioningState field to given value. ### HasProvisioningState -`func (o *DeploymentCluster) HasProvisioningState() bool` +`func (o *ClusterPipelineCluster) HasProvisioningState() bool` HasProvisioningState returns a boolean if a field has been set. ### GetPublicAddress -`func (o *DeploymentCluster) GetPublicAddress() string` +`func (o *ClusterPipelineCluster) GetPublicAddress() string` GetPublicAddress returns the PublicAddress field if non-nil, zero value otherwise. ### GetPublicAddressOk -`func (o *DeploymentCluster) GetPublicAddressOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetPublicAddressOk() (*string, bool)` GetPublicAddressOk returns a tuple with the PublicAddress field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetPublicAddress -`func (o *DeploymentCluster) SetPublicAddress(v string)` +`func (o *ClusterPipelineCluster) SetPublicAddress(v string)` SetPublicAddress sets PublicAddress field to given value. ### HasPublicAddress -`func (o *DeploymentCluster) HasPublicAddress() bool` +`func (o *ClusterPipelineCluster) HasPublicAddress() bool` HasPublicAddress returns a boolean if a field has been set. ### GetRequestId -`func (o *DeploymentCluster) GetRequestId() string` +`func (o *ClusterPipelineCluster) GetRequestId() string` GetRequestId returns the RequestId field if non-nil, zero value otherwise. ### GetRequestIdOk -`func (o *DeploymentCluster) GetRequestIdOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetRequestIdOk() (*string, bool)` GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetRequestId -`func (o *DeploymentCluster) SetRequestId(v string)` +`func (o *ClusterPipelineCluster) SetRequestId(v string)` SetRequestId sets RequestId field to given value. ### HasRequestId -`func (o *DeploymentCluster) HasRequestId() bool` +`func (o *ClusterPipelineCluster) HasRequestId() bool` HasRequestId returns a boolean if a field has been set. ### GetReservation -`func (o *DeploymentCluster) GetReservation() bool` +`func (o *ClusterPipelineCluster) GetReservation() bool` GetReservation returns the Reservation field if non-nil, zero value otherwise. ### GetReservationOk -`func (o *DeploymentCluster) GetReservationOk() (*bool, bool)` +`func (o *ClusterPipelineCluster) GetReservationOk() (*bool, bool)` GetReservationOk returns a tuple with the Reservation field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetReservation -`func (o *DeploymentCluster) SetReservation(v bool)` +`func (o *ClusterPipelineCluster) SetReservation(v bool)` SetReservation sets Reservation field to given value. ### HasReservation -`func (o *DeploymentCluster) HasReservation() bool` +`func (o *ClusterPipelineCluster) HasReservation() bool` HasReservation returns a boolean if a field has been set. ### GetTenantIds -`func (o *DeploymentCluster) GetTenantIds() []string` +`func (o *ClusterPipelineCluster) GetTenantIds() []string` GetTenantIds returns the TenantIds field if non-nil, zero value otherwise. ### GetTenantIdsOk -`func (o *DeploymentCluster) GetTenantIdsOk() (*[]string, bool)` +`func (o *ClusterPipelineCluster) GetTenantIdsOk() (*[]string, bool)` GetTenantIdsOk returns a tuple with the TenantIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetTenantIds -`func (o *DeploymentCluster) SetTenantIds(v []string)` +`func (o *ClusterPipelineCluster) SetTenantIds(v []string)` SetTenantIds sets TenantIds field to given value. ### GetVlanId -`func (o *DeploymentCluster) GetVlanId() int32` +`func (o *ClusterPipelineCluster) GetVlanId() int32` GetVlanId returns the VlanId field if non-nil, zero value otherwise. ### GetVlanIdOk -`func (o *DeploymentCluster) GetVlanIdOk() (*int32, bool)` +`func (o *ClusterPipelineCluster) GetVlanIdOk() (*int32, bool)` GetVlanIdOk returns a tuple with the VlanId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetVlanId -`func (o *DeploymentCluster) SetVlanId(v int32)` +`func (o *ClusterPipelineCluster) SetVlanId(v int32)` SetVlanId sets VlanId field to given value. ### HasVlanId -`func (o *DeploymentCluster) HasVlanId() bool` +`func (o *ClusterPipelineCluster) HasVlanId() bool` HasVlanId returns a boolean if a field has been set. ### GetWorkshop -`func (o *DeploymentCluster) GetWorkshop() bool` +`func (o *ClusterPipelineCluster) GetWorkshop() bool` GetWorkshop returns the Workshop field if non-nil, zero value otherwise. ### GetWorkshopOk -`func (o *DeploymentCluster) GetWorkshopOk() (*bool, bool)` +`func (o *ClusterPipelineCluster) GetWorkshopOk() (*bool, bool)` GetWorkshopOk returns a tuple with the Workshop field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetWorkshop -`func (o *DeploymentCluster) SetWorkshop(v bool)` +`func (o *ClusterPipelineCluster) SetWorkshop(v bool)` SetWorkshop sets Workshop field to given value. ### HasWorkshop -`func (o *DeploymentCluster) HasWorkshop() bool` +`func (o *ClusterPipelineCluster) HasWorkshop() bool` HasWorkshop returns a boolean if a field has been set. ### GetWorkshopId -`func (o *DeploymentCluster) GetWorkshopId() string` +`func (o *ClusterPipelineCluster) GetWorkshopId() string` GetWorkshopId returns the WorkshopId field if non-nil, zero value otherwise. ### GetWorkshopIdOk -`func (o *DeploymentCluster) GetWorkshopIdOk() (*string, bool)` +`func (o *ClusterPipelineCluster) GetWorkshopIdOk() (*string, bool)` GetWorkshopIdOk returns a tuple with the WorkshopId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetWorkshopId -`func (o *DeploymentCluster) SetWorkshopId(v string)` +`func (o *ClusterPipelineCluster) SetWorkshopId(v string)` SetWorkshopId sets WorkshopId field to given value. ### HasWorkshopId -`func (o *DeploymentCluster) HasWorkshopId() bool` +`func (o *ClusterPipelineCluster) HasWorkshopId() bool` HasWorkshopId returns a boolean if a field has been set. diff --git a/v1/providers/launchpad/gen/launchpad/docs/ClusterProvisionCreateResponse.md b/v1/providers/launchpad/gen/launchpad/docs/ClusterProvisionCreateResponse.md new file mode 100644 index 0000000..3eaba8e --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/docs/ClusterProvisionCreateResponse.md @@ -0,0 +1,72 @@ +# ClusterProvisionCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pipeline** | [**ClusterPipeline**](ClusterPipeline.md) | | [readonly] +**ProvisioningConfig** | [**ProvisioningRequest**](ProvisioningRequest.md) | | [readonly] + +## Methods + +### NewClusterProvisionCreateResponse + +`func NewClusterProvisionCreateResponse(pipeline ClusterPipeline, provisioningConfig ProvisioningRequest, ) *ClusterProvisionCreateResponse` + +NewClusterProvisionCreateResponse instantiates a new ClusterProvisionCreateResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterProvisionCreateResponseWithDefaults + +`func NewClusterProvisionCreateResponseWithDefaults() *ClusterProvisionCreateResponse` + +NewClusterProvisionCreateResponseWithDefaults instantiates a new ClusterProvisionCreateResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPipeline + +`func (o *ClusterProvisionCreateResponse) GetPipeline() ClusterPipeline` + +GetPipeline returns the Pipeline field if non-nil, zero value otherwise. + +### GetPipelineOk + +`func (o *ClusterProvisionCreateResponse) GetPipelineOk() (*ClusterPipeline, bool)` + +GetPipelineOk returns a tuple with the Pipeline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPipeline + +`func (o *ClusterProvisionCreateResponse) SetPipeline(v ClusterPipeline)` + +SetPipeline sets Pipeline field to given value. + + +### GetProvisioningConfig + +`func (o *ClusterProvisionCreateResponse) GetProvisioningConfig() ProvisioningRequest` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ClusterProvisionCreateResponse) GetProvisioningConfigOk() (*ProvisioningRequest, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ClusterProvisionCreateResponse) SetProvisioningConfig(v ProvisioningRequest)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/providers/launchpad/gen/launchpad/docs/Deployment.md b/v1/providers/launchpad/gen/launchpad/docs/Deployment.md index 6bfb611..5d8d545 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/Deployment.md +++ b/v1/providers/launchpad/gen/launchpad/docs/Deployment.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **BastionOperatingSystem** | Pointer to **NullableString** | Override bastion operating system provisioned and/or configured by Liftoff | [optional] **CatalogId** | Pointer to **string** | Catalog ID of the experience provisioned to the cluster | [optional] **CatalogIdAlias** | Pointer to **string** | Catalog ID alias of the experience provisioned to the cluster | [optional] -**Cluster** | Pointer to [**DeploymentCluster**](DeploymentCluster.md) | | [optional] +**Cluster** | Pointer to [**ClusterPipelineCluster**](ClusterPipelineCluster.md) | | [optional] **CollectionBranch** | Pointer to **NullableString** | Override the Ansible collection branch initialized within the pipeline | [optional] **Created** | **time.Time** | Timestamp of when the object was created | [readonly] **Experience** | Pointer to **NullableString** | The experience being deployed for use | [optional] [readonly] @@ -176,20 +176,20 @@ HasCatalogIdAlias returns a boolean if a field has been set. ### GetCluster -`func (o *Deployment) GetCluster() DeploymentCluster` +`func (o *Deployment) GetCluster() ClusterPipelineCluster` GetCluster returns the Cluster field if non-nil, zero value otherwise. ### GetClusterOk -`func (o *Deployment) GetClusterOk() (*DeploymentCluster, bool)` +`func (o *Deployment) GetClusterOk() (*ClusterPipelineCluster, bool)` GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetCluster -`func (o *Deployment) SetCluster(v DeploymentCluster)` +`func (o *Deployment) SetCluster(v ClusterPipelineCluster)` SetCluster sets Cluster field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/DeploymentPipelineTrigger.md b/v1/providers/launchpad/gen/launchpad/docs/DeploymentPipelineTrigger.md new file mode 100644 index 0000000..ef2cae6 --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/docs/DeploymentPipelineTrigger.md @@ -0,0 +1,156 @@ +# DeploymentPipelineTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Action** | [**PipelineAction**](PipelineAction.md) | Action for the pipeline to run * `apply` - apply * `destroy` - destroy * `notify` - notify | +**Created** | **time.Time** | Timestamp of when the object was created | [readonly] +**Id** | **string** | | [readonly] +**Modified** | **time.Time** | Timestamp of when the object was last modified | [readonly] +**PipelineId** | **int32** | GitLab pipeline ID | [readonly] +**Url** | **string** | URL for the pipeline details | [readonly] + +## Methods + +### NewDeploymentPipelineTrigger + +`func NewDeploymentPipelineTrigger(action PipelineAction, created time.Time, id string, modified time.Time, pipelineId int32, url string, ) *DeploymentPipelineTrigger` + +NewDeploymentPipelineTrigger instantiates a new DeploymentPipelineTrigger object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeploymentPipelineTriggerWithDefaults + +`func NewDeploymentPipelineTriggerWithDefaults() *DeploymentPipelineTrigger` + +NewDeploymentPipelineTriggerWithDefaults instantiates a new DeploymentPipelineTrigger object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAction + +`func (o *DeploymentPipelineTrigger) GetAction() PipelineAction` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *DeploymentPipelineTrigger) GetActionOk() (*PipelineAction, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *DeploymentPipelineTrigger) SetAction(v PipelineAction)` + +SetAction sets Action field to given value. + + +### GetCreated + +`func (o *DeploymentPipelineTrigger) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DeploymentPipelineTrigger) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DeploymentPipelineTrigger) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetId + +`func (o *DeploymentPipelineTrigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DeploymentPipelineTrigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DeploymentPipelineTrigger) SetId(v string)` + +SetId sets Id field to given value. + + +### GetModified + +`func (o *DeploymentPipelineTrigger) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *DeploymentPipelineTrigger) GetModifiedOk() (*time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *DeploymentPipelineTrigger) SetModified(v time.Time)` + +SetModified sets Modified field to given value. + + +### GetPipelineId + +`func (o *DeploymentPipelineTrigger) GetPipelineId() int32` + +GetPipelineId returns the PipelineId field if non-nil, zero value otherwise. + +### GetPipelineIdOk + +`func (o *DeploymentPipelineTrigger) GetPipelineIdOk() (*int32, bool)` + +GetPipelineIdOk returns a tuple with the PipelineId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPipelineId + +`func (o *DeploymentPipelineTrigger) SetPipelineId(v int32)` + +SetPipelineId sets PipelineId field to given value. + + +### GetUrl + +`func (o *DeploymentPipelineTrigger) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *DeploymentPipelineTrigger) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *DeploymentPipelineTrigger) SetUrl(v string)` + +SetUrl sets Url field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/providers/launchpad/gen/launchpad/docs/DocDeploymentDelete.md b/v1/providers/launchpad/gen/launchpad/docs/DocDeploymentDelete.md index e954b26..1f7d86e 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/DocDeploymentDelete.md +++ b/v1/providers/launchpad/gen/launchpad/docs/DocDeploymentDelete.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **BastionOperatingSystem** | Pointer to **NullableString** | Override bastion operating system provisioned and/or configured by Liftoff | [optional] **CatalogId** | Pointer to **string** | Catalog ID of the experience provisioned to the cluster | [optional] **CatalogIdAlias** | Pointer to **string** | Catalog ID alias of the experience provisioned to the cluster | [optional] -**Cluster** | Pointer to [**DeploymentCluster**](DeploymentCluster.md) | | [optional] +**Cluster** | Pointer to [**ClusterPipelineCluster**](ClusterPipelineCluster.md) | | [optional] **CollectionBranch** | Pointer to **NullableString** | Override the Ansible collection branch initialized within the pipeline | [optional] **Created** | **time.Time** | Timestamp of when the object was created | [readonly] **Experience** | **NullableString** | The experience being deployed for use | [readonly] @@ -176,20 +176,20 @@ HasCatalogIdAlias returns a boolean if a field has been set. ### GetCluster -`func (o *DocDeploymentDelete) GetCluster() DeploymentCluster` +`func (o *DocDeploymentDelete) GetCluster() ClusterPipelineCluster` GetCluster returns the Cluster field if non-nil, zero value otherwise. ### GetClusterOk -`func (o *DocDeploymentDelete) GetClusterOk() (*DeploymentCluster, bool)` +`func (o *DocDeploymentDelete) GetClusterOk() (*ClusterPipelineCluster, bool)` GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetCluster -`func (o *DocDeploymentDelete) SetCluster(v DeploymentCluster)` +`func (o *DocDeploymentDelete) SetCluster(v ClusterPipelineCluster)` SetCluster sets Cluster field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/Experience.md b/v1/providers/launchpad/gen/launchpad/docs/Experience.md index bc29e0b..ee33c3e 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/Experience.md +++ b/v1/providers/launchpad/gen/launchpad/docs/Experience.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **ExperienceBranch** | Pointer to **string** | Experience branch name used during deployment (default: origin/main) | [optional] **FcPlatform** | Pointer to [**NullableFcPlatformEnum**](FcPlatformEnum.md) | | [optional] **FcSupport** | Pointer to **bool** | Does the experience support Flight Control? | [optional] +**Featured** | **bool** | Is the experience featured in the catalog? | [readonly] **GarageId** | Pointer to **NullableString** | ID of the garage where nodes for this experience should be selected from | [optional] **GcBranch** | Pointer to **string** | Ground Control branch name (default: main) | [optional] **GpuCount** | Pointer to **int32** | Number of GPUs used | [optional] @@ -27,9 +28,10 @@ Name | Type | Description | Notes **Lifetime** | Pointer to **NullableInt32** | Default number of days a provisioned experience should remain active (default: 3). A null lifetime will cause a deployment to remain active indefinitely. | [optional] **Modified** | **time.Time** | Timestamp of when the object was last modified | [readonly] **NodeCount** | Pointer to **int32** | Number of Nodes used | [optional] +**Oem** | Pointer to **NullableString** | If set, the experience must be provisioned to hardware manufactured by the given OEM | [optional] **Persona** | **string** | | **Pipeline** | **int64** | Pipeline ID used for provisioning | -**Platform** | [**PlatformEnum**](PlatformEnum.md) | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | +**Platform** | [**PlatformEnum**](PlatformEnum.md) | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | **Provider** | Pointer to **NullableString** | If set, the experience must be provisioned to the given provider | [optional] **Published** | Pointer to [**PublishedEnum**](PublishedEnum.md) | Is the experience published for use? * `draft` - draft * `no` - no * `yes` - yes | [optional] **Repo** | Pointer to **NullableString** | URL of the repository for provisioning automation | [optional] @@ -38,13 +40,13 @@ Name | Type | Description | Notes **SaLab** | Pointer to **bool** | Is this a persistent experience for SAs? | [optional] **SystemArch** | [**SystemArchEnum**](SystemArchEnum.md) | Required CPU architecture * `amd64` - amd64 * `arm64` - arm64 | **Title** | **string** | | -**VgpuProfile** | Pointer to [**NullableVgpuProfileEnum**](VgpuProfileEnum.md) | | [optional] +**VgpuProfile** | Pointer to **NullableString** | | [optional] ## Methods ### NewExperience -`func NewExperience(catalogId string, category CategoryEnum, created time.Time, experience string, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, ) *Experience` +`func NewExperience(catalogId string, category CategoryEnum, created time.Time, experience string, featured bool, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, ) *Experience` NewExperience instantiates a new Experience object This constructor will assign default values to properties that have it defined, @@ -429,6 +431,26 @@ SetFcSupport sets FcSupport field to given value. HasFcSupport returns a boolean if a field has been set. +### GetFeatured + +`func (o *Experience) GetFeatured() bool` + +GetFeatured returns the Featured field if non-nil, zero value otherwise. + +### GetFeaturedOk + +`func (o *Experience) GetFeaturedOk() (*bool, bool)` + +GetFeaturedOk returns a tuple with the Featured field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatured + +`func (o *Experience) SetFeatured(v bool)` + +SetFeatured sets Featured field to given value. + + ### GetGarageId `func (o *Experience) GetGarageId() string` @@ -659,6 +681,41 @@ SetNodeCount sets NodeCount field to given value. HasNodeCount returns a boolean if a field has been set. +### GetOem + +`func (o *Experience) GetOem() string` + +GetOem returns the Oem field if non-nil, zero value otherwise. + +### GetOemOk + +`func (o *Experience) GetOemOk() (*string, bool)` + +GetOemOk returns a tuple with the Oem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOem + +`func (o *Experience) SetOem(v string)` + +SetOem sets Oem field to given value. + +### HasOem + +`func (o *Experience) HasOem() bool` + +HasOem returns a boolean if a field has been set. + +### SetOemNil + +`func (o *Experience) SetOemNil(b bool)` + + SetOemNil sets the value for Oem to be an explicit nil + +### UnsetOem +`func (o *Experience) UnsetOem()` + +UnsetOem ensures that no value is present for Oem, not even an explicit nil ### GetPersona `func (o *Experience) GetPersona() string` @@ -941,20 +998,20 @@ SetTitle sets Title field to given value. ### GetVgpuProfile -`func (o *Experience) GetVgpuProfile() VgpuProfileEnum` +`func (o *Experience) GetVgpuProfile() string` GetVgpuProfile returns the VgpuProfile field if non-nil, zero value otherwise. ### GetVgpuProfileOk -`func (o *Experience) GetVgpuProfileOk() (*VgpuProfileEnum, bool)` +`func (o *Experience) GetVgpuProfileOk() (*string, bool)` GetVgpuProfileOk returns a tuple with the VgpuProfile field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetVgpuProfile -`func (o *Experience) SetVgpuProfile(v VgpuProfileEnum)` +`func (o *Experience) SetVgpuProfile(v string)` SetVgpuProfile sets VgpuProfile field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/ExperienceBulkUpdate.md b/v1/providers/launchpad/gen/launchpad/docs/ExperienceBulkUpdate.md index a63074c..14ea45f 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/ExperienceBulkUpdate.md +++ b/v1/providers/launchpad/gen/launchpad/docs/ExperienceBulkUpdate.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **ExperienceBranch** | Pointer to **string** | Experience branch name used during deployment (default: origin/main) | [optional] **FcPlatform** | Pointer to [**NullableFcPlatformEnum**](FcPlatformEnum.md) | | [optional] **FcSupport** | Pointer to **bool** | Does the experience support Flight Control? | [optional] +**Featured** | **bool** | Is the experience featured in the catalog? | [readonly] **GarageId** | Pointer to **NullableString** | ID of the garage where nodes for this experience should be selected from | [optional] **GcBranch** | Pointer to **string** | Ground Control branch name (default: main) | [optional] **GpuCount** | Pointer to **int32** | Number of GPUs used | [optional] @@ -27,9 +28,10 @@ Name | Type | Description | Notes **Lifetime** | Pointer to **NullableInt32** | Default number of days a provisioned experience should remain active (default: 3). A null lifetime will cause a deployment to remain active indefinitely. | [optional] **Modified** | **time.Time** | Timestamp of when the object was last modified | [readonly] **NodeCount** | Pointer to **int32** | Number of Nodes used | [optional] +**Oem** | Pointer to **NullableString** | If set, the experience must be provisioned to hardware manufactured by the given OEM | [optional] **Persona** | **string** | | **Pipeline** | **int64** | Pipeline ID used for provisioning | -**Platform** | [**PlatformEnum**](PlatformEnum.md) | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | +**Platform** | [**PlatformEnum**](PlatformEnum.md) | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | **Provider** | Pointer to **NullableString** | If set, the experience must be provisioned to the given provider | [optional] **Published** | Pointer to [**PublishedEnum**](PublishedEnum.md) | Is the experience published for use? * `draft` - draft * `no` - no * `yes` - yes | [optional] **Repo** | Pointer to **NullableString** | URL of the repository for provisioning automation | [optional] @@ -38,7 +40,7 @@ Name | Type | Description | Notes **SaLab** | Pointer to **bool** | Is this a persistent experience for SAs? | [optional] **SystemArch** | [**SystemArchEnum**](SystemArchEnum.md) | Required CPU architecture * `amd64` - amd64 * `arm64` - arm64 | **Title** | **string** | | -**VgpuProfile** | Pointer to [**NullableVgpuProfileEnum**](VgpuProfileEnum.md) | | [optional] +**VgpuProfile** | Pointer to **NullableString** | | [optional] **Count** | **int32** | | [readonly] **Ids** | **[]string** | | **Result** | **string** | | [readonly] @@ -47,7 +49,7 @@ Name | Type | Description | Notes ### NewExperienceBulkUpdate -`func NewExperienceBulkUpdate(catalogId string, catalogIdAlias NullableString, category CategoryEnum, created time.Time, experience string, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, count int32, ids []string, result string, ) *ExperienceBulkUpdate` +`func NewExperienceBulkUpdate(catalogId string, catalogIdAlias NullableString, category CategoryEnum, created time.Time, experience string, featured bool, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, count int32, ids []string, result string, ) *ExperienceBulkUpdate` NewExperienceBulkUpdate instantiates a new ExperienceBulkUpdate object This constructor will assign default values to properties that have it defined, @@ -427,6 +429,26 @@ SetFcSupport sets FcSupport field to given value. HasFcSupport returns a boolean if a field has been set. +### GetFeatured + +`func (o *ExperienceBulkUpdate) GetFeatured() bool` + +GetFeatured returns the Featured field if non-nil, zero value otherwise. + +### GetFeaturedOk + +`func (o *ExperienceBulkUpdate) GetFeaturedOk() (*bool, bool)` + +GetFeaturedOk returns a tuple with the Featured field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatured + +`func (o *ExperienceBulkUpdate) SetFeatured(v bool)` + +SetFeatured sets Featured field to given value. + + ### GetGarageId `func (o *ExperienceBulkUpdate) GetGarageId() string` @@ -657,6 +679,41 @@ SetNodeCount sets NodeCount field to given value. HasNodeCount returns a boolean if a field has been set. +### GetOem + +`func (o *ExperienceBulkUpdate) GetOem() string` + +GetOem returns the Oem field if non-nil, zero value otherwise. + +### GetOemOk + +`func (o *ExperienceBulkUpdate) GetOemOk() (*string, bool)` + +GetOemOk returns a tuple with the Oem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOem + +`func (o *ExperienceBulkUpdate) SetOem(v string)` + +SetOem sets Oem field to given value. + +### HasOem + +`func (o *ExperienceBulkUpdate) HasOem() bool` + +HasOem returns a boolean if a field has been set. + +### SetOemNil + +`func (o *ExperienceBulkUpdate) SetOemNil(b bool)` + + SetOemNil sets the value for Oem to be an explicit nil + +### UnsetOem +`func (o *ExperienceBulkUpdate) UnsetOem()` + +UnsetOem ensures that no value is present for Oem, not even an explicit nil ### GetPersona `func (o *ExperienceBulkUpdate) GetPersona() string` @@ -939,20 +996,20 @@ SetTitle sets Title field to given value. ### GetVgpuProfile -`func (o *ExperienceBulkUpdate) GetVgpuProfile() VgpuProfileEnum` +`func (o *ExperienceBulkUpdate) GetVgpuProfile() string` GetVgpuProfile returns the VgpuProfile field if non-nil, zero value otherwise. ### GetVgpuProfileOk -`func (o *ExperienceBulkUpdate) GetVgpuProfileOk() (*VgpuProfileEnum, bool)` +`func (o *ExperienceBulkUpdate) GetVgpuProfileOk() (*string, bool)` GetVgpuProfileOk returns a tuple with the VgpuProfile field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetVgpuProfile -`func (o *ExperienceBulkUpdate) SetVgpuProfile(v VgpuProfileEnum)` +`func (o *ExperienceBulkUpdate) SetVgpuProfile(v string)` SetVgpuProfile sets VgpuProfile field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/ExperienceNoteExperience.md b/v1/providers/launchpad/gen/launchpad/docs/ExperienceNoteExperience.md index b8f25f4..f721960 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/ExperienceNoteExperience.md +++ b/v1/providers/launchpad/gen/launchpad/docs/ExperienceNoteExperience.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **ExperienceBranch** | Pointer to **string** | Experience branch name used during deployment (default: origin/main) | [optional] **FcPlatform** | Pointer to [**FcPlatformEnum**](FcPlatformEnum.md) | | [optional] **FcSupport** | Pointer to **bool** | Does the experience support Flight Control? | [optional] +**Featured** | **bool** | Is the experience featured in the catalog? | [readonly] **GarageId** | Pointer to **string** | ID of the garage where nodes for this experience should be selected from | [optional] **GcBranch** | Pointer to **string** | Ground Control branch name (default: main) | [optional] **GpuCount** | Pointer to **int32** | Number of GPUs used | [optional] @@ -27,9 +28,10 @@ Name | Type | Description | Notes **Lifetime** | Pointer to **int32** | Default number of days a provisioned experience should remain active (default: 3). A null lifetime will cause a deployment to remain active indefinitely. | [optional] **Modified** | **time.Time** | Timestamp of when the object was last modified | [readonly] **NodeCount** | Pointer to **int32** | Number of Nodes used | [optional] +**Oem** | Pointer to **string** | If set, the experience must be provisioned to hardware manufactured by the given OEM | [optional] **Persona** | **string** | | **Pipeline** | **int64** | Pipeline ID used for provisioning | -**Platform** | [**PlatformEnum**](PlatformEnum.md) | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | +**Platform** | [**PlatformEnum**](PlatformEnum.md) | Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 | **Provider** | Pointer to **string** | If set, the experience must be provisioned to the given provider | [optional] **Published** | Pointer to [**PublishedEnum**](PublishedEnum.md) | Is the experience published for use? * `draft` - draft * `no` - no * `yes` - yes | [optional] **Repo** | Pointer to **string** | URL of the repository for provisioning automation | [optional] @@ -38,13 +40,13 @@ Name | Type | Description | Notes **SaLab** | Pointer to **bool** | Is this a persistent experience for SAs? | [optional] **SystemArch** | [**SystemArchEnum**](SystemArchEnum.md) | Required CPU architecture * `amd64` - amd64 * `arm64` - arm64 | **Title** | **string** | | -**VgpuProfile** | Pointer to [**VgpuProfileEnum**](VgpuProfileEnum.md) | | [optional] +**VgpuProfile** | Pointer to **string** | | [optional] ## Methods ### NewExperienceNoteExperience -`func NewExperienceNoteExperience(catalogId string, category CategoryEnum, created time.Time, experience string, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, ) *ExperienceNoteExperience` +`func NewExperienceNoteExperience(catalogId string, category CategoryEnum, created time.Time, experience string, featured bool, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, ) *ExperienceNoteExperience` NewExperienceNoteExperience instantiates a new ExperienceNoteExperience object This constructor will assign default values to properties that have it defined, @@ -389,6 +391,26 @@ SetFcSupport sets FcSupport field to given value. HasFcSupport returns a boolean if a field has been set. +### GetFeatured + +`func (o *ExperienceNoteExperience) GetFeatured() bool` + +GetFeatured returns the Featured field if non-nil, zero value otherwise. + +### GetFeaturedOk + +`func (o *ExperienceNoteExperience) GetFeaturedOk() (*bool, bool)` + +GetFeaturedOk returns a tuple with the Featured field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatured + +`func (o *ExperienceNoteExperience) SetFeatured(v bool)` + +SetFeatured sets Featured field to given value. + + ### GetGarageId `func (o *ExperienceNoteExperience) GetGarageId() string` @@ -599,6 +621,31 @@ SetNodeCount sets NodeCount field to given value. HasNodeCount returns a boolean if a field has been set. +### GetOem + +`func (o *ExperienceNoteExperience) GetOem() string` + +GetOem returns the Oem field if non-nil, zero value otherwise. + +### GetOemOk + +`func (o *ExperienceNoteExperience) GetOemOk() (*string, bool)` + +GetOemOk returns a tuple with the Oem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOem + +`func (o *ExperienceNoteExperience) SetOem(v string)` + +SetOem sets Oem field to given value. + +### HasOem + +`func (o *ExperienceNoteExperience) HasOem() bool` + +HasOem returns a boolean if a field has been set. + ### GetPersona `func (o *ExperienceNoteExperience) GetPersona() string` @@ -851,20 +898,20 @@ SetTitle sets Title field to given value. ### GetVgpuProfile -`func (o *ExperienceNoteExperience) GetVgpuProfile() VgpuProfileEnum` +`func (o *ExperienceNoteExperience) GetVgpuProfile() string` GetVgpuProfile returns the VgpuProfile field if non-nil, zero value otherwise. ### GetVgpuProfileOk -`func (o *ExperienceNoteExperience) GetVgpuProfileOk() (*VgpuProfileEnum, bool)` +`func (o *ExperienceNoteExperience) GetVgpuProfileOk() (*string, bool)` GetVgpuProfileOk returns a tuple with the VgpuProfile field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetVgpuProfile -`func (o *ExperienceNoteExperience) SetVgpuProfile(v VgpuProfileEnum)` +`func (o *ExperienceNoteExperience) SetVgpuProfile(v string)` SetVgpuProfile sets VgpuProfile field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/IdentityProfileAPI.md b/v1/providers/launchpad/gen/launchpad/docs/IdentityProfileAPI.md index 657dc60..61f498b 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/IdentityProfileAPI.md +++ b/v1/providers/launchpad/gen/launchpad/docs/IdentityProfileAPI.md @@ -29,7 +29,7 @@ import ( ) func main() { - profile := *openapiclient.NewProfile(time.Now(), []string{"Groups_example"}, "Id_example", time.Now(), "Username_example") // Profile | + profile := *openapiclient.NewProfile(time.Now(), "DisplayName_example", []string{"Groups_example"}, "Id_example", time.Now(), "Username_example") // Profile | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) diff --git a/v1/providers/launchpad/gen/launchpad/docs/Instance.md b/v1/providers/launchpad/gen/launchpad/docs/Instance.md index 5508519..d5f43f8 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/Instance.md +++ b/v1/providers/launchpad/gen/launchpad/docs/Instance.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Cluster** | [**DeploymentCluster**](DeploymentCluster.md) | | +**Cluster** | [**ClusterPipelineCluster**](ClusterPipelineCluster.md) | | **Created** | **time.Time** | Timestamp of when the object was created | [readonly] **Id** | **string** | | [readonly] **InstanceId** | **string** | Unique ID for this instance assigned by its provider | @@ -18,7 +18,7 @@ Name | Type | Description | Notes ### NewInstance -`func NewInstance(cluster DeploymentCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, ) *Instance` +`func NewInstance(cluster ClusterPipelineCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, ) *Instance` NewInstance instantiates a new Instance object This constructor will assign default values to properties that have it defined, @@ -35,20 +35,20 @@ but it doesn't guarantee that properties required by API are set ### GetCluster -`func (o *Instance) GetCluster() DeploymentCluster` +`func (o *Instance) GetCluster() ClusterPipelineCluster` GetCluster returns the Cluster field if non-nil, zero value otherwise. ### GetClusterOk -`func (o *Instance) GetClusterOk() (*DeploymentCluster, bool)` +`func (o *Instance) GetClusterOk() (*ClusterPipelineCluster, bool)` GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetCluster -`func (o *Instance) SetCluster(v DeploymentCluster)` +`func (o *Instance) SetCluster(v ClusterPipelineCluster)` SetCluster sets Cluster field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/InstanceBulkUpdate.md b/v1/providers/launchpad/gen/launchpad/docs/InstanceBulkUpdate.md index b579cb1..fcbe270 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/InstanceBulkUpdate.md +++ b/v1/providers/launchpad/gen/launchpad/docs/InstanceBulkUpdate.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Cluster** | [**DeploymentCluster**](DeploymentCluster.md) | | +**Cluster** | [**ClusterPipelineCluster**](ClusterPipelineCluster.md) | | **Created** | **time.Time** | Timestamp of when the object was created | [readonly] **Id** | **string** | | [readonly] **InstanceId** | **string** | Unique ID for this instance assigned by its provider | [readonly] @@ -21,7 +21,7 @@ Name | Type | Description | Notes ### NewInstanceBulkUpdate -`func NewInstanceBulkUpdate(cluster DeploymentCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, count int32, ids []string, result string, ) *InstanceBulkUpdate` +`func NewInstanceBulkUpdate(cluster ClusterPipelineCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, count int32, ids []string, result string, ) *InstanceBulkUpdate` NewInstanceBulkUpdate instantiates a new InstanceBulkUpdate object This constructor will assign default values to properties that have it defined, @@ -38,20 +38,20 @@ but it doesn't guarantee that properties required by API are set ### GetCluster -`func (o *InstanceBulkUpdate) GetCluster() DeploymentCluster` +`func (o *InstanceBulkUpdate) GetCluster() ClusterPipelineCluster` GetCluster returns the Cluster field if non-nil, zero value otherwise. ### GetClusterOk -`func (o *InstanceBulkUpdate) GetClusterOk() (*DeploymentCluster, bool)` +`func (o *InstanceBulkUpdate) GetClusterOk() (*ClusterPipelineCluster, bool)` GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### SetCluster -`func (o *InstanceBulkUpdate) SetCluster(v DeploymentCluster)` +`func (o *InstanceBulkUpdate) SetCluster(v ClusterPipelineCluster)` SetCluster sets Cluster field to given value. diff --git a/v1/providers/launchpad/gen/launchpad/docs/InventoryClustersAPI.md b/v1/providers/launchpad/gen/launchpad/docs/InventoryClustersAPI.md index 1653521..d196d98 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/InventoryClustersAPI.md +++ b/v1/providers/launchpad/gen/launchpad/docs/InventoryClustersAPI.md @@ -10,6 +10,7 @@ Method | HTTP request | Description [**V1InventoryClustersHistoryList**](InventoryClustersAPI.md#V1InventoryClustersHistoryList) | **Get** /v1/inventory/clusters/{id}/history/ | [**V1InventoryClustersList**](InventoryClustersAPI.md#V1InventoryClustersList) | **Get** /v1/inventory/clusters/ | [**V1InventoryClustersPartialUpdate**](InventoryClustersAPI.md#V1InventoryClustersPartialUpdate) | **Patch** /v1/inventory/clusters/{id}/ | +[**V1InventoryClustersPipelinesList**](InventoryClustersAPI.md#V1InventoryClustersPipelinesList) | **Get** /v1/inventory/clusters/{cluster_id}/pipelines/ | [**V1InventoryClustersPipelinesTriggerCreate**](InventoryClustersAPI.md#V1InventoryClustersPipelinesTriggerCreate) | **Post** /v1/inventory/clusters/{id}/pipelines/trigger/ | [**V1InventoryClustersProvisionCreate**](InventoryClustersAPI.md#V1InventoryClustersProvisionCreate) | **Post** /v1/inventory/clusters/provision/ | [**V1InventoryClustersProvisionDestroy**](InventoryClustersAPI.md#V1InventoryClustersProvisionDestroy) | **Delete** /v1/inventory/clusters/{id}/provision/ | @@ -42,7 +43,7 @@ import ( ) func main() { - clusterBulkUpdate := *openapiclient.NewClusterBulkUpdate(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "GpuAlias_example", int32(123), "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: }, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: }}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), int32(123), false, "PublicAddress_example", "RequestId_example", []string{"TenantIds_example"}, int32(123), []string{"Ids_example"}, "Result_example") // ClusterBulkUpdate | + clusterBulkUpdate := *openapiclient.NewClusterBulkUpdate(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "GpuAlias_example", int32(123), "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: }, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: }}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), int32(123), false, "PublicAddress_example", "RequestId_example", []string{"TenantIds_example"}, int32(123), []string{"Ids_example"}, "Result_example") // ClusterBulkUpdate | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -107,7 +108,7 @@ import ( ) func main() { - cluster := *openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"}) // Cluster | (optional) + cluster := *openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"}) // Cluster | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -292,7 +293,7 @@ Name | Type | Description | Notes ## V1InventoryClustersList -> PaginatedClusterList V1InventoryClustersList(ctx).Available(available).BastionName(bastionName).Deployment(deployment).Enabled(enabled).Expand(expand).Experience(experience).Fields(fields).GarageId(garageId).Gpu(gpu).GpuAlias(gpuAlias).GpuCount(gpuCount).GpuModel(gpuModel).HasDeployment(hasDeployment).HasRequestId(hasRequestId).HasWorkshopId(hasWorkshopId).Id(id).Location(location).LocationName(locationName).LocationRegion(locationRegion).Maintenance(maintenance).MgmtIp(mgmtIp).MgmtMac(mgmtMac).MinGpuCount(minGpuCount).MinNodeCount(minNodeCount).MinProvisioningAttempts(minProvisioningAttempts).MinTenantCount(minTenantCount).Netmask(netmask).NodeCount(nodeCount).Oem(oem).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persist(persist).Provider(provider).ProviderCapacity(providerCapacity).ProviderName(providerName).ProviderNodeId(providerNodeId).ProvisionUser(provisionUser).ProvisioningAttempts(provisioningAttempts).ProvisioningState(provisioningState).PublicAddress(publicAddress).Rack(rack).RequestId(requestId).Reservation(reservation).Search(search).SystemArch(systemArch).VlanId(vlanId).Workshop(workshop).WorkshopId(workshopId).WorkshopIdNot(workshopIdNot).Execute() +> PaginatedClusterList V1InventoryClustersList(ctx).Available(available).BastionName(bastionName).Deployment(deployment).Enabled(enabled).Expand(expand).Experience(experience).Fields(fields).GarageId(garageId).Gpu(gpu).GpuAlias(gpuAlias).GpuCount(gpuCount).GpuModel(gpuModel).HasDeployment(hasDeployment).HasRequestId(hasRequestId).HasWorkshopId(hasWorkshopId).Id(id).Location(location).LocationName(locationName).LocationRegion(locationRegion).Maintenance(maintenance).MgmtIp(mgmtIp).MgmtMac(mgmtMac).MinGpuCount(minGpuCount).MinNodeCount(minNodeCount).MinProvisioningAttempts(minProvisioningAttempts).MinTenantCount(minTenantCount).Netmask(netmask).NodeCount(nodeCount).Oem(oem).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persist(persist).Provider(provider).ProviderCapacity(providerCapacity).ProviderName(providerName).ProviderNodeId(providerNodeId).ProvisionUser(provisionUser).ProvisioningAttempts(provisioningAttempts).ProvisioningState(provisioningState).ProvisioningStateNot(provisioningStateNot).PublicAddress(publicAddress).Rack(rack).RequestId(requestId).Reservation(reservation).Search(search).SystemArch(systemArch).VlanId(vlanId).Workshop(workshop).WorkshopId(workshopId).WorkshopIdNot(workshopIdNot).Execute() @@ -350,6 +351,7 @@ func main() { provisionUser := "provisionUser_example" // string | (optional) provisioningAttempts := int32(56) // int32 | (optional) provisioningState := []string{"ProvisioningState_example"} // []string | Multiple values may be separated by commas. * `deployed` - Cluster is in use by a deployment * `deploying` - Provisioning is in progress * `destroying` - Cluster is being destroyed * `pending` - Provisioning will begin soon * `ready` - Provisioning has completed and is ready for a deployment * `reserved` - Cluster is unprovisioned but reserved for later use * `unprovisioned` - Cluster has not yet been provisioned (optional) + provisioningStateNot := []string{"ProvisioningStateNot_example"} // []string | Multiple values may be separated by commas. * `deployed` - Cluster is in use by a deployment * `deploying` - Provisioning is in progress * `destroying` - Cluster is being destroyed * `pending` - Provisioning will begin soon * `ready` - Provisioning has completed and is ready for a deployment * `reserved` - Cluster is unprovisioned but reserved for later use * `unprovisioned` - Cluster has not yet been provisioned (optional) publicAddress := "publicAddress_example" // string | (optional) rack := "rack_example" // string | Only include clusters whose nodes are in the given rack (optional) requestId := "requestId_example" // string | (optional) @@ -363,7 +365,7 @@ func main() { configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.InventoryClustersAPI.V1InventoryClustersList(context.Background()).Available(available).BastionName(bastionName).Deployment(deployment).Enabled(enabled).Expand(expand).Experience(experience).Fields(fields).GarageId(garageId).Gpu(gpu).GpuAlias(gpuAlias).GpuCount(gpuCount).GpuModel(gpuModel).HasDeployment(hasDeployment).HasRequestId(hasRequestId).HasWorkshopId(hasWorkshopId).Id(id).Location(location).LocationName(locationName).LocationRegion(locationRegion).Maintenance(maintenance).MgmtIp(mgmtIp).MgmtMac(mgmtMac).MinGpuCount(minGpuCount).MinNodeCount(minNodeCount).MinProvisioningAttempts(minProvisioningAttempts).MinTenantCount(minTenantCount).Netmask(netmask).NodeCount(nodeCount).Oem(oem).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persist(persist).Provider(provider).ProviderCapacity(providerCapacity).ProviderName(providerName).ProviderNodeId(providerNodeId).ProvisionUser(provisionUser).ProvisioningAttempts(provisioningAttempts).ProvisioningState(provisioningState).PublicAddress(publicAddress).Rack(rack).RequestId(requestId).Reservation(reservation).Search(search).SystemArch(systemArch).VlanId(vlanId).Workshop(workshop).WorkshopId(workshopId).WorkshopIdNot(workshopIdNot).Execute() + resp, r, err := apiClient.InventoryClustersAPI.V1InventoryClustersList(context.Background()).Available(available).BastionName(bastionName).Deployment(deployment).Enabled(enabled).Expand(expand).Experience(experience).Fields(fields).GarageId(garageId).Gpu(gpu).GpuAlias(gpuAlias).GpuCount(gpuCount).GpuModel(gpuModel).HasDeployment(hasDeployment).HasRequestId(hasRequestId).HasWorkshopId(hasWorkshopId).Id(id).Location(location).LocationName(locationName).LocationRegion(locationRegion).Maintenance(maintenance).MgmtIp(mgmtIp).MgmtMac(mgmtMac).MinGpuCount(minGpuCount).MinNodeCount(minNodeCount).MinProvisioningAttempts(minProvisioningAttempts).MinTenantCount(minTenantCount).Netmask(netmask).NodeCount(nodeCount).Oem(oem).Omit(omit).Ordering(ordering).Page(page).PageSize(pageSize).Persist(persist).Provider(provider).ProviderCapacity(providerCapacity).ProviderName(providerName).ProviderNodeId(providerNodeId).ProvisionUser(provisionUser).ProvisioningAttempts(provisioningAttempts).ProvisioningState(provisioningState).ProvisioningStateNot(provisioningStateNot).PublicAddress(publicAddress).Rack(rack).RequestId(requestId).Reservation(reservation).Search(search).SystemArch(systemArch).VlanId(vlanId).Workshop(workshop).WorkshopId(workshopId).WorkshopIdNot(workshopIdNot).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `InventoryClustersAPI.V1InventoryClustersList``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -425,6 +427,7 @@ Name | Type | Description | Notes **provisionUser** | **string** | | **provisioningAttempts** | **int32** | | **provisioningState** | **[]string** | Multiple values may be separated by commas. * `deployed` - Cluster is in use by a deployment * `deploying` - Provisioning is in progress * `destroying` - Cluster is being destroyed * `pending` - Provisioning will begin soon * `ready` - Provisioning has completed and is ready for a deployment * `reserved` - Cluster is unprovisioned but reserved for later use * `unprovisioned` - Cluster has not yet been provisioned | + **provisioningStateNot** | **[]string** | Multiple values may be separated by commas. * `deployed` - Cluster is in use by a deployment * `deploying` - Provisioning is in progress * `destroying` - Cluster is being destroyed * `pending` - Provisioning will begin soon * `ready` - Provisioning has completed and is ready for a deployment * `reserved` - Cluster is unprovisioned but reserved for later use * `unprovisioned` - Cluster has not yet been provisioned | **publicAddress** | **string** | | **rack** | **string** | Only include clusters whose nodes are in the given rack | **requestId** | **string** | | @@ -475,7 +478,7 @@ import ( func main() { id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this cluster. - cluster := *openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"}) // Cluster | (optional) + cluster := *openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"}) // Cluster | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -525,6 +528,90 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## V1InventoryClustersPipelinesList + +> PaginatedClusterPipelineList V1InventoryClustersPipelinesList(ctx, clusterId).Action(action).Id(id).Ordering(ordering).Page(page).PageSize(pageSize).PipelineId(pipelineId).RequestId(requestId).Search(search).Execute() + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/brevdev/cloud" +) + +func main() { + clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | + action := "action_example" // string | Action for the pipeline to run * `apply` - apply * `destroy` - destroy * `notify` - notify (optional) + id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional) + ordering := "ordering_example" // string | Which field to use when ordering the results. (optional) + page := int32(56) // int32 | A page number within the paginated result set. (optional) + pageSize := int32(56) // int32 | Number of results to return per page. (optional) + pipelineId := int32(56) // int32 | (optional) + requestId := "requestId_example" // string | (optional) + search := "search_example" // string | Search for cluster-pipelines by action, id, pipeline_id, request_id, url (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.InventoryClustersAPI.V1InventoryClustersPipelinesList(context.Background(), clusterId).Action(action).Id(id).Ordering(ordering).Page(page).PageSize(pageSize).PipelineId(pipelineId).RequestId(requestId).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `InventoryClustersAPI.V1InventoryClustersPipelinesList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `V1InventoryClustersPipelinesList`: PaginatedClusterPipelineList + fmt.Fprintf(os.Stdout, "Response from `InventoryClustersAPI.V1InventoryClustersPipelinesList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**clusterId** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiV1InventoryClustersPipelinesListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **action** | **string** | Action for the pipeline to run * `apply` - apply * `destroy` - destroy * `notify` - notify | + **id** | **string** | | + **ordering** | **string** | Which field to use when ordering the results. | + **page** | **int32** | A page number within the paginated result set. | + **pageSize** | **int32** | Number of results to return per page. | + **pipelineId** | **int32** | | + **requestId** | **string** | | + **search** | **string** | Search for cluster-pipelines by action, id, pipeline_id, request_id, url | + +### Return type + +[**PaginatedClusterPipelineList**](PaginatedClusterPipelineList.md) + +### Authorization + +[TokenAuthentication](../README.md#TokenAuthentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## V1InventoryClustersPipelinesTriggerCreate > ClusterPipelineTrigger V1InventoryClustersPipelinesTriggerCreate(ctx, id).ClusterPipelineTrigger(clusterPipelineTrigger).Execute() @@ -598,7 +685,7 @@ Name | Type | Description | Notes ## V1InventoryClustersProvisionCreate -> ProvisioningRequest V1InventoryClustersProvisionCreate(ctx).ProvisioningRequest(provisioningRequest).Expand(expand).Execute() +> ClusterProvisionCreateResponse V1InventoryClustersProvisionCreate(ctx).ProvisioningRequest(provisioningRequest).Expand(expand).Execute() @@ -625,7 +712,7 @@ func main() { fmt.Fprintf(os.Stderr, "Error when calling `InventoryClustersAPI.V1InventoryClustersProvisionCreate``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `V1InventoryClustersProvisionCreate`: ProvisioningRequest + // response from `V1InventoryClustersProvisionCreate`: ClusterProvisionCreateResponse fmt.Fprintf(os.Stdout, "Response from `InventoryClustersAPI.V1InventoryClustersProvisionCreate`: %v\n", resp) } ``` @@ -646,7 +733,7 @@ Name | Type | Description | Notes ### Return type -[**ProvisioningRequest**](ProvisioningRequest.md) +[**ClusterProvisionCreateResponse**](ClusterProvisionCreateResponse.md) ### Authorization @@ -1093,7 +1180,7 @@ import ( func main() { id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this cluster. - cluster := *openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"}) // Cluster | (optional) + cluster := *openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"}) // Cluster | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) diff --git a/v1/providers/launchpad/gen/launchpad/docs/InventoryInstancesAPI.md b/v1/providers/launchpad/gen/launchpad/docs/InventoryInstancesAPI.md index e648175..27341f4 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/InventoryInstancesAPI.md +++ b/v1/providers/launchpad/gen/launchpad/docs/InventoryInstancesAPI.md @@ -35,7 +35,7 @@ import ( ) func main() { - instanceBulkUpdate := *openapiclient.NewInstanceBulkUpdate(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now(), int32(123), []string{"Ids_example"}, "Result_example") // InstanceBulkUpdate | + instanceBulkUpdate := *openapiclient.NewInstanceBulkUpdate(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: }, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now(), int32(123), []string{"Ids_example"}, "Result_example") // InstanceBulkUpdate | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -100,7 +100,7 @@ import ( ) func main() { - instance := *openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now()) // Instance | + instance := *openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now()) // Instance | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -390,7 +390,7 @@ import ( func main() { id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this instance. - instance := *openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now()) // Instance | + instance := *openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now()) // Instance | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -535,7 +535,7 @@ import ( func main() { id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this instance. - instance := *openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.Deployment_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now()) // Instance | + instance := *openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: openapiclient.NewInstance(openapiclient.ClusterPipeline_cluster{Cluster: openapiclient.NewCluster(false, time.Now(), openapiclient.Cluster_deployment{Deployment: openapiclient.NewDeployment(time.Now(), "Id_example", time.Now(), "OrgName_example", *openapiclient.NewOverrides(), []string{"Pipelines_example"}, "RequesterEmail_example", "RequesterName_example", int32(123), []string{"Services_example"}, int32(123), "SshUser_example", openapiclient.DeploymentState("destroyed"))}, []openapiclient.ClusterGpusInner{openapiclient.Cluster_gpus_inner{Gpu: openapiclient.NewGpu(time.Now(), "Id_example", "Model_example", time.Now())}}, "Id_example", []openapiclient.ClusterInstancesInner{openapiclient.Cluster_instances_inner{Instance: }}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now())}}, time.Now(), time.Now(), time.Now(), false, []string{"TenantIds_example"})}, time.Now(), "Id_example", "InstanceId_example", time.Now(), time.Now()) // Instance | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) diff --git a/v1/providers/launchpad/gen/launchpad/docs/PaginatedClusterPipelineList.md b/v1/providers/launchpad/gen/launchpad/docs/PaginatedClusterPipelineList.md new file mode 100644 index 0000000..812746d --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/docs/PaginatedClusterPipelineList.md @@ -0,0 +1,124 @@ +# PaginatedClusterPipelineList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **int32** | | +**Next** | Pointer to **string** | | [optional] +**Previous** | Pointer to **string** | | [optional] +**Results** | [**[]ClusterPipeline**](ClusterPipeline.md) | | + +## Methods + +### NewPaginatedClusterPipelineList + +`func NewPaginatedClusterPipelineList(count int32, results []ClusterPipeline, ) *PaginatedClusterPipelineList` + +NewPaginatedClusterPipelineList instantiates a new PaginatedClusterPipelineList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedClusterPipelineListWithDefaults + +`func NewPaginatedClusterPipelineListWithDefaults() *PaginatedClusterPipelineList` + +NewPaginatedClusterPipelineListWithDefaults instantiates a new PaginatedClusterPipelineList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCount + +`func (o *PaginatedClusterPipelineList) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *PaginatedClusterPipelineList) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *PaginatedClusterPipelineList) SetCount(v int32)` + +SetCount sets Count field to given value. + + +### GetNext + +`func (o *PaginatedClusterPipelineList) GetNext() string` + +GetNext returns the Next field if non-nil, zero value otherwise. + +### GetNextOk + +`func (o *PaginatedClusterPipelineList) GetNextOk() (*string, bool)` + +GetNextOk returns a tuple with the Next field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNext + +`func (o *PaginatedClusterPipelineList) SetNext(v string)` + +SetNext sets Next field to given value. + +### HasNext + +`func (o *PaginatedClusterPipelineList) HasNext() bool` + +HasNext returns a boolean if a field has been set. + +### GetPrevious + +`func (o *PaginatedClusterPipelineList) GetPrevious() string` + +GetPrevious returns the Previous field if non-nil, zero value otherwise. + +### GetPreviousOk + +`func (o *PaginatedClusterPipelineList) GetPreviousOk() (*string, bool)` + +GetPreviousOk returns a tuple with the Previous field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrevious + +`func (o *PaginatedClusterPipelineList) SetPrevious(v string)` + +SetPrevious sets Previous field to given value. + +### HasPrevious + +`func (o *PaginatedClusterPipelineList) HasPrevious() bool` + +HasPrevious returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedClusterPipelineList) GetResults() []ClusterPipeline` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedClusterPipelineList) GetResultsOk() (*[]ClusterPipeline, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedClusterPipelineList) SetResults(v []ClusterPipeline)` + +SetResults sets Results field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/providers/launchpad/gen/launchpad/docs/PaginatedVGpuProfileChoiceList.md b/v1/providers/launchpad/gen/launchpad/docs/PaginatedVGpuProfileChoiceList.md new file mode 100644 index 0000000..789f5dd --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/docs/PaginatedVGpuProfileChoiceList.md @@ -0,0 +1,124 @@ +# PaginatedVGpuProfileChoiceList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **int32** | | +**Next** | Pointer to **string** | | [optional] +**Previous** | Pointer to **string** | | [optional] +**Results** | [**[]VGpuProfileChoice**](VGpuProfileChoice.md) | | + +## Methods + +### NewPaginatedVGpuProfileChoiceList + +`func NewPaginatedVGpuProfileChoiceList(count int32, results []VGpuProfileChoice, ) *PaginatedVGpuProfileChoiceList` + +NewPaginatedVGpuProfileChoiceList instantiates a new PaginatedVGpuProfileChoiceList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedVGpuProfileChoiceListWithDefaults + +`func NewPaginatedVGpuProfileChoiceListWithDefaults() *PaginatedVGpuProfileChoiceList` + +NewPaginatedVGpuProfileChoiceListWithDefaults instantiates a new PaginatedVGpuProfileChoiceList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCount + +`func (o *PaginatedVGpuProfileChoiceList) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *PaginatedVGpuProfileChoiceList) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *PaginatedVGpuProfileChoiceList) SetCount(v int32)` + +SetCount sets Count field to given value. + + +### GetNext + +`func (o *PaginatedVGpuProfileChoiceList) GetNext() string` + +GetNext returns the Next field if non-nil, zero value otherwise. + +### GetNextOk + +`func (o *PaginatedVGpuProfileChoiceList) GetNextOk() (*string, bool)` + +GetNextOk returns a tuple with the Next field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNext + +`func (o *PaginatedVGpuProfileChoiceList) SetNext(v string)` + +SetNext sets Next field to given value. + +### HasNext + +`func (o *PaginatedVGpuProfileChoiceList) HasNext() bool` + +HasNext returns a boolean if a field has been set. + +### GetPrevious + +`func (o *PaginatedVGpuProfileChoiceList) GetPrevious() string` + +GetPrevious returns the Previous field if non-nil, zero value otherwise. + +### GetPreviousOk + +`func (o *PaginatedVGpuProfileChoiceList) GetPreviousOk() (*string, bool)` + +GetPreviousOk returns a tuple with the Previous field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrevious + +`func (o *PaginatedVGpuProfileChoiceList) SetPrevious(v string)` + +SetPrevious sets Previous field to given value. + +### HasPrevious + +`func (o *PaginatedVGpuProfileChoiceList) HasPrevious() bool` + +HasPrevious returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedVGpuProfileChoiceList) GetResults() []VGpuProfileChoice` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedVGpuProfileChoiceList) GetResultsOk() (*[]VGpuProfileChoice, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedVGpuProfileChoiceList) SetResults(v []VGpuProfileChoice)` + +SetResults sets Results field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/providers/launchpad/gen/launchpad/docs/PlatformEnum.md b/v1/providers/launchpad/gen/launchpad/docs/PlatformEnum.md index 7f6bf20..935b86d 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/PlatformEnum.md +++ b/v1/providers/launchpad/gen/launchpad/docs/PlatformEnum.md @@ -15,6 +15,8 @@ * `PlatformOpenshift` (value: `"openshift"`) +* `PlatformProxmox` (value: `"proxmox"`) + * `PlatformVsphere` (value: `"vsphere"`) * `PlatformVsphereHorizon` (value: `"vsphere_horizon"`) diff --git a/v1/providers/launchpad/gen/launchpad/docs/Profile.md b/v1/providers/launchpad/gen/launchpad/docs/Profile.md index abc9daa..60177ca 100644 --- a/v1/providers/launchpad/gen/launchpad/docs/Profile.md +++ b/v1/providers/launchpad/gen/launchpad/docs/Profile.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Created** | **time.Time** | Timestamp of when the object was created | [readonly] +**DisplayName** | **NullableString** | Display name of the user | [readonly] **Groups** | **[]string** | | **Id** | **string** | | [readonly] **Modified** | **time.Time** | Timestamp of when the object was last modified | [readonly] @@ -16,7 +17,7 @@ Name | Type | Description | Notes ### NewProfile -`func NewProfile(created time.Time, groups []string, id string, modified time.Time, username string, ) *Profile` +`func NewProfile(created time.Time, displayName NullableString, groups []string, id string, modified time.Time, username string, ) *Profile` NewProfile instantiates a new Profile object This constructor will assign default values to properties that have it defined, @@ -51,6 +52,36 @@ and a boolean to check if the value has been set. SetCreated sets Created field to given value. +### GetDisplayName + +`func (o *Profile) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Profile) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Profile) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### SetDisplayNameNil + +`func (o *Profile) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *Profile) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil ### GetGroups `func (o *Profile) GetGroups() []string` diff --git a/v1/providers/launchpad/gen/launchpad/docs/VGpuProfileChoice.md b/v1/providers/launchpad/gen/launchpad/docs/VGpuProfileChoice.md new file mode 100644 index 0000000..0afaea9 --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/docs/VGpuProfileChoice.md @@ -0,0 +1,114 @@ +# VGpuProfileChoice + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **time.Time** | Timestamp of when the object was created | [readonly] +**Id** | **int32** | | [readonly] +**Modified** | **time.Time** | Timestamp of when the object was last modified | [readonly] +**Name** | **string** | | + +## Methods + +### NewVGpuProfileChoice + +`func NewVGpuProfileChoice(created time.Time, id int32, modified time.Time, name string, ) *VGpuProfileChoice` + +NewVGpuProfileChoice instantiates a new VGpuProfileChoice object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVGpuProfileChoiceWithDefaults + +`func NewVGpuProfileChoiceWithDefaults() *VGpuProfileChoice` + +NewVGpuProfileChoiceWithDefaults instantiates a new VGpuProfileChoice object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *VGpuProfileChoice) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *VGpuProfileChoice) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *VGpuProfileChoice) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetId + +`func (o *VGpuProfileChoice) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VGpuProfileChoice) GetIdOk() (*int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VGpuProfileChoice) SetId(v int32)` + +SetId sets Id field to given value. + + +### GetModified + +`func (o *VGpuProfileChoice) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *VGpuProfileChoice) GetModifiedOk() (*time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *VGpuProfileChoice) SetModified(v time.Time)` + +SetModified sets Modified field to given value. + + +### GetName + +`func (o *VGpuProfileChoice) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *VGpuProfileChoice) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *VGpuProfileChoice) SetName(v string)` + +SetName sets Name field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/providers/launchpad/gen/launchpad/docs/VgpuProfileEnum.md b/v1/providers/launchpad/gen/launchpad/docs/VgpuProfileEnum.md deleted file mode 100644 index 0b966e3..0000000 --- a/v1/providers/launchpad/gen/launchpad/docs/VgpuProfileEnum.md +++ /dev/null @@ -1,35 +0,0 @@ -# VgpuProfileEnum - -## Enum - - -* `VgpuProfileAir` (value: `"air"`) - -* `VgpuProfileBrightCluster` (value: `"bright_cluster"`) - -* `VgpuProfileBrightClusterLegacy` (value: `"bright-cluster"`) - -* `VgpuProfileFlightDeck` (value: `"flight_deck"`) - -* `VgpuProfileFlightDeckLegacy` (value: `"flight-deck"`) - -* `VgpuProfileNvidiaA4048QLegacy` (value: `"nvidia_a40-48q"`) - -* `VgpuProfileNvidiaAiEnterpriseLegacy` (value: `"nvidia-ai-enterprise"`) - -* `VgpuProfileNvidiaL40s48QLegacy` (value: `"nvidia_l40s-48q"`) - -* `VgpuProfileNvidiaRtxPro6000BlackwellDc496QLegacy` (value: `"nvidia_rtx_pro_6000_blackwell_dc-4-96q"`) - -* `VgpuProfileNvidiaRtxPro6000BlackwellDc96QLegacy` (value: `"nvidia_rtx_pro_6000_blackwell_dc-96q"`) - -* `VgpuProfileOpenshift` (value: `"openshift"`) - -* `VgpuProfilePlatformOnly` (value: `"platform_only"`) - -* `VgpuProfileVmwareItadmin` (value: `"vmware_itadmin"`) - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/v1/providers/launchpad/gen/launchpad/model_auth_login.go b/v1/providers/launchpad/gen/launchpad/model_auth_login.go index d0fd429..2d086d9 100644 --- a/v1/providers/launchpad/gen/launchpad/model_auth_login.go +++ b/v1/providers/launchpad/gen/launchpad/model_auth_login.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_auth_redirect.go b/v1/providers/launchpad/gen/launchpad/model_auth_redirect.go index e8e08d2..5099791 100644 --- a/v1/providers/launchpad/gen/launchpad/model_auth_redirect.go +++ b/v1/providers/launchpad/gen/launchpad/model_auth_redirect.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_auth_token.go b/v1/providers/launchpad/gen/launchpad/model_auth_token.go index 7bee14b..b856370 100644 --- a/v1/providers/launchpad/gen/launchpad/model_auth_token.go +++ b/v1/providers/launchpad/gen/launchpad/model_auth_token.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_blank_enum.go b/v1/providers/launchpad/gen/launchpad/model_blank_enum.go index 0425de8..c5238ea 100644 --- a/v1/providers/launchpad/gen/launchpad/model_blank_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_blank_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_category_enum.go b/v1/providers/launchpad/gen/launchpad/model_category_enum.go index 406475e..bf571da 100644 --- a/v1/providers/launchpad/gen/launchpad/model_category_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_category_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster.go b/v1/providers/launchpad/gen/launchpad/model_cluster.go index 9f67d1f..a99adc1 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cluster.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -39,6 +39,8 @@ type Cluster struct { GpuCount *int32 `json:"gpu_count,omitempty"` Id string `json:"id"` Instances []ClusterInstancesInner `json:"instances"` + // Timestamp of the last time the cluster's provisioning_state changed + LastProvisioningStateChange NullableTime `json:"last_provisioning_state_change"` // Timestamp of when the cluster was last in use LastUsed NullableTime `json:"last_used"` // Is the cluster in maintenance mode? @@ -92,7 +94,7 @@ type _Cluster Cluster // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewCluster(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, id string, instances []ClusterInstancesInner, lastUsed NullableTime, modified time.Time, providerCapacity bool, tenantIds []string) *Cluster { +func NewCluster(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, id string, instances []ClusterInstancesInner, lastProvisioningStateChange NullableTime, lastUsed NullableTime, modified time.Time, providerCapacity bool, tenantIds []string) *Cluster { this := Cluster{} this.Available = available this.Created = created @@ -100,6 +102,7 @@ func NewCluster(available bool, created time.Time, deployment ClusterDeployment, this.Gpus = gpus this.Id = id this.Instances = instances + this.LastProvisioningStateChange = lastProvisioningStateChange this.LastUsed = lastUsed this.Modified = modified this.ProviderCapacity = providerCapacity @@ -484,6 +487,32 @@ func (o *Cluster) SetInstances(v []ClusterInstancesInner) { o.Instances = v } +// GetLastProvisioningStateChange returns the LastProvisioningStateChange field value +// If the value is explicit nil, the zero value for time.Time will be returned +func (o *Cluster) GetLastProvisioningStateChange() time.Time { + if o == nil || o.LastProvisioningStateChange.Get() == nil { + var ret time.Time + return ret + } + + return *o.LastProvisioningStateChange.Get() +} + +// GetLastProvisioningStateChangeOk returns a tuple with the LastProvisioningStateChange field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *Cluster) GetLastProvisioningStateChangeOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return o.LastProvisioningStateChange.Get(), o.LastProvisioningStateChange.IsSet() +} + +// SetLastProvisioningStateChange sets field value +func (o *Cluster) SetLastProvisioningStateChange(v time.Time) { + o.LastProvisioningStateChange.Set(&v) +} + // GetLastUsed returns the LastUsed field value // If the value is explicit nil, the zero value for time.Time will be returned func (o *Cluster) GetLastUsed() time.Time { @@ -1323,6 +1352,7 @@ func (o Cluster) ToMap() (map[string]interface{}, error) { } toSerialize["id"] = o.Id toSerialize["instances"] = o.Instances + toSerialize["last_provisioning_state_change"] = o.LastProvisioningStateChange.Get() toSerialize["last_used"] = o.LastUsed.Get() if !IsNil(o.Maintenance) { toSerialize["maintenance"] = o.Maintenance @@ -1403,6 +1433,7 @@ func (o *Cluster) UnmarshalJSON(data []byte) (err error) { "gpus", "id", "instances", + "last_provisioning_state_change", "last_used", "modified", "provider_capacity", @@ -1448,6 +1479,7 @@ func (o *Cluster) UnmarshalJSON(data []byte) (err error) { delete(additionalProperties, "gpu_count") delete(additionalProperties, "id") delete(additionalProperties, "instances") + delete(additionalProperties, "last_provisioning_state_change") delete(additionalProperties, "last_used") delete(additionalProperties, "maintenance") delete(additionalProperties, "mgmt_ip") diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_bulk_update.go b/v1/providers/launchpad/gen/launchpad/model_cluster_bulk_update.go index 125fb26..c496772 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cluster_bulk_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_bulk_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -39,6 +39,8 @@ type ClusterBulkUpdate struct { GpuCount int32 `json:"gpu_count"` Id string `json:"id"` Instances []ClusterInstancesInner `json:"instances"` + // Timestamp of the last time the cluster's provisioning_state changed + LastProvisioningStateChange NullableTime `json:"last_provisioning_state_change"` // Timestamp of when the cluster was last in use LastUsed NullableTime `json:"last_used"` // Is the cluster in maintenance mode? @@ -95,7 +97,7 @@ type _ClusterBulkUpdate ClusterBulkUpdate // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewClusterBulkUpdate(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, gpuAlias string, gpuCount int32, id string, instances []ClusterInstancesInner, lastUsed NullableTime, modified time.Time, nodeCount int32, providerCapacity bool, publicAddress NullableString, requestId NullableString, tenantIds []string, count int32, ids []string, result string) *ClusterBulkUpdate { +func NewClusterBulkUpdate(available bool, created time.Time, deployment ClusterDeployment, gpus []ClusterGpusInner, gpuAlias string, gpuCount int32, id string, instances []ClusterInstancesInner, lastProvisioningStateChange NullableTime, lastUsed NullableTime, modified time.Time, nodeCount int32, providerCapacity bool, publicAddress NullableString, requestId NullableString, tenantIds []string, count int32, ids []string, result string) *ClusterBulkUpdate { this := ClusterBulkUpdate{} this.Available = available this.Created = created @@ -105,6 +107,7 @@ func NewClusterBulkUpdate(available bool, created time.Time, deployment ClusterD this.GpuCount = gpuCount this.Id = id this.Instances = instances + this.LastProvisioningStateChange = lastProvisioningStateChange this.LastUsed = lastUsed this.Modified = modified this.NodeCount = nodeCount @@ -479,6 +482,32 @@ func (o *ClusterBulkUpdate) SetInstances(v []ClusterInstancesInner) { o.Instances = v } +// GetLastProvisioningStateChange returns the LastProvisioningStateChange field value +// If the value is explicit nil, the zero value for time.Time will be returned +func (o *ClusterBulkUpdate) GetLastProvisioningStateChange() time.Time { + if o == nil || o.LastProvisioningStateChange.Get() == nil { + var ret time.Time + return ret + } + + return *o.LastProvisioningStateChange.Get() +} + +// GetLastProvisioningStateChangeOk returns a tuple with the LastProvisioningStateChange field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ClusterBulkUpdate) GetLastProvisioningStateChangeOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return o.LastProvisioningStateChange.Get(), o.LastProvisioningStateChange.IsSet() +} + +// SetLastProvisioningStateChange sets field value +func (o *ClusterBulkUpdate) SetLastProvisioningStateChange(v time.Time) { + o.LastProvisioningStateChange.Set(&v) +} + // GetLastUsed returns the LastUsed field value // If the value is explicit nil, the zero value for time.Time will be returned func (o *ClusterBulkUpdate) GetLastUsed() time.Time { @@ -1344,6 +1373,7 @@ func (o ClusterBulkUpdate) ToMap() (map[string]interface{}, error) { toSerialize["gpu_count"] = o.GpuCount toSerialize["id"] = o.Id toSerialize["instances"] = o.Instances + toSerialize["last_provisioning_state_change"] = o.LastProvisioningStateChange.Get() toSerialize["last_used"] = o.LastUsed.Get() if !IsNil(o.Maintenance) { toSerialize["maintenance"] = o.Maintenance @@ -1423,6 +1453,7 @@ func (o *ClusterBulkUpdate) UnmarshalJSON(data []byte) (err error) { "gpu_count", "id", "instances", + "last_provisioning_state_change", "last_used", "modified", "node_count", @@ -1474,6 +1505,7 @@ func (o *ClusterBulkUpdate) UnmarshalJSON(data []byte) (err error) { delete(additionalProperties, "gpu_count") delete(additionalProperties, "id") delete(additionalProperties, "instances") + delete(additionalProperties, "last_provisioning_state_change") delete(additionalProperties, "last_used") delete(additionalProperties, "maintenance") delete(additionalProperties, "mgmt_ip") diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_deployment.go b/v1/providers/launchpad/gen/launchpad/model_cluster_deployment.go index 2759049..ed097d7 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cluster_deployment.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_deployment.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_gpus_inner.go b/v1/providers/launchpad/gen/launchpad/model_cluster_gpus_inner.go index acef226..271bc78 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cluster_gpus_inner.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_gpus_inner.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_instances_inner.go b/v1/providers/launchpad/gen/launchpad/model_cluster_instances_inner.go index d8a0ec3..3142180 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cluster_instances_inner.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_instances_inner.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_nodes_inner.go b/v1/providers/launchpad/gen/launchpad/model_cluster_nodes_inner.go index 7cf767e..da70c9b 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cluster_nodes_inner.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_nodes_inner.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline.go b/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline.go new file mode 100644 index 0000000..0a34afd --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline.go @@ -0,0 +1,376 @@ +/* +NVIDIA LaunchPad API + +RESTful API for interacting with the NVIDIA LaunchPad platform + +API version: 2.40.9 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package openapi + +import ( + "encoding/json" + "fmt" + "time" +) + +// checks if the ClusterPipeline type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ClusterPipeline{} + +// ClusterPipeline struct for ClusterPipeline +type ClusterPipeline struct { + // Action for the pipeline to run * `apply` - apply * `destroy` - destroy * `notify` - notify + Action PipelineAction `json:"action"` + Cluster ClusterPipelineCluster `json:"cluster"` + // Timestamp of when the object was created + Created time.Time `json:"created"` + Id string `json:"id"` + // Timestamp of when the object was last modified + Modified time.Time `json:"modified"` + // GitLab pipeline ID + PipelineId int32 `json:"pipeline_id"` + // Request ID that the pipeline was triggered for + RequestId string `json:"request_id"` + // URL for the pipeline details + Url string `json:"url"` + AdditionalProperties map[string]interface{} +} + +type _ClusterPipeline ClusterPipeline + +// NewClusterPipeline instantiates a new ClusterPipeline object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewClusterPipeline(action PipelineAction, cluster ClusterPipelineCluster, created time.Time, id string, modified time.Time, pipelineId int32, requestId string, url string) *ClusterPipeline { + this := ClusterPipeline{} + this.Action = action + this.Cluster = cluster + this.Created = created + this.Id = id + this.Modified = modified + this.PipelineId = pipelineId + this.RequestId = requestId + this.Url = url + return &this +} + +// NewClusterPipelineWithDefaults instantiates a new ClusterPipeline object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewClusterPipelineWithDefaults() *ClusterPipeline { + this := ClusterPipeline{} + return &this +} + +// GetAction returns the Action field value +func (o *ClusterPipeline) GetAction() PipelineAction { + if o == nil { + var ret PipelineAction + return ret + } + + return o.Action +} + +// GetActionOk returns a tuple with the Action field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetActionOk() (*PipelineAction, bool) { + if o == nil { + return nil, false + } + return &o.Action, true +} + +// SetAction sets field value +func (o *ClusterPipeline) SetAction(v PipelineAction) { + o.Action = v +} + +// GetCluster returns the Cluster field value +func (o *ClusterPipeline) GetCluster() ClusterPipelineCluster { + if o == nil { + var ret ClusterPipelineCluster + return ret + } + + return o.Cluster +} + +// GetClusterOk returns a tuple with the Cluster field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetClusterOk() (*ClusterPipelineCluster, bool) { + if o == nil { + return nil, false + } + return &o.Cluster, true +} + +// SetCluster sets field value +func (o *ClusterPipeline) SetCluster(v ClusterPipelineCluster) { + o.Cluster = v +} + +// GetCreated returns the Created field value +func (o *ClusterPipeline) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// GetCreatedOk returns a tuple with the Created field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetCreatedOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.Created, true +} + +// SetCreated sets field value +func (o *ClusterPipeline) SetCreated(v time.Time) { + o.Created = v +} + +// GetId returns the Id field value +func (o *ClusterPipeline) GetId() string { + if o == nil { + var ret string + return ret + } + + return o.Id +} + +// GetIdOk returns a tuple with the Id field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Id, true +} + +// SetId sets field value +func (o *ClusterPipeline) SetId(v string) { + o.Id = v +} + +// GetModified returns the Modified field value +func (o *ClusterPipeline) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetModifiedOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.Modified, true +} + +// SetModified sets field value +func (o *ClusterPipeline) SetModified(v time.Time) { + o.Modified = v +} + +// GetPipelineId returns the PipelineId field value +func (o *ClusterPipeline) GetPipelineId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.PipelineId +} + +// GetPipelineIdOk returns a tuple with the PipelineId field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetPipelineIdOk() (*int32, bool) { + if o == nil { + return nil, false + } + return &o.PipelineId, true +} + +// SetPipelineId sets field value +func (o *ClusterPipeline) SetPipelineId(v int32) { + o.PipelineId = v +} + +// GetRequestId returns the RequestId field value +func (o *ClusterPipeline) GetRequestId() string { + if o == nil { + var ret string + return ret + } + + return o.RequestId +} + +// GetRequestIdOk returns a tuple with the RequestId field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetRequestIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.RequestId, true +} + +// SetRequestId sets field value +func (o *ClusterPipeline) SetRequestId(v string) { + o.RequestId = v +} + +// GetUrl returns the Url field value +func (o *ClusterPipeline) GetUrl() string { + if o == nil { + var ret string + return ret + } + + return o.Url +} + +// GetUrlOk returns a tuple with the Url field value +// and a boolean to check if the value has been set. +func (o *ClusterPipeline) GetUrlOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Url, true +} + +// SetUrl sets field value +func (o *ClusterPipeline) SetUrl(v string) { + o.Url = v +} + +func (o ClusterPipeline) MarshalJSON() ([]byte, error) { + toSerialize, err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ClusterPipeline) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["action"] = o.Action + toSerialize["cluster"] = o.Cluster + toSerialize["created"] = o.Created + toSerialize["id"] = o.Id + toSerialize["modified"] = o.Modified + toSerialize["pipeline_id"] = o.PipelineId + toSerialize["request_id"] = o.RequestId + toSerialize["url"] = o.Url + + for key, value := range o.AdditionalProperties { + toSerialize[key] = value + } + + return toSerialize, nil +} + +func (o *ClusterPipeline) UnmarshalJSON(data []byte) (err error) { + // This validates that all required properties are included in the JSON object + // by unmarshalling the object into a generic map with string keys and checking + // that every required field exists as a key in the generic map. + requiredProperties := []string{ + "action", + "cluster", + "created", + "id", + "modified", + "pipeline_id", + "request_id", + "url", + } + + allProperties := make(map[string]interface{}) + + err = json.Unmarshal(data, &allProperties) + + if err != nil { + return err + } + + for _, requiredProperty := range requiredProperties { + if _, exists := allProperties[requiredProperty]; !exists { + return fmt.Errorf("no value given for required property %v", requiredProperty) + } + } + + varClusterPipeline := _ClusterPipeline{} + + err = json.Unmarshal(data, &varClusterPipeline) + + if err != nil { + return err + } + + *o = ClusterPipeline(varClusterPipeline) + + additionalProperties := make(map[string]interface{}) + + if err = json.Unmarshal(data, &additionalProperties); err == nil { + delete(additionalProperties, "action") + delete(additionalProperties, "cluster") + delete(additionalProperties, "created") + delete(additionalProperties, "id") + delete(additionalProperties, "modified") + delete(additionalProperties, "pipeline_id") + delete(additionalProperties, "request_id") + delete(additionalProperties, "url") + o.AdditionalProperties = additionalProperties + } + + return err +} + +type NullableClusterPipeline struct { + value *ClusterPipeline + isSet bool +} + +func (v NullableClusterPipeline) Get() *ClusterPipeline { + return v.value +} + +func (v *NullableClusterPipeline) Set(val *ClusterPipeline) { + v.value = val + v.isSet = true +} + +func (v NullableClusterPipeline) IsSet() bool { + return v.isSet +} + +func (v *NullableClusterPipeline) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableClusterPipeline(val *ClusterPipeline) *NullableClusterPipeline { + return &NullableClusterPipeline{value: val, isSet: true} +} + +func (v NullableClusterPipeline) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableClusterPipeline) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_cluster.go b/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline_cluster.go similarity index 58% rename from v1/providers/launchpad/gen/launchpad/model_deployment_cluster.go rename to v1/providers/launchpad/gen/launchpad/model_cluster_pipeline_cluster.go index fdaba78..07c2213 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_cluster.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline_cluster.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -16,28 +16,28 @@ import ( "gopkg.in/validator.v2" ) -// DeploymentCluster - struct for DeploymentCluster -type DeploymentCluster struct { +// ClusterPipelineCluster - struct for ClusterPipelineCluster +type ClusterPipelineCluster struct { Cluster *Cluster String *string } -// ClusterAsDeploymentCluster is a convenience function that returns Cluster wrapped in DeploymentCluster -func ClusterAsDeploymentCluster(v *Cluster) DeploymentCluster { - return DeploymentCluster{ +// ClusterAsClusterPipelineCluster is a convenience function that returns Cluster wrapped in ClusterPipelineCluster +func ClusterAsClusterPipelineCluster(v *Cluster) ClusterPipelineCluster { + return ClusterPipelineCluster{ Cluster: v, } } -// stringAsDeploymentCluster is a convenience function that returns string wrapped in DeploymentCluster -func StringAsDeploymentCluster(v *string) DeploymentCluster { - return DeploymentCluster{ +// stringAsClusterPipelineCluster is a convenience function that returns string wrapped in ClusterPipelineCluster +func StringAsClusterPipelineCluster(v *string) ClusterPipelineCluster { + return ClusterPipelineCluster{ String: v, } } // Unmarshal JSON data into one of the pointers in the struct -func (dst *DeploymentCluster) UnmarshalJSON(data []byte) error { +func (dst *ClusterPipelineCluster) UnmarshalJSON(data []byte) error { var err error match := 0 // try to unmarshal data into Cluster @@ -79,16 +79,16 @@ func (dst *DeploymentCluster) UnmarshalJSON(data []byte) error { dst.Cluster = nil dst.String = nil - return fmt.Errorf("data matches more than one schema in oneOf(DeploymentCluster)") + return fmt.Errorf("data matches more than one schema in oneOf(ClusterPipelineCluster)") } else if match == 1 { return nil // exactly one match } else { // no match - return fmt.Errorf("data failed to match schemas in oneOf(DeploymentCluster)") + return fmt.Errorf("data failed to match schemas in oneOf(ClusterPipelineCluster)") } } // Marshal data from the first non-nil pointers in the struct to JSON -func (src DeploymentCluster) MarshalJSON() ([]byte, error) { +func (src ClusterPipelineCluster) MarshalJSON() ([]byte, error) { if src.Cluster != nil { return json.Marshal(&src.Cluster) } @@ -101,7 +101,7 @@ func (src DeploymentCluster) MarshalJSON() ([]byte, error) { } // Get the actual instance -func (obj *DeploymentCluster) GetActualInstance() interface{} { +func (obj *ClusterPipelineCluster) GetActualInstance() interface{} { if obj == nil { return nil } @@ -117,38 +117,38 @@ func (obj *DeploymentCluster) GetActualInstance() interface{} { return nil } -type NullableDeploymentCluster struct { - value *DeploymentCluster +type NullableClusterPipelineCluster struct { + value *ClusterPipelineCluster isSet bool } -func (v NullableDeploymentCluster) Get() *DeploymentCluster { +func (v NullableClusterPipelineCluster) Get() *ClusterPipelineCluster { return v.value } -func (v *NullableDeploymentCluster) Set(val *DeploymentCluster) { +func (v *NullableClusterPipelineCluster) Set(val *ClusterPipelineCluster) { v.value = val v.isSet = true } -func (v NullableDeploymentCluster) IsSet() bool { +func (v NullableClusterPipelineCluster) IsSet() bool { return v.isSet } -func (v *NullableDeploymentCluster) Unset() { +func (v *NullableClusterPipelineCluster) Unset() { v.value = nil v.isSet = false } -func NewNullableDeploymentCluster(val *DeploymentCluster) *NullableDeploymentCluster { - return &NullableDeploymentCluster{value: val, isSet: true} +func NewNullableClusterPipelineCluster(val *ClusterPipelineCluster) *NullableClusterPipelineCluster { + return &NullableClusterPipelineCluster{value: val, isSet: true} } -func (v NullableDeploymentCluster) MarshalJSON() ([]byte, error) { +func (v NullableClusterPipelineCluster) MarshalJSON() ([]byte, error) { return json.Marshal(v.value) } -func (v *NullableDeploymentCluster) UnmarshalJSON(src []byte) error { +func (v *NullableClusterPipelineCluster) UnmarshalJSON(src []byte) error { v.isSet = true return json.Unmarshal(src, &v.value) } diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline_trigger.go b/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline_trigger.go index 4b37419..065ec17 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline_trigger.go +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_pipeline_trigger.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_cluster_provision_create_response.go b/v1/providers/launchpad/gen/launchpad/model_cluster_provision_create_response.go new file mode 100644 index 0000000..9cad8ff --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/model_cluster_provision_create_response.go @@ -0,0 +1,195 @@ +/* +NVIDIA LaunchPad API + +RESTful API for interacting with the NVIDIA LaunchPad platform + +API version: 2.40.9 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package openapi + +import ( + "encoding/json" + "fmt" +) + +// checks if the ClusterProvisionCreateResponse type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ClusterProvisionCreateResponse{} + +// ClusterProvisionCreateResponse struct for ClusterProvisionCreateResponse +type ClusterProvisionCreateResponse struct { + Pipeline ClusterPipeline `json:"pipeline"` + ProvisioningConfig ProvisioningRequest `json:"provisioning_config"` + AdditionalProperties map[string]interface{} +} + +type _ClusterProvisionCreateResponse ClusterProvisionCreateResponse + +// NewClusterProvisionCreateResponse instantiates a new ClusterProvisionCreateResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewClusterProvisionCreateResponse(pipeline ClusterPipeline, provisioningConfig ProvisioningRequest) *ClusterProvisionCreateResponse { + this := ClusterProvisionCreateResponse{} + this.Pipeline = pipeline + this.ProvisioningConfig = provisioningConfig + return &this +} + +// NewClusterProvisionCreateResponseWithDefaults instantiates a new ClusterProvisionCreateResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewClusterProvisionCreateResponseWithDefaults() *ClusterProvisionCreateResponse { + this := ClusterProvisionCreateResponse{} + return &this +} + +// GetPipeline returns the Pipeline field value +func (o *ClusterProvisionCreateResponse) GetPipeline() ClusterPipeline { + if o == nil { + var ret ClusterPipeline + return ret + } + + return o.Pipeline +} + +// GetPipelineOk returns a tuple with the Pipeline field value +// and a boolean to check if the value has been set. +func (o *ClusterProvisionCreateResponse) GetPipelineOk() (*ClusterPipeline, bool) { + if o == nil { + return nil, false + } + return &o.Pipeline, true +} + +// SetPipeline sets field value +func (o *ClusterProvisionCreateResponse) SetPipeline(v ClusterPipeline) { + o.Pipeline = v +} + +// GetProvisioningConfig returns the ProvisioningConfig field value +func (o *ClusterProvisionCreateResponse) GetProvisioningConfig() ProvisioningRequest { + if o == nil { + var ret ProvisioningRequest + return ret + } + + return o.ProvisioningConfig +} + +// GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field value +// and a boolean to check if the value has been set. +func (o *ClusterProvisionCreateResponse) GetProvisioningConfigOk() (*ProvisioningRequest, bool) { + if o == nil { + return nil, false + } + return &o.ProvisioningConfig, true +} + +// SetProvisioningConfig sets field value +func (o *ClusterProvisionCreateResponse) SetProvisioningConfig(v ProvisioningRequest) { + o.ProvisioningConfig = v +} + +func (o ClusterProvisionCreateResponse) MarshalJSON() ([]byte, error) { + toSerialize, err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ClusterProvisionCreateResponse) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["pipeline"] = o.Pipeline + toSerialize["provisioning_config"] = o.ProvisioningConfig + + for key, value := range o.AdditionalProperties { + toSerialize[key] = value + } + + return toSerialize, nil +} + +func (o *ClusterProvisionCreateResponse) UnmarshalJSON(data []byte) (err error) { + // This validates that all required properties are included in the JSON object + // by unmarshalling the object into a generic map with string keys and checking + // that every required field exists as a key in the generic map. + requiredProperties := []string{ + "pipeline", + "provisioning_config", + } + + allProperties := make(map[string]interface{}) + + err = json.Unmarshal(data, &allProperties) + + if err != nil { + return err + } + + for _, requiredProperty := range requiredProperties { + if _, exists := allProperties[requiredProperty]; !exists { + return fmt.Errorf("no value given for required property %v", requiredProperty) + } + } + + varClusterProvisionCreateResponse := _ClusterProvisionCreateResponse{} + + err = json.Unmarshal(data, &varClusterProvisionCreateResponse) + + if err != nil { + return err + } + + *o = ClusterProvisionCreateResponse(varClusterProvisionCreateResponse) + + additionalProperties := make(map[string]interface{}) + + if err = json.Unmarshal(data, &additionalProperties); err == nil { + delete(additionalProperties, "pipeline") + delete(additionalProperties, "provisioning_config") + o.AdditionalProperties = additionalProperties + } + + return err +} + +type NullableClusterProvisionCreateResponse struct { + value *ClusterProvisionCreateResponse + isSet bool +} + +func (v NullableClusterProvisionCreateResponse) Get() *ClusterProvisionCreateResponse { + return v.value +} + +func (v *NullableClusterProvisionCreateResponse) Set(val *ClusterProvisionCreateResponse) { + v.value = val + v.isSet = true +} + +func (v NullableClusterProvisionCreateResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableClusterProvisionCreateResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableClusterProvisionCreateResponse(val *ClusterProvisionCreateResponse) *NullableClusterProvisionCreateResponse { + return &NullableClusterProvisionCreateResponse{value: val, isSet: true} +} + +func (v NullableClusterProvisionCreateResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableClusterProvisionCreateResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v1/providers/launchpad/gen/launchpad/model_cpu_manufacturer_enum.go b/v1/providers/launchpad/gen/launchpad/model_cpu_manufacturer_enum.go index 3a893d0..9f6ede8 100644 --- a/v1/providers/launchpad/gen/launchpad/model_cpu_manufacturer_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_cpu_manufacturer_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment.go b/v1/providers/launchpad/gen/launchpad/model_deployment.go index 479a05f..bd77902 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -26,8 +26,8 @@ type Deployment struct { // Catalog ID of the experience provisioned to the cluster CatalogId *string `json:"catalog_id,omitempty"` // Catalog ID alias of the experience provisioned to the cluster - CatalogIdAlias *string `json:"catalog_id_alias,omitempty"` - Cluster *DeploymentCluster `json:"cluster,omitempty"` + CatalogIdAlias *string `json:"catalog_id_alias,omitempty"` + Cluster *ClusterPipelineCluster `json:"cluster,omitempty"` // Override the Ansible collection branch initialized within the pipeline CollectionBranch NullableString `json:"collection_branch,omitempty"` // Timestamp of when the object was created @@ -308,9 +308,9 @@ func (o *Deployment) SetCatalogIdAlias(v string) { } // GetCluster returns the Cluster field value if set, zero value otherwise. -func (o *Deployment) GetCluster() DeploymentCluster { +func (o *Deployment) GetCluster() ClusterPipelineCluster { if o == nil || IsNil(o.Cluster) { - var ret DeploymentCluster + var ret ClusterPipelineCluster return ret } return *o.Cluster @@ -318,7 +318,7 @@ func (o *Deployment) GetCluster() DeploymentCluster { // GetClusterOk returns a tuple with the Cluster field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *Deployment) GetClusterOk() (*DeploymentCluster, bool) { +func (o *Deployment) GetClusterOk() (*ClusterPipelineCluster, bool) { if o == nil || IsNil(o.Cluster) { return nil, false } @@ -334,8 +334,8 @@ func (o *Deployment) HasCluster() bool { return false } -// SetCluster gets a reference to the given DeploymentCluster and assigns it to the Cluster field. -func (o *Deployment) SetCluster(v DeploymentCluster) { +// SetCluster gets a reference to the given ClusterPipelineCluster and assigns it to the Cluster field. +func (o *Deployment) SetCluster(v ClusterPipelineCluster) { o.Cluster = &v } diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_bulk_update.go b/v1/providers/launchpad/gen/launchpad/model_deployment_bulk_update.go index 3addbd5..bba3113 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_bulk_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_bulk_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_instance.go b/v1/providers/launchpad/gen/launchpad/model_deployment_instance.go index 3a81b11..59b0390 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_instance.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_instance.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_key.go b/v1/providers/launchpad/gen/launchpad/model_deployment_key.go index f0cf34f..ae886c0 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_key.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_key.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_note.go b/v1/providers/launchpad/gen/launchpad/model_deployment_note.go index 6adc189..f8085dd 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_note.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_note.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_pipeline.go b/v1/providers/launchpad/gen/launchpad/model_deployment_pipeline.go index b124121..9944ba5 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_pipeline.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_pipeline.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_pipeline_trigger.go b/v1/providers/launchpad/gen/launchpad/model_deployment_pipeline_trigger.go new file mode 100644 index 0000000..b4eeadb --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_pipeline_trigger.go @@ -0,0 +1,317 @@ +/* +NVIDIA LaunchPad API + +RESTful API for interacting with the NVIDIA LaunchPad platform + +API version: 2.40.9 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package openapi + +import ( + "encoding/json" + "fmt" + "time" +) + +// checks if the DeploymentPipelineTrigger type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &DeploymentPipelineTrigger{} + +// DeploymentPipelineTrigger struct for DeploymentPipelineTrigger +type DeploymentPipelineTrigger struct { + // Action for the pipeline to run * `apply` - apply * `destroy` - destroy * `notify` - notify + Action PipelineAction `json:"action"` + // Timestamp of when the object was created + Created time.Time `json:"created"` + Id string `json:"id"` + // Timestamp of when the object was last modified + Modified time.Time `json:"modified"` + // GitLab pipeline ID + PipelineId int32 `json:"pipeline_id"` + // URL for the pipeline details + Url string `json:"url"` + AdditionalProperties map[string]interface{} +} + +type _DeploymentPipelineTrigger DeploymentPipelineTrigger + +// NewDeploymentPipelineTrigger instantiates a new DeploymentPipelineTrigger object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDeploymentPipelineTrigger(action PipelineAction, created time.Time, id string, modified time.Time, pipelineId int32, url string) *DeploymentPipelineTrigger { + this := DeploymentPipelineTrigger{} + this.Action = action + this.Created = created + this.Id = id + this.Modified = modified + this.PipelineId = pipelineId + this.Url = url + return &this +} + +// NewDeploymentPipelineTriggerWithDefaults instantiates a new DeploymentPipelineTrigger object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDeploymentPipelineTriggerWithDefaults() *DeploymentPipelineTrigger { + this := DeploymentPipelineTrigger{} + return &this +} + +// GetAction returns the Action field value +func (o *DeploymentPipelineTrigger) GetAction() PipelineAction { + if o == nil { + var ret PipelineAction + return ret + } + + return o.Action +} + +// GetActionOk returns a tuple with the Action field value +// and a boolean to check if the value has been set. +func (o *DeploymentPipelineTrigger) GetActionOk() (*PipelineAction, bool) { + if o == nil { + return nil, false + } + return &o.Action, true +} + +// SetAction sets field value +func (o *DeploymentPipelineTrigger) SetAction(v PipelineAction) { + o.Action = v +} + +// GetCreated returns the Created field value +func (o *DeploymentPipelineTrigger) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// GetCreatedOk returns a tuple with the Created field value +// and a boolean to check if the value has been set. +func (o *DeploymentPipelineTrigger) GetCreatedOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.Created, true +} + +// SetCreated sets field value +func (o *DeploymentPipelineTrigger) SetCreated(v time.Time) { + o.Created = v +} + +// GetId returns the Id field value +func (o *DeploymentPipelineTrigger) GetId() string { + if o == nil { + var ret string + return ret + } + + return o.Id +} + +// GetIdOk returns a tuple with the Id field value +// and a boolean to check if the value has been set. +func (o *DeploymentPipelineTrigger) GetIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Id, true +} + +// SetId sets field value +func (o *DeploymentPipelineTrigger) SetId(v string) { + o.Id = v +} + +// GetModified returns the Modified field value +func (o *DeploymentPipelineTrigger) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value +// and a boolean to check if the value has been set. +func (o *DeploymentPipelineTrigger) GetModifiedOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.Modified, true +} + +// SetModified sets field value +func (o *DeploymentPipelineTrigger) SetModified(v time.Time) { + o.Modified = v +} + +// GetPipelineId returns the PipelineId field value +func (o *DeploymentPipelineTrigger) GetPipelineId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.PipelineId +} + +// GetPipelineIdOk returns a tuple with the PipelineId field value +// and a boolean to check if the value has been set. +func (o *DeploymentPipelineTrigger) GetPipelineIdOk() (*int32, bool) { + if o == nil { + return nil, false + } + return &o.PipelineId, true +} + +// SetPipelineId sets field value +func (o *DeploymentPipelineTrigger) SetPipelineId(v int32) { + o.PipelineId = v +} + +// GetUrl returns the Url field value +func (o *DeploymentPipelineTrigger) GetUrl() string { + if o == nil { + var ret string + return ret + } + + return o.Url +} + +// GetUrlOk returns a tuple with the Url field value +// and a boolean to check if the value has been set. +func (o *DeploymentPipelineTrigger) GetUrlOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Url, true +} + +// SetUrl sets field value +func (o *DeploymentPipelineTrigger) SetUrl(v string) { + o.Url = v +} + +func (o DeploymentPipelineTrigger) MarshalJSON() ([]byte, error) { + toSerialize, err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o DeploymentPipelineTrigger) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["action"] = o.Action + toSerialize["created"] = o.Created + toSerialize["id"] = o.Id + toSerialize["modified"] = o.Modified + toSerialize["pipeline_id"] = o.PipelineId + toSerialize["url"] = o.Url + + for key, value := range o.AdditionalProperties { + toSerialize[key] = value + } + + return toSerialize, nil +} + +func (o *DeploymentPipelineTrigger) UnmarshalJSON(data []byte) (err error) { + // This validates that all required properties are included in the JSON object + // by unmarshalling the object into a generic map with string keys and checking + // that every required field exists as a key in the generic map. + requiredProperties := []string{ + "action", + "created", + "id", + "modified", + "pipeline_id", + "url", + } + + allProperties := make(map[string]interface{}) + + err = json.Unmarshal(data, &allProperties) + + if err != nil { + return err + } + + for _, requiredProperty := range requiredProperties { + if _, exists := allProperties[requiredProperty]; !exists { + return fmt.Errorf("no value given for required property %v", requiredProperty) + } + } + + varDeploymentPipelineTrigger := _DeploymentPipelineTrigger{} + + err = json.Unmarshal(data, &varDeploymentPipelineTrigger) + + if err != nil { + return err + } + + *o = DeploymentPipelineTrigger(varDeploymentPipelineTrigger) + + additionalProperties := make(map[string]interface{}) + + if err = json.Unmarshal(data, &additionalProperties); err == nil { + delete(additionalProperties, "action") + delete(additionalProperties, "created") + delete(additionalProperties, "id") + delete(additionalProperties, "modified") + delete(additionalProperties, "pipeline_id") + delete(additionalProperties, "url") + o.AdditionalProperties = additionalProperties + } + + return err +} + +type NullableDeploymentPipelineTrigger struct { + value *DeploymentPipelineTrigger + isSet bool +} + +func (v NullableDeploymentPipelineTrigger) Get() *DeploymentPipelineTrigger { + return v.value +} + +func (v *NullableDeploymentPipelineTrigger) Set(val *DeploymentPipelineTrigger) { + v.value = val + v.isSet = true +} + +func (v NullableDeploymentPipelineTrigger) IsSet() bool { + return v.isSet +} + +func (v *NullableDeploymentPipelineTrigger) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDeploymentPipelineTrigger(val *DeploymentPipelineTrigger) *NullableDeploymentPipelineTrigger { + return &NullableDeploymentPipelineTrigger{value: val, isSet: true} +} + +func (v NullableDeploymentPipelineTrigger) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDeploymentPipelineTrigger) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_service.go b/v1/providers/launchpad/gen/launchpad/model_deployment_service.go index 6089cb5..4410714 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_service.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_service.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_state.go b/v1/providers/launchpad/gen/launchpad/model_deployment_state.go index ae56b06..0ba5d56 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_state.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_state.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_task.go b/v1/providers/launchpad/gen/launchpad/model_deployment_task.go index e1cc95d..63fffd0 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_task.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_task.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_task_action_enum.go b/v1/providers/launchpad/gen/launchpad/model_deployment_task_action_enum.go index 897c157..1396975 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_task_action_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_task_action_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_deployment_update.go b/v1/providers/launchpad/gen/launchpad/model_deployment_update.go index c857483..c6df316 100644 --- a/v1/providers/launchpad/gen/launchpad/model_deployment_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_deployment_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_doc_deployment_delete.go b/v1/providers/launchpad/gen/launchpad/model_doc_deployment_delete.go index af0a176..1f461fb 100644 --- a/v1/providers/launchpad/gen/launchpad/model_doc_deployment_delete.go +++ b/v1/providers/launchpad/gen/launchpad/model_doc_deployment_delete.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -26,8 +26,8 @@ type DocDeploymentDelete struct { // Catalog ID of the experience provisioned to the cluster CatalogId *string `json:"catalog_id,omitempty"` // Catalog ID alias of the experience provisioned to the cluster - CatalogIdAlias *string `json:"catalog_id_alias,omitempty"` - Cluster *DeploymentCluster `json:"cluster,omitempty"` + CatalogIdAlias *string `json:"catalog_id_alias,omitempty"` + Cluster *ClusterPipelineCluster `json:"cluster,omitempty"` // Override the Ansible collection branch initialized within the pipeline CollectionBranch NullableString `json:"collection_branch,omitempty"` // Timestamp of when the object was created @@ -309,9 +309,9 @@ func (o *DocDeploymentDelete) SetCatalogIdAlias(v string) { } // GetCluster returns the Cluster field value if set, zero value otherwise. -func (o *DocDeploymentDelete) GetCluster() DeploymentCluster { +func (o *DocDeploymentDelete) GetCluster() ClusterPipelineCluster { if o == nil || IsNil(o.Cluster) { - var ret DeploymentCluster + var ret ClusterPipelineCluster return ret } return *o.Cluster @@ -319,7 +319,7 @@ func (o *DocDeploymentDelete) GetCluster() DeploymentCluster { // GetClusterOk returns a tuple with the Cluster field value if set, nil otherwise // and a boolean to check if the value has been set. -func (o *DocDeploymentDelete) GetClusterOk() (*DeploymentCluster, bool) { +func (o *DocDeploymentDelete) GetClusterOk() (*ClusterPipelineCluster, bool) { if o == nil || IsNil(o.Cluster) { return nil, false } @@ -335,8 +335,8 @@ func (o *DocDeploymentDelete) HasCluster() bool { return false } -// SetCluster gets a reference to the given DeploymentCluster and assigns it to the Cluster field. -func (o *DocDeploymentDelete) SetCluster(v DeploymentCluster) { +// SetCluster gets a reference to the given ClusterPipelineCluster and assigns it to the Cluster field. +func (o *DocDeploymentDelete) SetCluster(v ClusterPipelineCluster) { o.Cluster = &v } diff --git a/v1/providers/launchpad/gen/launchpad/model_experience.go b/v1/providers/launchpad/gen/launchpad/model_experience.go index 24c7fd7..2be7e93 100644 --- a/v1/providers/launchpad/gen/launchpad/model_experience.go +++ b/v1/providers/launchpad/gen/launchpad/model_experience.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -47,6 +47,8 @@ type Experience struct { FcPlatform NullableFcPlatformEnum `json:"fc_platform,omitempty"` // Does the experience support Flight Control? FcSupport *bool `json:"fc_support,omitempty"` + // Is the experience featured in the catalog? + Featured bool `json:"featured"` // ID of the garage where nodes for this experience should be selected from GarageId NullableString `json:"garage_id,omitempty"` // Ground Control branch name (default: main) @@ -63,10 +65,12 @@ type Experience struct { Modified time.Time `json:"modified"` // Number of Nodes used NodeCount *int32 `json:"node_count,omitempty"` - Persona string `json:"persona"` + // If set, the experience must be provisioned to hardware manufactured by the given OEM + Oem NullableString `json:"oem,omitempty"` + Persona string `json:"persona"` // Pipeline ID used for provisioning Pipeline int64 `json:"pipeline"` - // Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 + // Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 Platform PlatformEnum `json:"platform"` // If set, the experience must be provisioned to the given provider Provider NullableString `json:"provider,omitempty"` @@ -81,9 +85,9 @@ type Experience struct { // Is this a persistent experience for SAs? SaLab *bool `json:"sa_lab,omitempty"` // Required CPU architecture * `amd64` - amd64 * `arm64` - arm64 - SystemArch SystemArchEnum `json:"system_arch"` - Title string `json:"title"` - VgpuProfile NullableVgpuProfileEnum `json:"vgpu_profile,omitempty"` + SystemArch SystemArchEnum `json:"system_arch"` + Title string `json:"title"` + VgpuProfile NullableString `json:"vgpu_profile,omitempty"` AdditionalProperties map[string]interface{} } @@ -93,12 +97,13 @@ type _Experience Experience // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewExperience(catalogId string, category CategoryEnum, created time.Time, experience string, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string) *Experience { +func NewExperience(catalogId string, category CategoryEnum, created time.Time, experience string, featured bool, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string) *Experience { this := Experience{} this.CatalogId = catalogId this.Category = category this.Created = created this.Experience = experience + this.Featured = featured this.GpuOs = gpuOs this.Id = id this.Modified = modified @@ -578,6 +583,30 @@ func (o *Experience) SetFcSupport(v bool) { o.FcSupport = &v } +// GetFeatured returns the Featured field value +func (o *Experience) GetFeatured() bool { + if o == nil { + var ret bool + return ret + } + + return o.Featured +} + +// GetFeaturedOk returns a tuple with the Featured field value +// and a boolean to check if the value has been set. +func (o *Experience) GetFeaturedOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Featured, true +} + +// SetFeatured sets field value +func (o *Experience) SetFeatured(v bool) { + o.Featured = v +} + // GetGarageId returns the GarageId field value if set, zero value otherwise (both if not set or set to explicit null). func (o *Experience) GetGarageId() string { if o == nil || IsNil(o.GarageId.Get()) { @@ -864,6 +893,49 @@ func (o *Experience) SetNodeCount(v int32) { o.NodeCount = &v } +// GetOem returns the Oem field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *Experience) GetOem() string { + if o == nil || IsNil(o.Oem.Get()) { + var ret string + return ret + } + return *o.Oem.Get() +} + +// GetOemOk returns a tuple with the Oem field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *Experience) GetOemOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.Oem.Get(), o.Oem.IsSet() +} + +// HasOem returns a boolean if a field has been set. +func (o *Experience) HasOem() bool { + if o != nil && o.Oem.IsSet() { + return true + } + + return false +} + +// SetOem gets a reference to the given NullableString and assigns it to the Oem field. +func (o *Experience) SetOem(v string) { + o.Oem.Set(&v) +} + +// SetOemNil sets the value for Oem to be an explicit nil +func (o *Experience) SetOemNil() { + o.Oem.Set(nil) +} + +// UnsetOem ensures that no value is present for Oem, not even an explicit nil +func (o *Experience) UnsetOem() { + o.Oem.Unset() +} + // GetPersona returns the Persona field value func (o *Experience) GetPersona() string { if o == nil { @@ -1210,9 +1282,9 @@ func (o *Experience) SetTitle(v string) { } // GetVgpuProfile returns the VgpuProfile field value if set, zero value otherwise (both if not set or set to explicit null). -func (o *Experience) GetVgpuProfile() VgpuProfileEnum { +func (o *Experience) GetVgpuProfile() string { if o == nil || IsNil(o.VgpuProfile.Get()) { - var ret VgpuProfileEnum + var ret string return ret } return *o.VgpuProfile.Get() @@ -1221,7 +1293,7 @@ func (o *Experience) GetVgpuProfile() VgpuProfileEnum { // GetVgpuProfileOk returns a tuple with the VgpuProfile field value if set, nil otherwise // and a boolean to check if the value has been set. // NOTE: If the value is an explicit nil, `nil, true` will be returned -func (o *Experience) GetVgpuProfileOk() (*VgpuProfileEnum, bool) { +func (o *Experience) GetVgpuProfileOk() (*string, bool) { if o == nil { return nil, false } @@ -1237,8 +1309,8 @@ func (o *Experience) HasVgpuProfile() bool { return false } -// SetVgpuProfile gets a reference to the given NullableVgpuProfileEnum and assigns it to the VgpuProfile field. -func (o *Experience) SetVgpuProfile(v VgpuProfileEnum) { +// SetVgpuProfile gets a reference to the given NullableString and assigns it to the VgpuProfile field. +func (o *Experience) SetVgpuProfile(v string) { o.VgpuProfile.Set(&v) } @@ -1296,6 +1368,7 @@ func (o Experience) ToMap() (map[string]interface{}, error) { if !IsNil(o.FcSupport) { toSerialize["fc_support"] = o.FcSupport } + toSerialize["featured"] = o.Featured if o.GarageId.IsSet() { toSerialize["garage_id"] = o.GarageId.Get() } @@ -1317,6 +1390,9 @@ func (o Experience) ToMap() (map[string]interface{}, error) { if !IsNil(o.NodeCount) { toSerialize["node_count"] = o.NodeCount } + if o.Oem.IsSet() { + toSerialize["oem"] = o.Oem.Get() + } toSerialize["persona"] = o.Persona toSerialize["pipeline"] = o.Pipeline toSerialize["platform"] = o.Platform @@ -1360,6 +1436,7 @@ func (o *Experience) UnmarshalJSON(data []byte) (err error) { "category", "created", "experience", + "featured", "gpu_os", "id", "modified", @@ -1411,6 +1488,7 @@ func (o *Experience) UnmarshalJSON(data []byte) (err error) { delete(additionalProperties, "experience_branch") delete(additionalProperties, "fc_platform") delete(additionalProperties, "fc_support") + delete(additionalProperties, "featured") delete(additionalProperties, "garage_id") delete(additionalProperties, "gc_branch") delete(additionalProperties, "gpu_count") @@ -1420,6 +1498,7 @@ func (o *Experience) UnmarshalJSON(data []byte) (err error) { delete(additionalProperties, "lifetime") delete(additionalProperties, "modified") delete(additionalProperties, "node_count") + delete(additionalProperties, "oem") delete(additionalProperties, "persona") delete(additionalProperties, "pipeline") delete(additionalProperties, "platform") diff --git a/v1/providers/launchpad/gen/launchpad/model_experience_bulk.go b/v1/providers/launchpad/gen/launchpad/model_experience_bulk.go index e29fb72..eef11f4 100644 --- a/v1/providers/launchpad/gen/launchpad/model_experience_bulk.go +++ b/v1/providers/launchpad/gen/launchpad/model_experience_bulk.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_experience_bulk_update.go b/v1/providers/launchpad/gen/launchpad/model_experience_bulk_update.go index 7a390cc..e3783a3 100644 --- a/v1/providers/launchpad/gen/launchpad/model_experience_bulk_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_experience_bulk_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -47,6 +47,8 @@ type ExperienceBulkUpdate struct { FcPlatform NullableFcPlatformEnum `json:"fc_platform,omitempty"` // Does the experience support Flight Control? FcSupport *bool `json:"fc_support,omitempty"` + // Is the experience featured in the catalog? + Featured bool `json:"featured"` // ID of the garage where nodes for this experience should be selected from GarageId NullableString `json:"garage_id,omitempty"` // Ground Control branch name (default: main) @@ -63,10 +65,12 @@ type ExperienceBulkUpdate struct { Modified time.Time `json:"modified"` // Number of Nodes used NodeCount *int32 `json:"node_count,omitempty"` - Persona string `json:"persona"` + // If set, the experience must be provisioned to hardware manufactured by the given OEM + Oem NullableString `json:"oem,omitempty"` + Persona string `json:"persona"` // Pipeline ID used for provisioning Pipeline int64 `json:"pipeline"` - // Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 + // Base platform that the experience will be provisioned onto * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 Platform PlatformEnum `json:"platform"` // If set, the experience must be provisioned to the given provider Provider NullableString `json:"provider,omitempty"` @@ -81,12 +85,12 @@ type ExperienceBulkUpdate struct { // Is this a persistent experience for SAs? SaLab *bool `json:"sa_lab,omitempty"` // Required CPU architecture * `amd64` - amd64 * `arm64` - arm64 - SystemArch SystemArchEnum `json:"system_arch"` - Title string `json:"title"` - VgpuProfile NullableVgpuProfileEnum `json:"vgpu_profile,omitempty"` - Count int32 `json:"count"` - Ids []string `json:"ids"` - Result string `json:"result"` + SystemArch SystemArchEnum `json:"system_arch"` + Title string `json:"title"` + VgpuProfile NullableString `json:"vgpu_profile,omitempty"` + Count int32 `json:"count"` + Ids []string `json:"ids"` + Result string `json:"result"` AdditionalProperties map[string]interface{} } @@ -96,13 +100,14 @@ type _ExperienceBulkUpdate ExperienceBulkUpdate // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewExperienceBulkUpdate(catalogId string, catalogIdAlias NullableString, category CategoryEnum, created time.Time, experience string, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, count int32, ids []string, result string) *ExperienceBulkUpdate { +func NewExperienceBulkUpdate(catalogId string, catalogIdAlias NullableString, category CategoryEnum, created time.Time, experience string, featured bool, gpuOs GpuOs, id string, modified time.Time, persona string, pipeline int64, platform PlatformEnum, systemArch SystemArchEnum, title string, count int32, ids []string, result string) *ExperienceBulkUpdate { this := ExperienceBulkUpdate{} this.CatalogId = catalogId this.CatalogIdAlias = catalogIdAlias this.Category = category this.Created = created this.Experience = experience + this.Featured = featured this.GpuOs = gpuOs this.Id = id this.Modified = modified @@ -568,6 +573,30 @@ func (o *ExperienceBulkUpdate) SetFcSupport(v bool) { o.FcSupport = &v } +// GetFeatured returns the Featured field value +func (o *ExperienceBulkUpdate) GetFeatured() bool { + if o == nil { + var ret bool + return ret + } + + return o.Featured +} + +// GetFeaturedOk returns a tuple with the Featured field value +// and a boolean to check if the value has been set. +func (o *ExperienceBulkUpdate) GetFeaturedOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Featured, true +} + +// SetFeatured sets field value +func (o *ExperienceBulkUpdate) SetFeatured(v bool) { + o.Featured = v +} + // GetGarageId returns the GarageId field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ExperienceBulkUpdate) GetGarageId() string { if o == nil || IsNil(o.GarageId.Get()) { @@ -854,6 +883,49 @@ func (o *ExperienceBulkUpdate) SetNodeCount(v int32) { o.NodeCount = &v } +// GetOem returns the Oem field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ExperienceBulkUpdate) GetOem() string { + if o == nil || IsNil(o.Oem.Get()) { + var ret string + return ret + } + return *o.Oem.Get() +} + +// GetOemOk returns a tuple with the Oem field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ExperienceBulkUpdate) GetOemOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.Oem.Get(), o.Oem.IsSet() +} + +// HasOem returns a boolean if a field has been set. +func (o *ExperienceBulkUpdate) HasOem() bool { + if o != nil && o.Oem.IsSet() { + return true + } + + return false +} + +// SetOem gets a reference to the given NullableString and assigns it to the Oem field. +func (o *ExperienceBulkUpdate) SetOem(v string) { + o.Oem.Set(&v) +} + +// SetOemNil sets the value for Oem to be an explicit nil +func (o *ExperienceBulkUpdate) SetOemNil() { + o.Oem.Set(nil) +} + +// UnsetOem ensures that no value is present for Oem, not even an explicit nil +func (o *ExperienceBulkUpdate) UnsetOem() { + o.Oem.Unset() +} + // GetPersona returns the Persona field value func (o *ExperienceBulkUpdate) GetPersona() string { if o == nil { @@ -1200,9 +1272,9 @@ func (o *ExperienceBulkUpdate) SetTitle(v string) { } // GetVgpuProfile returns the VgpuProfile field value if set, zero value otherwise (both if not set or set to explicit null). -func (o *ExperienceBulkUpdate) GetVgpuProfile() VgpuProfileEnum { +func (o *ExperienceBulkUpdate) GetVgpuProfile() string { if o == nil || IsNil(o.VgpuProfile.Get()) { - var ret VgpuProfileEnum + var ret string return ret } return *o.VgpuProfile.Get() @@ -1211,7 +1283,7 @@ func (o *ExperienceBulkUpdate) GetVgpuProfile() VgpuProfileEnum { // GetVgpuProfileOk returns a tuple with the VgpuProfile field value if set, nil otherwise // and a boolean to check if the value has been set. // NOTE: If the value is an explicit nil, `nil, true` will be returned -func (o *ExperienceBulkUpdate) GetVgpuProfileOk() (*VgpuProfileEnum, bool) { +func (o *ExperienceBulkUpdate) GetVgpuProfileOk() (*string, bool) { if o == nil { return nil, false } @@ -1227,8 +1299,8 @@ func (o *ExperienceBulkUpdate) HasVgpuProfile() bool { return false } -// SetVgpuProfile gets a reference to the given NullableVgpuProfileEnum and assigns it to the VgpuProfile field. -func (o *ExperienceBulkUpdate) SetVgpuProfile(v VgpuProfileEnum) { +// SetVgpuProfile gets a reference to the given NullableString and assigns it to the VgpuProfile field. +func (o *ExperienceBulkUpdate) SetVgpuProfile(v string) { o.VgpuProfile.Set(&v) } @@ -1356,6 +1428,7 @@ func (o ExperienceBulkUpdate) ToMap() (map[string]interface{}, error) { if !IsNil(o.FcSupport) { toSerialize["fc_support"] = o.FcSupport } + toSerialize["featured"] = o.Featured if o.GarageId.IsSet() { toSerialize["garage_id"] = o.GarageId.Get() } @@ -1377,6 +1450,9 @@ func (o ExperienceBulkUpdate) ToMap() (map[string]interface{}, error) { if !IsNil(o.NodeCount) { toSerialize["node_count"] = o.NodeCount } + if o.Oem.IsSet() { + toSerialize["oem"] = o.Oem.Get() + } toSerialize["persona"] = o.Persona toSerialize["pipeline"] = o.Pipeline toSerialize["platform"] = o.Platform @@ -1424,6 +1500,7 @@ func (o *ExperienceBulkUpdate) UnmarshalJSON(data []byte) (err error) { "category", "created", "experience", + "featured", "gpu_os", "id", "modified", @@ -1478,6 +1555,7 @@ func (o *ExperienceBulkUpdate) UnmarshalJSON(data []byte) (err error) { delete(additionalProperties, "experience_branch") delete(additionalProperties, "fc_platform") delete(additionalProperties, "fc_support") + delete(additionalProperties, "featured") delete(additionalProperties, "garage_id") delete(additionalProperties, "gc_branch") delete(additionalProperties, "gpu_count") @@ -1487,6 +1565,7 @@ func (o *ExperienceBulkUpdate) UnmarshalJSON(data []byte) (err error) { delete(additionalProperties, "lifetime") delete(additionalProperties, "modified") delete(additionalProperties, "node_count") + delete(additionalProperties, "oem") delete(additionalProperties, "persona") delete(additionalProperties, "pipeline") delete(additionalProperties, "platform") diff --git a/v1/providers/launchpad/gen/launchpad/model_experience_note.go b/v1/providers/launchpad/gen/launchpad/model_experience_note.go index 57d19bb..5d1b9e7 100644 --- a/v1/providers/launchpad/gen/launchpad/model_experience_note.go +++ b/v1/providers/launchpad/gen/launchpad/model_experience_note.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_experience_note_experience.go b/v1/providers/launchpad/gen/launchpad/model_experience_note_experience.go index 685122b..4b10312 100644 --- a/v1/providers/launchpad/gen/launchpad/model_experience_note_experience.go +++ b/v1/providers/launchpad/gen/launchpad/model_experience_note_experience.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_fc_platform_enum.go b/v1/providers/launchpad/gen/launchpad/model_fc_platform_enum.go index 165a96a..48783fe 100644 --- a/v1/providers/launchpad/gen/launchpad/model_fc_platform_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_fc_platform_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_gpu.go b/v1/providers/launchpad/gen/launchpad/model_gpu.go index 3156de4..673c3b2 100644 --- a/v1/providers/launchpad/gen/launchpad/model_gpu.go +++ b/v1/providers/launchpad/gen/launchpad/model_gpu.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_gpu_bulk_update.go b/v1/providers/launchpad/gen/launchpad/model_gpu_bulk_update.go index 9033566..c11db97 100644 --- a/v1/providers/launchpad/gen/launchpad/model_gpu_bulk_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_gpu_bulk_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_gpu_os.go b/v1/providers/launchpad/gen/launchpad/model_gpu_os.go index f23d060..d2ea83f 100644 --- a/v1/providers/launchpad/gen/launchpad/model_gpu_os.go +++ b/v1/providers/launchpad/gen/launchpad/model_gpu_os.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_gpu_os_choice.go b/v1/providers/launchpad/gen/launchpad/model_gpu_os_choice.go index 5a44c63..d83ead6 100644 --- a/v1/providers/launchpad/gen/launchpad/model_gpu_os_choice.go +++ b/v1/providers/launchpad/gen/launchpad/model_gpu_os_choice.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response.go b/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response.go index 84c676e..f625081 100644 --- a/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response.go +++ b/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response_components.go b/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response_components.go index e9ffa9a..6648624 100644 --- a/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response_components.go +++ b/v1/providers/launchpad/gen/launchpad/model_health_retrieve_200_response_components.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_instance.go b/v1/providers/launchpad/gen/launchpad/model_instance.go index fbdbed0..a30baef 100644 --- a/v1/providers/launchpad/gen/launchpad/model_instance.go +++ b/v1/providers/launchpad/gen/launchpad/model_instance.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -21,7 +21,7 @@ var _ MappedNullable = &Instance{} // Instance struct for Instance type Instance struct { - Cluster DeploymentCluster `json:"cluster"` + Cluster ClusterPipelineCluster `json:"cluster"` // Timestamp of when the object was created Created time.Time `json:"created"` Id string `json:"id"` @@ -45,7 +45,7 @@ type _Instance Instance // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewInstance(cluster DeploymentCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time) *Instance { +func NewInstance(cluster ClusterPipelineCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time) *Instance { this := Instance{} this.Cluster = cluster this.Created = created @@ -65,9 +65,9 @@ func NewInstanceWithDefaults() *Instance { } // GetCluster returns the Cluster field value -func (o *Instance) GetCluster() DeploymentCluster { +func (o *Instance) GetCluster() ClusterPipelineCluster { if o == nil { - var ret DeploymentCluster + var ret ClusterPipelineCluster return ret } @@ -76,7 +76,7 @@ func (o *Instance) GetCluster() DeploymentCluster { // GetClusterOk returns a tuple with the Cluster field value // and a boolean to check if the value has been set. -func (o *Instance) GetClusterOk() (*DeploymentCluster, bool) { +func (o *Instance) GetClusterOk() (*ClusterPipelineCluster, bool) { if o == nil { return nil, false } @@ -84,7 +84,7 @@ func (o *Instance) GetClusterOk() (*DeploymentCluster, bool) { } // SetCluster sets field value -func (o *Instance) SetCluster(v DeploymentCluster) { +func (o *Instance) SetCluster(v ClusterPipelineCluster) { o.Cluster = v } diff --git a/v1/providers/launchpad/gen/launchpad/model_instance_bulk_update.go b/v1/providers/launchpad/gen/launchpad/model_instance_bulk_update.go index 3feaea8..0643641 100644 --- a/v1/providers/launchpad/gen/launchpad/model_instance_bulk_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_instance_bulk_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -21,7 +21,7 @@ var _ MappedNullable = &InstanceBulkUpdate{} // InstanceBulkUpdate struct for InstanceBulkUpdate type InstanceBulkUpdate struct { - Cluster DeploymentCluster `json:"cluster"` + Cluster ClusterPipelineCluster `json:"cluster"` // Timestamp of when the object was created Created time.Time `json:"created"` Id string `json:"id"` @@ -48,7 +48,7 @@ type _InstanceBulkUpdate InstanceBulkUpdate // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewInstanceBulkUpdate(cluster DeploymentCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, count int32, ids []string, result string) *InstanceBulkUpdate { +func NewInstanceBulkUpdate(cluster ClusterPipelineCluster, created time.Time, id string, instanceId string, modified time.Time, stateModified time.Time, count int32, ids []string, result string) *InstanceBulkUpdate { this := InstanceBulkUpdate{} this.Cluster = cluster this.Created = created @@ -71,9 +71,9 @@ func NewInstanceBulkUpdateWithDefaults() *InstanceBulkUpdate { } // GetCluster returns the Cluster field value -func (o *InstanceBulkUpdate) GetCluster() DeploymentCluster { +func (o *InstanceBulkUpdate) GetCluster() ClusterPipelineCluster { if o == nil { - var ret DeploymentCluster + var ret ClusterPipelineCluster return ret } @@ -82,7 +82,7 @@ func (o *InstanceBulkUpdate) GetCluster() DeploymentCluster { // GetClusterOk returns a tuple with the Cluster field value // and a boolean to check if the value has been set. -func (o *InstanceBulkUpdate) GetClusterOk() (*DeploymentCluster, bool) { +func (o *InstanceBulkUpdate) GetClusterOk() (*ClusterPipelineCluster, bool) { if o == nil { return nil, false } @@ -90,7 +90,7 @@ func (o *InstanceBulkUpdate) GetClusterOk() (*DeploymentCluster, bool) { } // SetCluster sets field value -func (o *InstanceBulkUpdate) SetCluster(v DeploymentCluster) { +func (o *InstanceBulkUpdate) SetCluster(v ClusterPipelineCluster) { o.Cluster = v } diff --git a/v1/providers/launchpad/gen/launchpad/model_instance_state.go b/v1/providers/launchpad/gen/launchpad/model_instance_state.go index ec2eefa..ef19dbd 100644 --- a/v1/providers/launchpad/gen/launchpad/model_instance_state.go +++ b/v1/providers/launchpad/gen/launchpad/model_instance_state.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_instance_type.go b/v1/providers/launchpad/gen/launchpad/model_instance_type.go index f01c719..e0fdbb8 100644 --- a/v1/providers/launchpad/gen/launchpad/model_instance_type.go +++ b/v1/providers/launchpad/gen/launchpad/model_instance_type.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_instance_type_gpu.go b/v1/providers/launchpad/gen/launchpad/model_instance_type_gpu.go index a178d86..b2a22a4 100644 --- a/v1/providers/launchpad/gen/launchpad/model_instance_type_gpu.go +++ b/v1/providers/launchpad/gen/launchpad/model_instance_type_gpu.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_instance_type_price.go b/v1/providers/launchpad/gen/launchpad/model_instance_type_price.go index 79bb443..2e31491 100644 --- a/v1/providers/launchpad/gen/launchpad/model_instance_type_price.go +++ b/v1/providers/launchpad/gen/launchpad/model_instance_type_price.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_instance_type_storage.go b/v1/providers/launchpad/gen/launchpad/model_instance_type_storage.go index 85610db..9faaae0 100644 --- a/v1/providers/launchpad/gen/launchpad/model_instance_type_storage.go +++ b/v1/providers/launchpad/gen/launchpad/model_instance_type_storage.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_interconnection_type_enum.go b/v1/providers/launchpad/gen/launchpad/model_interconnection_type_enum.go index 5058bb9..6d1239e 100644 --- a/v1/providers/launchpad/gen/launchpad/model_interconnection_type_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_interconnection_type_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_location.go b/v1/providers/launchpad/gen/launchpad/model_location.go index 062eb17..96505c3 100644 --- a/v1/providers/launchpad/gen/launchpad/model_location.go +++ b/v1/providers/launchpad/gen/launchpad/model_location.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_location_provider.go b/v1/providers/launchpad/gen/launchpad/model_location_provider.go index ab6c80f..41059ee 100644 --- a/v1/providers/launchpad/gen/launchpad/model_location_provider.go +++ b/v1/providers/launchpad/gen/launchpad/model_location_provider.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_logout.go b/v1/providers/launchpad/gen/launchpad/model_logout.go index f0b0de2..0129e1f 100644 --- a/v1/providers/launchpad/gen/launchpad/model_logout.go +++ b/v1/providers/launchpad/gen/launchpad/model_logout.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_model_change.go b/v1/providers/launchpad/gen/launchpad/model_model_change.go index a7780ae..ec6661e 100644 --- a/v1/providers/launchpad/gen/launchpad/model_model_change.go +++ b/v1/providers/launchpad/gen/launchpad/model_model_change.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner.go b/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner.go index c16fb19..37aff69 100644 --- a/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner.go +++ b/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner_new_value.go b/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner_new_value.go index f854d67..37606ab 100644 --- a/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner_new_value.go +++ b/v1/providers/launchpad/gen/launchpad/model_model_change_changes_inner_new_value.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_network_type_enum.go b/v1/providers/launchpad/gen/launchpad/model_network_type_enum.go index a521e8d..1f2a3ff 100644 --- a/v1/providers/launchpad/gen/launchpad/model_network_type_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_network_type_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_node.go b/v1/providers/launchpad/gen/launchpad/model_node.go index bf1c8b3..69ea701 100644 --- a/v1/providers/launchpad/gen/launchpad/model_node.go +++ b/v1/providers/launchpad/gen/launchpad/model_node.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_node_bulk.go b/v1/providers/launchpad/gen/launchpad/model_node_bulk.go index 1063d59..afe6ff4 100644 --- a/v1/providers/launchpad/gen/launchpad/model_node_bulk.go +++ b/v1/providers/launchpad/gen/launchpad/model_node_bulk.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_node_bulk_update.go b/v1/providers/launchpad/gen/launchpad/model_node_bulk_update.go index ed5a23b..eab5248 100644 --- a/v1/providers/launchpad/gen/launchpad/model_node_bulk_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_node_bulk_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_node_location.go b/v1/providers/launchpad/gen/launchpad/model_node_location.go index 9b8050b..1ade4fc 100644 --- a/v1/providers/launchpad/gen/launchpad/model_node_location.go +++ b/v1/providers/launchpad/gen/launchpad/model_node_location.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_node_storage.go b/v1/providers/launchpad/gen/launchpad/model_node_storage.go index adb76c8..63eb92a 100644 --- a/v1/providers/launchpad/gen/launchpad/model_node_storage.go +++ b/v1/providers/launchpad/gen/launchpad/model_node_storage.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_oem.go b/v1/providers/launchpad/gen/launchpad/model_oem.go index 84468f5..9490342 100644 --- a/v1/providers/launchpad/gen/launchpad/model_oem.go +++ b/v1/providers/launchpad/gen/launchpad/model_oem.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_on_demand_speed_enum.go b/v1/providers/launchpad/gen/launchpad/model_on_demand_speed_enum.go index e020c3a..33e5269 100644 --- a/v1/providers/launchpad/gen/launchpad/model_on_demand_speed_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_on_demand_speed_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_overrides.go b/v1/providers/launchpad/gen/launchpad/model_overrides.go index dd09bac..6832b7c 100644 --- a/v1/providers/launchpad/gen/launchpad/model_overrides.go +++ b/v1/providers/launchpad/gen/launchpad/model_overrides.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_cluster_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_cluster_list.go index 8e9eab9..f87e6ee 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_cluster_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_cluster_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_cluster_pipeline_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_cluster_pipeline_list.go new file mode 100644 index 0000000..40a3b23 --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_cluster_pipeline_list.go @@ -0,0 +1,269 @@ +/* +NVIDIA LaunchPad API + +RESTful API for interacting with the NVIDIA LaunchPad platform + +API version: 2.40.9 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package openapi + +import ( + "encoding/json" + "fmt" +) + +// checks if the PaginatedClusterPipelineList type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &PaginatedClusterPipelineList{} + +// PaginatedClusterPipelineList struct for PaginatedClusterPipelineList +type PaginatedClusterPipelineList struct { + Count int32 `json:"count"` + Next *string `json:"next,omitempty"` + Previous *string `json:"previous,omitempty"` + Results []ClusterPipeline `json:"results"` + AdditionalProperties map[string]interface{} +} + +type _PaginatedClusterPipelineList PaginatedClusterPipelineList + +// NewPaginatedClusterPipelineList instantiates a new PaginatedClusterPipelineList object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPaginatedClusterPipelineList(count int32, results []ClusterPipeline) *PaginatedClusterPipelineList { + this := PaginatedClusterPipelineList{} + this.Count = count + this.Results = results + return &this +} + +// NewPaginatedClusterPipelineListWithDefaults instantiates a new PaginatedClusterPipelineList object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPaginatedClusterPipelineListWithDefaults() *PaginatedClusterPipelineList { + this := PaginatedClusterPipelineList{} + return &this +} + +// GetCount returns the Count field value +func (o *PaginatedClusterPipelineList) GetCount() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Count +} + +// GetCountOk returns a tuple with the Count field value +// and a boolean to check if the value has been set. +func (o *PaginatedClusterPipelineList) GetCountOk() (*int32, bool) { + if o == nil { + return nil, false + } + return &o.Count, true +} + +// SetCount sets field value +func (o *PaginatedClusterPipelineList) SetCount(v int32) { + o.Count = v +} + +// GetNext returns the Next field value if set, zero value otherwise. +func (o *PaginatedClusterPipelineList) GetNext() string { + if o == nil || IsNil(o.Next) { + var ret string + return ret + } + return *o.Next +} + +// GetNextOk returns a tuple with the Next field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PaginatedClusterPipelineList) GetNextOk() (*string, bool) { + if o == nil || IsNil(o.Next) { + return nil, false + } + return o.Next, true +} + +// HasNext returns a boolean if a field has been set. +func (o *PaginatedClusterPipelineList) HasNext() bool { + if o != nil && !IsNil(o.Next) { + return true + } + + return false +} + +// SetNext gets a reference to the given string and assigns it to the Next field. +func (o *PaginatedClusterPipelineList) SetNext(v string) { + o.Next = &v +} + +// GetPrevious returns the Previous field value if set, zero value otherwise. +func (o *PaginatedClusterPipelineList) GetPrevious() string { + if o == nil || IsNil(o.Previous) { + var ret string + return ret + } + return *o.Previous +} + +// GetPreviousOk returns a tuple with the Previous field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PaginatedClusterPipelineList) GetPreviousOk() (*string, bool) { + if o == nil || IsNil(o.Previous) { + return nil, false + } + return o.Previous, true +} + +// HasPrevious returns a boolean if a field has been set. +func (o *PaginatedClusterPipelineList) HasPrevious() bool { + if o != nil && !IsNil(o.Previous) { + return true + } + + return false +} + +// SetPrevious gets a reference to the given string and assigns it to the Previous field. +func (o *PaginatedClusterPipelineList) SetPrevious(v string) { + o.Previous = &v +} + +// GetResults returns the Results field value +func (o *PaginatedClusterPipelineList) GetResults() []ClusterPipeline { + if o == nil { + var ret []ClusterPipeline + return ret + } + + return o.Results +} + +// GetResultsOk returns a tuple with the Results field value +// and a boolean to check if the value has been set. +func (o *PaginatedClusterPipelineList) GetResultsOk() ([]ClusterPipeline, bool) { + if o == nil { + return nil, false + } + return o.Results, true +} + +// SetResults sets field value +func (o *PaginatedClusterPipelineList) SetResults(v []ClusterPipeline) { + o.Results = v +} + +func (o PaginatedClusterPipelineList) MarshalJSON() ([]byte, error) { + toSerialize, err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o PaginatedClusterPipelineList) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["count"] = o.Count + if !IsNil(o.Next) { + toSerialize["next"] = o.Next + } + if !IsNil(o.Previous) { + toSerialize["previous"] = o.Previous + } + toSerialize["results"] = o.Results + + for key, value := range o.AdditionalProperties { + toSerialize[key] = value + } + + return toSerialize, nil +} + +func (o *PaginatedClusterPipelineList) UnmarshalJSON(data []byte) (err error) { + // This validates that all required properties are included in the JSON object + // by unmarshalling the object into a generic map with string keys and checking + // that every required field exists as a key in the generic map. + requiredProperties := []string{ + "count", + "results", + } + + allProperties := make(map[string]interface{}) + + err = json.Unmarshal(data, &allProperties) + + if err != nil { + return err + } + + for _, requiredProperty := range requiredProperties { + if _, exists := allProperties[requiredProperty]; !exists { + return fmt.Errorf("no value given for required property %v", requiredProperty) + } + } + + varPaginatedClusterPipelineList := _PaginatedClusterPipelineList{} + + err = json.Unmarshal(data, &varPaginatedClusterPipelineList) + + if err != nil { + return err + } + + *o = PaginatedClusterPipelineList(varPaginatedClusterPipelineList) + + additionalProperties := make(map[string]interface{}) + + if err = json.Unmarshal(data, &additionalProperties); err == nil { + delete(additionalProperties, "count") + delete(additionalProperties, "next") + delete(additionalProperties, "previous") + delete(additionalProperties, "results") + o.AdditionalProperties = additionalProperties + } + + return err +} + +type NullablePaginatedClusterPipelineList struct { + value *PaginatedClusterPipelineList + isSet bool +} + +func (v NullablePaginatedClusterPipelineList) Get() *PaginatedClusterPipelineList { + return v.value +} + +func (v *NullablePaginatedClusterPipelineList) Set(val *PaginatedClusterPipelineList) { + v.value = val + v.isSet = true +} + +func (v NullablePaginatedClusterPipelineList) IsSet() bool { + return v.isSet +} + +func (v *NullablePaginatedClusterPipelineList) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePaginatedClusterPipelineList(val *PaginatedClusterPipelineList) *NullablePaginatedClusterPipelineList { + return &NullablePaginatedClusterPipelineList{value: val, isSet: true} +} + +func (v NullablePaginatedClusterPipelineList) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePaginatedClusterPipelineList) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_instance_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_instance_list.go index 4920719..9416fba 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_instance_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_instance_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_key_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_key_list.go index fe72431..4cecdc9 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_key_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_key_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_list.go index 4f9d788..1f038f0 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_note_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_note_list.go index 7f4582b..b0e0941 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_note_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_note_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_pipeline_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_pipeline_list.go index 35649f6..e490c07 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_pipeline_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_pipeline_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_service_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_service_list.go index a53b1f7..d4a2aed 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_service_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_service_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_task_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_task_list.go index 8055298..cc0680b 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_task_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_deployment_task_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_experience_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_experience_list.go index 7ac34bc..e7bb7f8 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_experience_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_experience_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_experience_note_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_experience_note_list.go index fb4e46a..78c2998 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_experience_note_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_experience_note_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_list.go index e61f319..d792997 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_os_choice_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_os_choice_list.go index 897b718..18ada55 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_os_choice_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_gpu_os_choice_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_instance_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_instance_list.go index 2ec7571..6aa588b 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_instance_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_instance_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_instance_type_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_instance_type_list.go index e0ce800..9d9711f 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_instance_type_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_instance_type_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_location_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_location_list.go index 809b1da..08e0982 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_location_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_location_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_model_change_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_model_change_list.go index 2109abd..d41939a 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_model_change_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_model_change_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_node_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_node_list.go index dc8de3c..3718ae2 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_node_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_node_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_oem_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_oem_list.go index 8119060..a9a4132 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_oem_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_oem_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_persona_choice_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_persona_choice_list.go index 843d781..364c1df 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_persona_choice_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_persona_choice_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_provider_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_provider_list.go index 7c32030..41dcfc6 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_provider_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_provider_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_runtime_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_runtime_list.go index f3eb20f..98caf2d 100644 --- a/v1/providers/launchpad/gen/launchpad/model_paginated_runtime_list.go +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_runtime_list.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_paginated_v_gpu_profile_choice_list.go b/v1/providers/launchpad/gen/launchpad/model_paginated_v_gpu_profile_choice_list.go new file mode 100644 index 0000000..891e2a5 --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/model_paginated_v_gpu_profile_choice_list.go @@ -0,0 +1,269 @@ +/* +NVIDIA LaunchPad API + +RESTful API for interacting with the NVIDIA LaunchPad platform + +API version: 2.40.9 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package openapi + +import ( + "encoding/json" + "fmt" +) + +// checks if the PaginatedVGpuProfileChoiceList type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &PaginatedVGpuProfileChoiceList{} + +// PaginatedVGpuProfileChoiceList struct for PaginatedVGpuProfileChoiceList +type PaginatedVGpuProfileChoiceList struct { + Count int32 `json:"count"` + Next *string `json:"next,omitempty"` + Previous *string `json:"previous,omitempty"` + Results []VGpuProfileChoice `json:"results"` + AdditionalProperties map[string]interface{} +} + +type _PaginatedVGpuProfileChoiceList PaginatedVGpuProfileChoiceList + +// NewPaginatedVGpuProfileChoiceList instantiates a new PaginatedVGpuProfileChoiceList object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPaginatedVGpuProfileChoiceList(count int32, results []VGpuProfileChoice) *PaginatedVGpuProfileChoiceList { + this := PaginatedVGpuProfileChoiceList{} + this.Count = count + this.Results = results + return &this +} + +// NewPaginatedVGpuProfileChoiceListWithDefaults instantiates a new PaginatedVGpuProfileChoiceList object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPaginatedVGpuProfileChoiceListWithDefaults() *PaginatedVGpuProfileChoiceList { + this := PaginatedVGpuProfileChoiceList{} + return &this +} + +// GetCount returns the Count field value +func (o *PaginatedVGpuProfileChoiceList) GetCount() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Count +} + +// GetCountOk returns a tuple with the Count field value +// and a boolean to check if the value has been set. +func (o *PaginatedVGpuProfileChoiceList) GetCountOk() (*int32, bool) { + if o == nil { + return nil, false + } + return &o.Count, true +} + +// SetCount sets field value +func (o *PaginatedVGpuProfileChoiceList) SetCount(v int32) { + o.Count = v +} + +// GetNext returns the Next field value if set, zero value otherwise. +func (o *PaginatedVGpuProfileChoiceList) GetNext() string { + if o == nil || IsNil(o.Next) { + var ret string + return ret + } + return *o.Next +} + +// GetNextOk returns a tuple with the Next field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PaginatedVGpuProfileChoiceList) GetNextOk() (*string, bool) { + if o == nil || IsNil(o.Next) { + return nil, false + } + return o.Next, true +} + +// HasNext returns a boolean if a field has been set. +func (o *PaginatedVGpuProfileChoiceList) HasNext() bool { + if o != nil && !IsNil(o.Next) { + return true + } + + return false +} + +// SetNext gets a reference to the given string and assigns it to the Next field. +func (o *PaginatedVGpuProfileChoiceList) SetNext(v string) { + o.Next = &v +} + +// GetPrevious returns the Previous field value if set, zero value otherwise. +func (o *PaginatedVGpuProfileChoiceList) GetPrevious() string { + if o == nil || IsNil(o.Previous) { + var ret string + return ret + } + return *o.Previous +} + +// GetPreviousOk returns a tuple with the Previous field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PaginatedVGpuProfileChoiceList) GetPreviousOk() (*string, bool) { + if o == nil || IsNil(o.Previous) { + return nil, false + } + return o.Previous, true +} + +// HasPrevious returns a boolean if a field has been set. +func (o *PaginatedVGpuProfileChoiceList) HasPrevious() bool { + if o != nil && !IsNil(o.Previous) { + return true + } + + return false +} + +// SetPrevious gets a reference to the given string and assigns it to the Previous field. +func (o *PaginatedVGpuProfileChoiceList) SetPrevious(v string) { + o.Previous = &v +} + +// GetResults returns the Results field value +func (o *PaginatedVGpuProfileChoiceList) GetResults() []VGpuProfileChoice { + if o == nil { + var ret []VGpuProfileChoice + return ret + } + + return o.Results +} + +// GetResultsOk returns a tuple with the Results field value +// and a boolean to check if the value has been set. +func (o *PaginatedVGpuProfileChoiceList) GetResultsOk() ([]VGpuProfileChoice, bool) { + if o == nil { + return nil, false + } + return o.Results, true +} + +// SetResults sets field value +func (o *PaginatedVGpuProfileChoiceList) SetResults(v []VGpuProfileChoice) { + o.Results = v +} + +func (o PaginatedVGpuProfileChoiceList) MarshalJSON() ([]byte, error) { + toSerialize, err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o PaginatedVGpuProfileChoiceList) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["count"] = o.Count + if !IsNil(o.Next) { + toSerialize["next"] = o.Next + } + if !IsNil(o.Previous) { + toSerialize["previous"] = o.Previous + } + toSerialize["results"] = o.Results + + for key, value := range o.AdditionalProperties { + toSerialize[key] = value + } + + return toSerialize, nil +} + +func (o *PaginatedVGpuProfileChoiceList) UnmarshalJSON(data []byte) (err error) { + // This validates that all required properties are included in the JSON object + // by unmarshalling the object into a generic map with string keys and checking + // that every required field exists as a key in the generic map. + requiredProperties := []string{ + "count", + "results", + } + + allProperties := make(map[string]interface{}) + + err = json.Unmarshal(data, &allProperties) + + if err != nil { + return err + } + + for _, requiredProperty := range requiredProperties { + if _, exists := allProperties[requiredProperty]; !exists { + return fmt.Errorf("no value given for required property %v", requiredProperty) + } + } + + varPaginatedVGpuProfileChoiceList := _PaginatedVGpuProfileChoiceList{} + + err = json.Unmarshal(data, &varPaginatedVGpuProfileChoiceList) + + if err != nil { + return err + } + + *o = PaginatedVGpuProfileChoiceList(varPaginatedVGpuProfileChoiceList) + + additionalProperties := make(map[string]interface{}) + + if err = json.Unmarshal(data, &additionalProperties); err == nil { + delete(additionalProperties, "count") + delete(additionalProperties, "next") + delete(additionalProperties, "previous") + delete(additionalProperties, "results") + o.AdditionalProperties = additionalProperties + } + + return err +} + +type NullablePaginatedVGpuProfileChoiceList struct { + value *PaginatedVGpuProfileChoiceList + isSet bool +} + +func (v NullablePaginatedVGpuProfileChoiceList) Get() *PaginatedVGpuProfileChoiceList { + return v.value +} + +func (v *NullablePaginatedVGpuProfileChoiceList) Set(val *PaginatedVGpuProfileChoiceList) { + v.value = val + v.isSet = true +} + +func (v NullablePaginatedVGpuProfileChoiceList) IsSet() bool { + return v.isSet +} + +func (v *NullablePaginatedVGpuProfileChoiceList) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePaginatedVGpuProfileChoiceList(val *PaginatedVGpuProfileChoiceList) *NullablePaginatedVGpuProfileChoiceList { + return &NullablePaginatedVGpuProfileChoiceList{value: val, isSet: true} +} + +func (v NullablePaginatedVGpuProfileChoiceList) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePaginatedVGpuProfileChoiceList) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v1/providers/launchpad/gen/launchpad/model_password_change.go b/v1/providers/launchpad/gen/launchpad/model_password_change.go index b0215d4..a68f678 100644 --- a/v1/providers/launchpad/gen/launchpad/model_password_change.go +++ b/v1/providers/launchpad/gen/launchpad/model_password_change.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_persona_choice.go b/v1/providers/launchpad/gen/launchpad/model_persona_choice.go index 7bd5ffd..78dc9cc 100644 --- a/v1/providers/launchpad/gen/launchpad/model_persona_choice.go +++ b/v1/providers/launchpad/gen/launchpad/model_persona_choice.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_pipeline_action.go b/v1/providers/launchpad/gen/launchpad/model_pipeline_action.go index 36d0c8b..650f689 100644 --- a/v1/providers/launchpad/gen/launchpad/model_pipeline_action.go +++ b/v1/providers/launchpad/gen/launchpad/model_pipeline_action.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_platform_enum.go b/v1/providers/launchpad/gen/launchpad/model_platform_enum.go index ca75ed3..eecb9a8 100644 --- a/v1/providers/launchpad/gen/launchpad/model_platform_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_platform_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -15,7 +15,7 @@ import ( "fmt" ) -// PlatformEnum * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 +// PlatformEnum * `air` - NVIDIA Air * `flight_deck` - Flight Deck * `kvm_bastion` - KVM Bastion * `lp-vmware-platform` - lp-vmware-platform * `minimal` - minimal * `openshift` - OpenShift * `proxmox` - Proxmox * `vsphere` - vSphere * `vsphere_horizon` - VMware Horizon * `vsphere7` - vSphere 7 * `vsphere8` - vSphere 8 type PlatformEnum string // List of PlatformEnum @@ -26,6 +26,7 @@ const ( PlatformLpVmwarePlatformLegacy PlatformEnum = "lp-vmware-platform" PlatformMinimal PlatformEnum = "minimal" PlatformOpenshift PlatformEnum = "openshift" + PlatformProxmox PlatformEnum = "proxmox" PlatformVsphere PlatformEnum = "vsphere" PlatformVsphereHorizon PlatformEnum = "vsphere_horizon" PlatformVsphere7 PlatformEnum = "vsphere7" @@ -40,6 +41,7 @@ var AllowedPlatformEnumEnumValues = []PlatformEnum{ "lp-vmware-platform", "minimal", "openshift", + "proxmox", "vsphere", "vsphere_horizon", "vsphere7", diff --git a/v1/providers/launchpad/gen/launchpad/model_preferred_theme_enum.go b/v1/providers/launchpad/gen/launchpad/model_preferred_theme_enum.go index 6f08fc6..3801f13 100644 --- a/v1/providers/launchpad/gen/launchpad/model_preferred_theme_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_preferred_theme_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_priority_enum.go b/v1/providers/launchpad/gen/launchpad/model_priority_enum.go index f9c1f0c..3cf6101 100644 --- a/v1/providers/launchpad/gen/launchpad/model_priority_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_priority_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_profile.go b/v1/providers/launchpad/gen/launchpad/model_profile.go index fccad4e..bcdaade 100644 --- a/v1/providers/launchpad/gen/launchpad/model_profile.go +++ b/v1/providers/launchpad/gen/launchpad/model_profile.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. @@ -23,8 +23,10 @@ var _ MappedNullable = &Profile{} type Profile struct { // Timestamp of when the object was created Created time.Time `json:"created"` - Groups []string `json:"groups"` - Id string `json:"id"` + // Display name of the user + DisplayName NullableString `json:"display_name"` + Groups []string `json:"groups"` + Id string `json:"id"` // Timestamp of when the object was last modified Modified time.Time `json:"modified"` PreferredTheme NullablePreferredThemeEnum `json:"preferred_theme,omitempty"` @@ -39,9 +41,10 @@ type _Profile Profile // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewProfile(created time.Time, groups []string, id string, modified time.Time, username string) *Profile { +func NewProfile(created time.Time, displayName NullableString, groups []string, id string, modified time.Time, username string) *Profile { this := Profile{} this.Created = created + this.DisplayName = displayName this.Groups = groups this.Id = id this.Modified = modified @@ -81,6 +84,32 @@ func (o *Profile) SetCreated(v time.Time) { o.Created = v } +// GetDisplayName returns the DisplayName field value +// If the value is explicit nil, the zero value for string will be returned +func (o *Profile) GetDisplayName() string { + if o == nil || o.DisplayName.Get() == nil { + var ret string + return ret + } + + return *o.DisplayName.Get() +} + +// GetDisplayNameOk returns a tuple with the DisplayName field value +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *Profile) GetDisplayNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.DisplayName.Get(), o.DisplayName.IsSet() +} + +// SetDisplayName sets field value +func (o *Profile) SetDisplayName(v string) { + o.DisplayName.Set(&v) +} + // GetGroups returns the Groups field value func (o *Profile) GetGroups() []string { if o == nil { @@ -264,6 +293,7 @@ func (o Profile) MarshalJSON() ([]byte, error) { func (o Profile) ToMap() (map[string]interface{}, error) { toSerialize := map[string]interface{}{} toSerialize["created"] = o.Created + toSerialize["display_name"] = o.DisplayName.Get() toSerialize["groups"] = o.Groups toSerialize["id"] = o.Id toSerialize["modified"] = o.Modified @@ -288,6 +318,7 @@ func (o *Profile) UnmarshalJSON(data []byte) (err error) { // that every required field exists as a key in the generic map. requiredProperties := []string{ "created", + "display_name", "groups", "id", "modified", @@ -322,6 +353,7 @@ func (o *Profile) UnmarshalJSON(data []byte) (err error) { if err = json.Unmarshal(data, &additionalProperties); err == nil { delete(additionalProperties, "created") + delete(additionalProperties, "display_name") delete(additionalProperties, "groups") delete(additionalProperties, "id") delete(additionalProperties, "modified") diff --git a/v1/providers/launchpad/gen/launchpad/model_provider.go b/v1/providers/launchpad/gen/launchpad/model_provider.go index 26a68c0..ec6bd8f 100644 --- a/v1/providers/launchpad/gen/launchpad/model_provider.go +++ b/v1/providers/launchpad/gen/launchpad/model_provider.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_provider_bulk_update.go b/v1/providers/launchpad/gen/launchpad/model_provider_bulk_update.go index 5c5b18c..b025dd2 100644 --- a/v1/providers/launchpad/gen/launchpad/model_provider_bulk_update.go +++ b/v1/providers/launchpad/gen/launchpad/model_provider_bulk_update.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_provisioning_request.go b/v1/providers/launchpad/gen/launchpad/model_provisioning_request.go index 78b1c63..fdab99f 100644 --- a/v1/providers/launchpad/gen/launchpad/model_provisioning_request.go +++ b/v1/providers/launchpad/gen/launchpad/model_provisioning_request.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_provisioning_state_enum.go b/v1/providers/launchpad/gen/launchpad/model_provisioning_state_enum.go index 293ef35..3930b63 100644 --- a/v1/providers/launchpad/gen/launchpad/model_provisioning_state_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_provisioning_state_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_published_enum.go b/v1/providers/launchpad/gen/launchpad/model_published_enum.go index 8ccdd5d..83e5d35 100644 --- a/v1/providers/launchpad/gen/launchpad/model_published_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_published_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_runtime.go b/v1/providers/launchpad/gen/launchpad/model_runtime.go index 911dc9b..7889632 100644 --- a/v1/providers/launchpad/gen/launchpad/model_runtime.go +++ b/v1/providers/launchpad/gen/launchpad/model_runtime.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_status_enum.go b/v1/providers/launchpad/gen/launchpad/model_status_enum.go index d2676d6..e0bb49f 100644 --- a/v1/providers/launchpad/gen/launchpad/model_status_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_status_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_system_arch_enum.go b/v1/providers/launchpad/gen/launchpad/model_system_arch_enum.go index 247ab7c..85e8644 100644 --- a/v1/providers/launchpad/gen/launchpad/model_system_arch_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_system_arch_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_tenant.go b/v1/providers/launchpad/gen/launchpad/model_tenant.go index 109bc04..508796c 100644 --- a/v1/providers/launchpad/gen/launchpad/model_tenant.go +++ b/v1/providers/launchpad/gen/launchpad/model_tenant.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_type_enum.go b/v1/providers/launchpad/gen/launchpad/model_type_enum.go index f1f8d2a..5ea7d3a 100644 --- a/v1/providers/launchpad/gen/launchpad/model_type_enum.go +++ b/v1/providers/launchpad/gen/launchpad/model_type_enum.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_v_gpu_profile_choice.go b/v1/providers/launchpad/gen/launchpad/model_v_gpu_profile_choice.go new file mode 100644 index 0000000..099a28a --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/model_v_gpu_profile_choice.go @@ -0,0 +1,256 @@ +/* +NVIDIA LaunchPad API + +RESTful API for interacting with the NVIDIA LaunchPad platform + +API version: 2.40.9 +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package openapi + +import ( + "encoding/json" + "fmt" + "time" +) + +// checks if the VGpuProfileChoice type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &VGpuProfileChoice{} + +// VGpuProfileChoice struct for VGpuProfileChoice +type VGpuProfileChoice struct { + // Timestamp of when the object was created + Created time.Time `json:"created"` + Id int32 `json:"id"` + // Timestamp of when the object was last modified + Modified time.Time `json:"modified"` + Name string `json:"name"` + AdditionalProperties map[string]interface{} +} + +type _VGpuProfileChoice VGpuProfileChoice + +// NewVGpuProfileChoice instantiates a new VGpuProfileChoice object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewVGpuProfileChoice(created time.Time, id int32, modified time.Time, name string) *VGpuProfileChoice { + this := VGpuProfileChoice{} + this.Created = created + this.Id = id + this.Modified = modified + this.Name = name + return &this +} + +// NewVGpuProfileChoiceWithDefaults instantiates a new VGpuProfileChoice object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewVGpuProfileChoiceWithDefaults() *VGpuProfileChoice { + this := VGpuProfileChoice{} + return &this +} + +// GetCreated returns the Created field value +func (o *VGpuProfileChoice) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// GetCreatedOk returns a tuple with the Created field value +// and a boolean to check if the value has been set. +func (o *VGpuProfileChoice) GetCreatedOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.Created, true +} + +// SetCreated sets field value +func (o *VGpuProfileChoice) SetCreated(v time.Time) { + o.Created = v +} + +// GetId returns the Id field value +func (o *VGpuProfileChoice) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// GetIdOk returns a tuple with the Id field value +// and a boolean to check if the value has been set. +func (o *VGpuProfileChoice) GetIdOk() (*int32, bool) { + if o == nil { + return nil, false + } + return &o.Id, true +} + +// SetId sets field value +func (o *VGpuProfileChoice) SetId(v int32) { + o.Id = v +} + +// GetModified returns the Modified field value +func (o *VGpuProfileChoice) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value +// and a boolean to check if the value has been set. +func (o *VGpuProfileChoice) GetModifiedOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.Modified, true +} + +// SetModified sets field value +func (o *VGpuProfileChoice) SetModified(v time.Time) { + o.Modified = v +} + +// GetName returns the Name field value +func (o *VGpuProfileChoice) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// GetNameOk returns a tuple with the Name field value +// and a boolean to check if the value has been set. +func (o *VGpuProfileChoice) GetNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Name, true +} + +// SetName sets field value +func (o *VGpuProfileChoice) SetName(v string) { + o.Name = v +} + +func (o VGpuProfileChoice) MarshalJSON() ([]byte, error) { + toSerialize, err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o VGpuProfileChoice) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["created"] = o.Created + toSerialize["id"] = o.Id + toSerialize["modified"] = o.Modified + toSerialize["name"] = o.Name + + for key, value := range o.AdditionalProperties { + toSerialize[key] = value + } + + return toSerialize, nil +} + +func (o *VGpuProfileChoice) UnmarshalJSON(data []byte) (err error) { + // This validates that all required properties are included in the JSON object + // by unmarshalling the object into a generic map with string keys and checking + // that every required field exists as a key in the generic map. + requiredProperties := []string{ + "created", + "id", + "modified", + "name", + } + + allProperties := make(map[string]interface{}) + + err = json.Unmarshal(data, &allProperties) + + if err != nil { + return err + } + + for _, requiredProperty := range requiredProperties { + if _, exists := allProperties[requiredProperty]; !exists { + return fmt.Errorf("no value given for required property %v", requiredProperty) + } + } + + varVGpuProfileChoice := _VGpuProfileChoice{} + + err = json.Unmarshal(data, &varVGpuProfileChoice) + + if err != nil { + return err + } + + *o = VGpuProfileChoice(varVGpuProfileChoice) + + additionalProperties := make(map[string]interface{}) + + if err = json.Unmarshal(data, &additionalProperties); err == nil { + delete(additionalProperties, "created") + delete(additionalProperties, "id") + delete(additionalProperties, "modified") + delete(additionalProperties, "name") + o.AdditionalProperties = additionalProperties + } + + return err +} + +type NullableVGpuProfileChoice struct { + value *VGpuProfileChoice + isSet bool +} + +func (v NullableVGpuProfileChoice) Get() *VGpuProfileChoice { + return v.value +} + +func (v *NullableVGpuProfileChoice) Set(val *VGpuProfileChoice) { + v.value = val + v.isSet = true +} + +func (v NullableVGpuProfileChoice) IsSet() bool { + return v.isSet +} + +func (v *NullableVGpuProfileChoice) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableVGpuProfileChoice(val *VGpuProfileChoice) *NullableVGpuProfileChoice { + return &NullableVGpuProfileChoice{value: val, isSet: true} +} + +func (v NullableVGpuProfileChoice) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableVGpuProfileChoice) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} diff --git a/v1/providers/launchpad/gen/launchpad/model_version_retrieve_200_response.go b/v1/providers/launchpad/gen/launchpad/model_version_retrieve_200_response.go index 6827109..3345912 100644 --- a/v1/providers/launchpad/gen/launchpad/model_version_retrieve_200_response.go +++ b/v1/providers/launchpad/gen/launchpad/model_version_retrieve_200_response.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/model_vgpu_profile_enum.go b/v1/providers/launchpad/gen/launchpad/model_vgpu_profile_enum.go deleted file mode 100644 index c0b3fe8..0000000 --- a/v1/providers/launchpad/gen/launchpad/model_vgpu_profile_enum.go +++ /dev/null @@ -1,132 +0,0 @@ -/* -NVIDIA LaunchPad API - -RESTful API for interacting with the NVIDIA LaunchPad platform - -API version: 2.39.5 -*/ - -// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. - -package openapi - -import ( - "encoding/json" - "fmt" -) - -// VgpuProfileEnum * `air` - NVIDIA Air * `bright_cluster` - Bright Cluster * `bright-cluster` - Bright Cluster (legacy option) * `flight_deck` - Flight Deck * `flight-deck` - Flight Deck (legacy option) * `nvidia_a40-48q` - nvidia_a40-48q * `nvidia-ai-enterprise` - NVIDIA AI Enterprise * `nvidia_l40s-48q` - nvidia_l40s-48q * `nvidia_rtx_pro_6000_blackwell_dc-4-96q` - nvidia_rtx_pro_6000_blackwell_dc-4-96q * `nvidia_rtx_pro_6000_blackwell_dc-96q` - nvidia_rtx_pro_6000_blackwell_dc-96q * `openshift` - OpenShift * `platform_only` - platform_only * `vmware_itadmin` - VMware IT admin -type VgpuProfileEnum string - -// List of VgpuProfileEnum -const ( - VgpuProfileAir VgpuProfileEnum = "air" - VgpuProfileBrightCluster VgpuProfileEnum = "bright_cluster" - VgpuProfileBrightClusterLegacy VgpuProfileEnum = "bright-cluster" - VgpuProfileFlightDeck VgpuProfileEnum = "flight_deck" - VgpuProfileFlightDeckLegacy VgpuProfileEnum = "flight-deck" - VgpuProfileNvidiaA4048QLegacy VgpuProfileEnum = "nvidia_a40-48q" - VgpuProfileNvidiaAiEnterpriseLegacy VgpuProfileEnum = "nvidia-ai-enterprise" - VgpuProfileNvidiaL40s48QLegacy VgpuProfileEnum = "nvidia_l40s-48q" - VgpuProfileNvidiaRtxPro6000BlackwellDc496QLegacy VgpuProfileEnum = "nvidia_rtx_pro_6000_blackwell_dc-4-96q" - VgpuProfileNvidiaRtxPro6000BlackwellDc96QLegacy VgpuProfileEnum = "nvidia_rtx_pro_6000_blackwell_dc-96q" - VgpuProfileOpenshift VgpuProfileEnum = "openshift" - VgpuProfilePlatformOnly VgpuProfileEnum = "platform_only" - VgpuProfileVmwareItadmin VgpuProfileEnum = "vmware_itadmin" -) - -// All allowed values of VgpuProfileEnum enum -var AllowedVgpuProfileEnumEnumValues = []VgpuProfileEnum{ - "air", - "bright_cluster", - "bright-cluster", - "flight_deck", - "flight-deck", - "nvidia_a40-48q", - "nvidia-ai-enterprise", - "nvidia_l40s-48q", - "nvidia_rtx_pro_6000_blackwell_dc-4-96q", - "nvidia_rtx_pro_6000_blackwell_dc-96q", - "openshift", - "platform_only", - "vmware_itadmin", -} - -func (v *VgpuProfileEnum) UnmarshalJSON(src []byte) error { - var value string - err := json.Unmarshal(src, &value) - if err != nil { - return err - } - enumTypeValue := VgpuProfileEnum(value) - for _, existing := range AllowedVgpuProfileEnumEnumValues { - if existing == enumTypeValue { - *v = enumTypeValue - return nil - } - } - - return fmt.Errorf("%+v is not a valid VgpuProfileEnum", value) -} - -// NewVgpuProfileEnumFromValue returns a pointer to a valid VgpuProfileEnum -// for the value passed as argument, or an error if the value passed is not allowed by the enum -func NewVgpuProfileEnumFromValue(v string) (*VgpuProfileEnum, error) { - ev := VgpuProfileEnum(v) - if ev.IsValid() { - return &ev, nil - } else { - return nil, fmt.Errorf("invalid value '%v' for VgpuProfileEnum: valid values are %v", v, AllowedVgpuProfileEnumEnumValues) - } -} - -// IsValid return true if the value is valid for the enum, false otherwise -func (v VgpuProfileEnum) IsValid() bool { - for _, existing := range AllowedVgpuProfileEnumEnumValues { - if existing == v { - return true - } - } - return false -} - -// Ptr returns reference to VgpuProfileEnum value -func (v VgpuProfileEnum) Ptr() *VgpuProfileEnum { - return &v -} - -type NullableVgpuProfileEnum struct { - value *VgpuProfileEnum - isSet bool -} - -func (v NullableVgpuProfileEnum) Get() *VgpuProfileEnum { - return v.value -} - -func (v *NullableVgpuProfileEnum) Set(val *VgpuProfileEnum) { - v.value = val - v.isSet = true -} - -func (v NullableVgpuProfileEnum) IsSet() bool { - return v.isSet -} - -func (v *NullableVgpuProfileEnum) Unset() { - v.value = nil - v.isSet = false -} - -func NewNullableVgpuProfileEnum(val *VgpuProfileEnum) *NullableVgpuProfileEnum { - return &NullableVgpuProfileEnum{value: val, isSet: true} -} - -func (v NullableVgpuProfileEnum) MarshalJSON() ([]byte, error) { - return json.Marshal(v.value) -} - -func (v *NullableVgpuProfileEnum) UnmarshalJSON(src []byte) error { - v.isSet = true - return json.Unmarshal(src, &v.value) -} diff --git a/v1/providers/launchpad/gen/launchpad/response.go b/v1/providers/launchpad/gen/launchpad/response.go index 23312ea..c70f1c0 100644 --- a/v1/providers/launchpad/gen/launchpad/response.go +++ b/v1/providers/launchpad/gen/launchpad/response.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/gen/launchpad/test/api_auth_test.go b/v1/providers/launchpad/gen/launchpad/test/api_auth_test.go index bb71399..f2db4fd 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_auth_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_auth_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_AuthAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test AuthAPIService V1AuthLoginCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.AuthAPI.V1AuthLoginCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_AuthAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test AuthAPIService V1AuthLogoutCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.AuthAPI.V1AuthLogoutCreate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_AuthAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test AuthAPIService V1AuthPasswordChangeCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.AuthAPI.V1AuthPasswordChangeCreate(context.Background()).Execute() @@ -50,9 +55,11 @@ func Test_openapi_AuthAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test AuthAPIService V1AuthRedirectRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.AuthAPI.V1AuthRedirectRetrieve(context.Background()).Execute() @@ -60,5 +67,7 @@ func Test_openapi_AuthAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_catalog_deployments_test.go b/v1/providers/launchpad/gen/launchpad/test/api_catalog_deployments_test.go index bc3f1a7..5dbe6e5 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_catalog_deployments_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_catalog_deployments_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsBulkPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsBulkPartialUpdate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsCreate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -52,9 +57,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -64,9 +71,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsInstancesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -76,9 +85,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsList(context.Background()).Execute() @@ -86,9 +97,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsNotesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -98,9 +111,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsNotesDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -110,9 +125,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsNotesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -122,9 +139,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsNotesPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -135,9 +154,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsNotesRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -148,9 +169,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsNotesUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -161,9 +184,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -173,9 +198,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsPipelinesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -185,9 +212,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsPipelinesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -197,9 +226,25 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsPipelinesTriggerCreate", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var id string + + resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsPipelinesTriggerCreate(context.Background(), id).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -209,9 +254,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsServicesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -221,9 +268,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsServicesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -233,9 +282,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsSshKeysCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -245,9 +296,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsSshKeysDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -257,9 +310,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsSshKeysList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -269,18 +324,22 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsStatsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsStatsRetrieve(context.Background()).Execute() require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsTasksCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -290,9 +349,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsTasksList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -302,9 +363,11 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsTasksRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var deploymentId string @@ -315,92 +378,21 @@ func Test_openapi_CatalogDeploymentsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) - }) - - t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsUpdate", func(t *testing.T) { - t.Skip("skip test") // remove to run test - var id string - - resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsUpdate(context.Background(), id).Execute() - - require.Nil(t, err) - require.NotNil(t, resp) - assert.Equal(t, 200, httpRes.StatusCode) }) - t.Run("Test CatalogDeploymentsAPIService V1CatalogExperiencesNotesCreate", func(t *testing.T) { - t.Skip("skip test") // remove to run test - - var experienceId string - - resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesCreate(context.Background(), experienceId).Execute() - - require.Nil(t, err) - require.NotNil(t, resp) - assert.Equal(t, 200, httpRes.StatusCode) - }) - - t.Run("Test CatalogDeploymentsAPIService V1CatalogExperiencesNotesDestroy", func(t *testing.T) { - t.Skip("skip test") // remove to run test - - var experienceId string - var id string - - httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesDestroy(context.Background(), experienceId, id).Execute() - - require.Nil(t, err) - assert.Equal(t, 200, httpRes.StatusCode) - }) - - t.Run("Test CatalogDeploymentsAPIService V1CatalogExperiencesNotesList", func(t *testing.T) { - t.Skip("skip test") // remove to run test - - var experienceId string - - resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesList(context.Background(), experienceId).Execute() - - require.Nil(t, err) - require.NotNil(t, resp) - assert.Equal(t, 200, httpRes.StatusCode) - }) + t.Run("Test CatalogDeploymentsAPIService V1CatalogDeploymentsUpdate", func(t *testing.T) { - t.Run("Test CatalogDeploymentsAPIService V1CatalogExperiencesNotesPartialUpdate", func(t *testing.T) { t.Skip("skip test") // remove to run test - var experienceId string var id string - resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesPartialUpdate(context.Background(), experienceId, id).Execute() + resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogDeploymentsUpdate(context.Background(), id).Execute() require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) - }) - - t.Run("Test CatalogDeploymentsAPIService V1CatalogExperiencesNotesRetrieve", func(t *testing.T) { - t.Skip("skip test") // remove to run test - var experienceId string - var id string - - resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesRetrieve(context.Background(), experienceId, id).Execute() - - require.Nil(t, err) - require.NotNil(t, resp) - assert.Equal(t, 200, httpRes.StatusCode) }) - t.Run("Test CatalogDeploymentsAPIService V1CatalogExperiencesNotesUpdate", func(t *testing.T) { - t.Skip("skip test") // remove to run test - - var experienceId string - var id string - - resp, httpRes, err := apiClient.CatalogDeploymentsAPI.V1CatalogExperiencesNotesUpdate(context.Background(), experienceId, id).Execute() - - require.Nil(t, err) - require.NotNil(t, resp) - assert.Equal(t, 200, httpRes.StatusCode) - }) } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_catalog_experiences_test.go b/v1/providers/launchpad/gen/launchpad/test/api_catalog_experiences_test.go index 6accd96..651490a 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_catalog_experiences_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_catalog_experiences_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesBulkCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesBulkCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesBulkPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesBulkPartialUpdate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesCreate(context.Background()).Execute() @@ -50,9 +55,11 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -61,9 +68,11 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -73,9 +82,11 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesList(context.Background()).Execute() @@ -83,9 +94,98 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesNotesCreate", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var experienceId string + + resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesCreate(context.Background(), experienceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesNotesDestroy", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var experienceId string + var id string + + httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesDestroy(context.Background(), experienceId, id).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesNotesList", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var experienceId string + + resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesList(context.Background(), experienceId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesNotesPartialUpdate", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var experienceId string + var id string + + resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesPartialUpdate(context.Background(), experienceId, id).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesNotesRetrieve", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var experienceId string + var id string + + resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesRetrieve(context.Background(), experienceId, id).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesNotesUpdate", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var experienceId string + var id string + + resp, httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesNotesUpdate(context.Background(), experienceId, id).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -95,9 +195,11 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -107,18 +209,22 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesStatsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test httpRes, err := apiClient.CatalogExperiencesAPI.V1CatalogExperiencesStatsRetrieve(context.Background()).Execute() require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogExperiencesAPIService V1CatalogExperiencesUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -128,5 +234,7 @@ func Test_openapi_CatalogExperiencesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_catalog_gpu_os_choices_test.go b/v1/providers/launchpad/gen/launchpad/test/api_catalog_gpu_os_choices_test.go index 1efcbd4..45859a9 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_catalog_gpu_os_choices_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_catalog_gpu_os_choices_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_CatalogGpuOsChoicesAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test CatalogGpuOsChoicesAPIService V1CatalogGpuOsChoicesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogGpuOsChoicesAPI.V1CatalogGpuOsChoicesCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_CatalogGpuOsChoicesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogGpuOsChoicesAPIService V1CatalogGpuOsChoicesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogGpuOsChoicesAPI.V1CatalogGpuOsChoicesList(context.Background()).Execute() @@ -40,5 +43,7 @@ func Test_openapi_CatalogGpuOsChoicesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_catalog_instance_types_test.go b/v1/providers/launchpad/gen/launchpad/test/api_catalog_instance_types_test.go index 2f6a7e7..de18433 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_catalog_instance_types_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_catalog_instance_types_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_CatalogInstanceTypesAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test CatalogInstanceTypesAPIService V1CatalogInstanceTypesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogInstanceTypesAPI.V1CatalogInstanceTypesList(context.Background()).Execute() @@ -30,5 +31,7 @@ func Test_openapi_CatalogInstanceTypesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_catalog_persona_choices_test.go b/v1/providers/launchpad/gen/launchpad/test/api_catalog_persona_choices_test.go index 93b07d2..2ed0af8 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_catalog_persona_choices_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_catalog_persona_choices_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_CatalogPersonaChoicesAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test CatalogPersonaChoicesAPIService V1CatalogPersonaChoicesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogPersonaChoicesAPI.V1CatalogPersonaChoicesCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_CatalogPersonaChoicesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogPersonaChoicesAPIService V1CatalogPersonaChoicesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogPersonaChoicesAPI.V1CatalogPersonaChoicesList(context.Background()).Execute() @@ -40,5 +43,7 @@ func Test_openapi_CatalogPersonaChoicesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_catalog_runtimes_test.go b/v1/providers/launchpad/gen/launchpad/test/api_catalog_runtimes_test.go index b679b5b..a271967 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_catalog_runtimes_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_catalog_runtimes_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test CatalogRuntimesAPIService V1CatalogRuntimesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogRuntimesAPI.V1CatalogRuntimesCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogRuntimesAPIService V1CatalogRuntimesDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -41,9 +44,11 @@ func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogRuntimesAPIService V1CatalogRuntimesHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -53,9 +58,11 @@ func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogRuntimesAPIService V1CatalogRuntimesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.CatalogRuntimesAPI.V1CatalogRuntimesList(context.Background()).Execute() @@ -63,9 +70,11 @@ func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogRuntimesAPIService V1CatalogRuntimesPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -75,9 +84,11 @@ func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogRuntimesAPIService V1CatalogRuntimesRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -87,9 +98,11 @@ func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test CatalogRuntimesAPIService V1CatalogRuntimesUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -99,5 +112,7 @@ func Test_openapi_CatalogRuntimesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_catalog_vgpu_profile_choices_test.go b/v1/providers/launchpad/gen/launchpad/test/api_catalog_vgpu_profile_choices_test.go new file mode 100644 index 0000000..94e8be5 --- /dev/null +++ b/v1/providers/launchpad/gen/launchpad/test/api_catalog_vgpu_profile_choices_test.go @@ -0,0 +1,49 @@ +/* +NVIDIA LaunchPad API + +Testing CatalogVgpuProfileChoicesAPIService + +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); + +package openapi + +import ( + "context" + openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "testing" +) + +func Test_openapi_CatalogVgpuProfileChoicesAPIService(t *testing.T) { + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + + t.Run("Test CatalogVgpuProfileChoicesAPIService V1CatalogVgpuProfileChoicesCreate", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesCreate(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test CatalogVgpuProfileChoicesAPIService V1CatalogVgpuProfileChoicesList", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.CatalogVgpuProfileChoicesAPI.V1CatalogVgpuProfileChoicesList(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + +} diff --git a/v1/providers/launchpad/gen/launchpad/test/api_health_test.go b/v1/providers/launchpad/gen/launchpad/test/api_health_test.go index 74d62c3..508bb94 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_health_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_health_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_HealthAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test HealthAPIService HealthRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.HealthAPI.HealthRetrieve(context.Background()).Execute() @@ -30,5 +31,7 @@ func Test_openapi_HealthAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_identity_profile_test.go b/v1/providers/launchpad/gen/launchpad/test/api_identity_profile_test.go index 2045e75..d5ec9d2 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_identity_profile_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_identity_profile_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_IdentityProfileAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test IdentityProfileAPIService V1IdentityProfilePartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.IdentityProfileAPI.V1IdentityProfilePartialUpdate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_IdentityProfileAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test IdentityProfileAPIService V1IdentityProfileRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.IdentityProfileAPI.V1IdentityProfileRetrieve(context.Background()).Execute() @@ -40,5 +43,7 @@ func Test_openapi_IdentityProfileAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_inventory_clusters_test.go b/v1/providers/launchpad/gen/launchpad/test/api_inventory_clusters_test.go index b05e949..3f1d09d 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_inventory_clusters_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_inventory_clusters_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_InventoryClustersAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test InventoryClustersAPIService V1InventoryClustersBulkPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryClustersAPI.V1InventoryClustersBulkPartialUpdate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryClustersAPI.V1InventoryClustersCreate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -51,9 +56,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -63,9 +70,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryClustersAPI.V1InventoryClustersList(context.Background()).Execute() @@ -73,9 +82,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -85,9 +96,25 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test InventoryClustersAPIService V1InventoryClustersPipelinesList", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var clusterId string + + resp, httpRes, err := apiClient.InventoryClustersAPI.V1InventoryClustersPipelinesList(context.Background(), clusterId).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersPipelinesTriggerCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -97,9 +124,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersProvisionCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryClustersAPI.V1InventoryClustersProvisionCreate(context.Background()).Execute() @@ -107,9 +136,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersProvisionDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -119,9 +150,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersProvisionPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -131,9 +164,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -143,18 +178,22 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersStatsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test httpRes, err := apiClient.InventoryClustersAPI.V1InventoryClustersStatsRetrieve(context.Background()).Execute() require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersTenantsCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var clusterId string @@ -164,9 +203,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersTenantsDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var clusterId string @@ -176,9 +217,11 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryClustersAPIService V1InventoryClustersUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -188,5 +231,7 @@ func Test_openapi_InventoryClustersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_inventory_gpus_test.go b/v1/providers/launchpad/gen/launchpad/test/api_inventory_gpus_test.go index e0e4cca..4474858 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_inventory_gpus_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_inventory_gpus_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_InventoryGpusAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test InventoryGpusAPIService V1InventoryGpusBulkPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryGpusAPI.V1InventoryGpusBulkPartialUpdate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryGpusAPI.V1InventoryGpusCreate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -51,9 +56,11 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -63,9 +70,11 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryGpusAPI.V1InventoryGpusList(context.Background()).Execute() @@ -73,9 +82,11 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -85,9 +96,11 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -97,18 +110,22 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusStatsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test httpRes, err := apiClient.InventoryGpusAPI.V1InventoryGpusStatsRetrieve(context.Background()).Execute() require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryGpusAPIService V1InventoryGpusUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -118,5 +135,7 @@ func Test_openapi_InventoryGpusAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_inventory_instances_test.go b/v1/providers/launchpad/gen/launchpad/test/api_inventory_instances_test.go index b32544c..078c4ad 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_inventory_instances_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_inventory_instances_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_InventoryInstancesAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesBulkPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryInstancesAPI.V1InventoryInstancesBulkPartialUpdate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryInstancesAPI.V1InventoryInstancesCreate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -51,9 +56,11 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -63,9 +70,11 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryInstancesAPI.V1InventoryInstancesList(context.Background()).Execute() @@ -73,9 +82,11 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -85,9 +96,11 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -97,9 +110,11 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryInstancesAPIService V1InventoryInstancesUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -109,5 +124,7 @@ func Test_openapi_InventoryInstancesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_inventory_locations_test.go b/v1/providers/launchpad/gen/launchpad/test/api_inventory_locations_test.go index ff7176f..fa7658d 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_inventory_locations_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_inventory_locations_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_InventoryLocationsAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test InventoryLocationsAPIService V1InventoryLocationsCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryLocationsAPI.V1InventoryLocationsCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_InventoryLocationsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryLocationsAPIService V1InventoryLocationsDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -41,9 +44,11 @@ func Test_openapi_InventoryLocationsAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryLocationsAPIService V1InventoryLocationsHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -53,9 +58,11 @@ func Test_openapi_InventoryLocationsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryLocationsAPIService V1InventoryLocationsList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryLocationsAPI.V1InventoryLocationsList(context.Background()).Execute() @@ -63,9 +70,11 @@ func Test_openapi_InventoryLocationsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryLocationsAPIService V1InventoryLocationsPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -75,9 +84,11 @@ func Test_openapi_InventoryLocationsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryLocationsAPIService V1InventoryLocationsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -87,9 +98,11 @@ func Test_openapi_InventoryLocationsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryLocationsAPIService V1InventoryLocationsUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -99,5 +112,7 @@ func Test_openapi_InventoryLocationsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_inventory_nodes_test.go b/v1/providers/launchpad/gen/launchpad/test/api_inventory_nodes_test.go index 8e3f0e1..302b4e4 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_inventory_nodes_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_inventory_nodes_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_InventoryNodesAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test InventoryNodesAPIService V1InventoryNodesBulkCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryNodesAPI.V1InventoryNodesBulkCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesBulkPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryNodesAPI.V1InventoryNodesBulkPartialUpdate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryNodesAPI.V1InventoryNodesCreate(context.Background()).Execute() @@ -50,9 +55,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -61,9 +68,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -73,9 +82,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryNodesAPI.V1InventoryNodesList(context.Background()).Execute() @@ -83,9 +94,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -95,9 +108,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -107,9 +122,11 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryNodesAPIService V1InventoryNodesUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -119,5 +136,7 @@ func Test_openapi_InventoryNodesAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_inventory_oems_test.go b/v1/providers/launchpad/gen/launchpad/test/api_inventory_oems_test.go index 69cb0dc..3a8a11d 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_inventory_oems_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_inventory_oems_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_InventoryOemsAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test InventoryOemsAPIService V1InventoryOemsCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryOemsAPI.V1InventoryOemsCreate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_InventoryOemsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryOemsAPIService V1InventoryOemsDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -41,9 +44,11 @@ func Test_openapi_InventoryOemsAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryOemsAPIService V1InventoryOemsHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -53,9 +58,11 @@ func Test_openapi_InventoryOemsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryOemsAPIService V1InventoryOemsList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryOemsAPI.V1InventoryOemsList(context.Background()).Execute() @@ -63,9 +70,11 @@ func Test_openapi_InventoryOemsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryOemsAPIService V1InventoryOemsPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -75,9 +84,11 @@ func Test_openapi_InventoryOemsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryOemsAPIService V1InventoryOemsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -87,9 +98,11 @@ func Test_openapi_InventoryOemsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryOemsAPIService V1InventoryOemsUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -99,5 +112,7 @@ func Test_openapi_InventoryOemsAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_inventory_providers_test.go b/v1/providers/launchpad/gen/launchpad/test/api_inventory_providers_test.go index d64a560..20da614 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_inventory_providers_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_inventory_providers_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_InventoryProvidersAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersBulkPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryProvidersAPI.V1InventoryProvidersBulkPartialUpdate(context.Background()).Execute() @@ -30,9 +31,11 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersCreate", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryProvidersAPI.V1InventoryProvidersCreate(context.Background()).Execute() @@ -40,9 +43,11 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersDestroy", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -51,9 +56,11 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersHistoryList", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -63,9 +70,11 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersList", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.InventoryProvidersAPI.V1InventoryProvidersList(context.Background()).Execute() @@ -73,9 +82,11 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersPartialUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -85,9 +96,11 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -97,18 +110,22 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersStatsRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test httpRes, err := apiClient.InventoryProvidersAPI.V1InventoryProvidersStatsRetrieve(context.Background()).Execute() require.Nil(t, err) assert.Equal(t, 200, httpRes.StatusCode) + }) t.Run("Test InventoryProvidersAPIService V1InventoryProvidersUpdate", func(t *testing.T) { + t.Skip("skip test") // remove to run test var id string @@ -118,5 +135,7 @@ func Test_openapi_InventoryProvidersAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/test/api_version_test.go b/v1/providers/launchpad/gen/launchpad/test/api_version_test.go index 617c2c7..41a05bf 100644 --- a/v1/providers/launchpad/gen/launchpad/test/api_version_test.go +++ b/v1/providers/launchpad/gen/launchpad/test/api_version_test.go @@ -11,18 +11,19 @@ package openapi import ( "context" - "testing" - openapiclient "github.com/brevdev/cloud/v1/providers/launchpad/gen/launchpad" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "testing" ) func Test_openapi_VersionAPIService(t *testing.T) { + configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) t.Run("Test VersionAPIService VersionRetrieve", func(t *testing.T) { + t.Skip("skip test") // remove to run test resp, httpRes, err := apiClient.VersionAPI.VersionRetrieve(context.Background()).Execute() @@ -30,5 +31,7 @@ func Test_openapi_VersionAPIService(t *testing.T) { require.Nil(t, err) require.NotNil(t, resp) assert.Equal(t, 200, httpRes.StatusCode) + }) + } diff --git a/v1/providers/launchpad/gen/launchpad/utils.go b/v1/providers/launchpad/gen/launchpad/utils.go index 2927b32..6e60f93 100644 --- a/v1/providers/launchpad/gen/launchpad/utils.go +++ b/v1/providers/launchpad/gen/launchpad/utils.go @@ -3,7 +3,7 @@ NVIDIA LaunchPad API RESTful API for interacting with the NVIDIA LaunchPad platform -API version: 2.39.5 +API version: 2.40.9 */ // Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. diff --git a/v1/providers/launchpad/swagger-v2.40.9.final.yaml b/v1/providers/launchpad/swagger-v2.40.9.final.yaml new file mode 100644 index 0000000..ffbe207 --- /dev/null +++ b/v1/providers/launchpad/swagger-v2.40.9.final.yaml @@ -0,0 +1,14802 @@ +openapi: 3.1.0 +info: + title: NVIDIA LaunchPad API + version: 2.40.9 + description: RESTful API for interacting with the NVIDIA LaunchPad platform +paths: + /health/: + get: + operationId: health_retrieve + tags: + - health + security: + - TokenAuthentication: [] + - {} + responses: + '200': + content: + application/json: + schema: + type: object + properties: + status: + type: string + components: + type: object + properties: + application: + type: string + database: + type: string + examples: + HealthyResponse: + value: + status: healthy + components: + application: ok + database: ok + summary: Healthy Response + description: '' + '503': + content: + application/json: + schema: + type: object + properties: + status: + type: string + components: + type: object + properties: + application: + type: string + database: + type: string + examples: + UnhealthyResponse: + value: + status: unhealthy + components: + application: ok + database: connection failure + summary: Unhealthy Response + description: '' + /v1/auth/login/: + post: + operationId: v1_auth_login_create + description: Login with either an authorization code or username and password (deprecated) to generate an API token that can be used with all other API endpoints. + tags: + - auth + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AuthLogin' + multipart/form-data: + schema: + $ref: '#/components/schemas/AuthLogin' + application/json: + schema: + $ref: '#/components/schemas/AuthLogin' + examples: + AuthCode: + value: + auth_code: string + summary: Auth Code + Username&Password(deprecated): + value: + username: string + password: string + summary: Username & Password (deprecated) + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: '' + /v1/auth/logout/: + post: + operationId: v1_auth_logout_create + description: Logout from the current session. Your API token will no longer be usable and must be regenerated via the login API. + tags: + - auth + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Logout' + description: '' + /v1/auth/password-change/: + post: + operationId: v1_auth_password_change_create + description: Change your current password + tags: + - auth + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PasswordChange' + multipart/form-data: + schema: + $ref: '#/components/schemas/PasswordChange' + application/json: + schema: + $ref: '#/components/schemas/PasswordChange' + required: true + security: + - TokenAuthentication: [] + deprecated: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordChange' + description: '' + /v1/auth/redirect/: + get: + operationId: v1_auth_redirect_retrieve + description: Get an HTTP redirect to begin an OAuth login flow. + parameters: + - in: query + name: as_json + schema: + type: boolean + description: If "false" or unset, receive an HTTP 302 with the OAuth URL returned in the Location header. If "true", receive an HTTP 200 with the OAuth URL returned in the JSON payload. + tags: + - auth + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthRedirect' + description: '' + '302': + description: No response body + /v1/catalog/deployments/: + get: + operationId: v1_catalog_deployments_list + parameters: + - in: query + name: bastion_operating_system + schema: + type: string + - in: query + name: cluster + schema: + type: string + format: uuid + - in: query + name: cluster_gpus_model + schema: + type: array + items: + type: string + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: collection_branch + schema: + type: string + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "cluster").' + - in: query + name: experience + schema: + type: string + format: uuid + - in: query + name: experience_branch + schema: + type: string + - in: query + name: expired + schema: + type: boolean + - in: query + name: expires_at + schema: + type: string + format: date + - in: query + name: expiring + schema: + type: string + description: Include deployments whose expires_at value is within the given range (inclusive), specified as "today", "tomorrow", or "{start}[,end]". Start and end times must be in ISO format. + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: flightcontrol_release + schema: + type: string + - in: query + name: garage_id + schema: + type: string + - in: query + name: gc_branch + schema: + type: string + - in: query + name: gpu_alias + schema: + type: string + - in: query + name: gpu_count + schema: + type: integer + - in: query + name: gpu_model + schema: + type: string + - in: query + name: gpu_os_name + schema: + type: string + - in: query + name: gpu_os_release + schema: + type: string + - in: query + name: gpu_os_version + schema: + type: string + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: node_count + schema: + type: integer + - in: query + name: oem_name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: org_name + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: persist_on_failure + schema: + type: boolean + - in: query + name: persona + schema: + type: string + - in: query + name: pipeline + schema: + type: integer + - in: query + name: pipeline_branch + schema: + type: string + - in: query + name: platform + schema: + type: string + - in: query + name: priority + schema: + type: string + enum: + - p0 + - p1 + - p2 + - p3 + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + - in: query + name: provider_name + schema: + type: string + - in: query + name: region + schema: + type: string + - in: query + name: request_id + schema: + type: string + - in: query + name: requester_email + schema: + type: string + - in: query + name: requester_name + schema: + type: string + - in: query + name: runtime_branch + schema: + type: string + - in: query + name: runtime_cns_addon_pack + schema: + type: boolean + - in: query + name: runtime_cns_docker + schema: + type: boolean + - in: query + name: runtime_cns_driver_version + schema: + type: string + - in: query + name: runtime_cns_k8s + schema: + type: boolean + - in: query + name: runtime_cns_nvidia_driver + schema: + type: boolean + - in: query + name: runtime_cns_version + schema: + type: string + - in: query + name: runtime_mig + schema: + type: boolean + - in: query + name: runtime_mig_profile + schema: + type: string + - in: query + name: sales_id + schema: + type: string + - in: query + name: sales_owner_email + schema: + type: string + - in: query + name: sales_owner_name + schema: + type: string + - name: search + required: false + in: query + description: Search for deployments by experience catalog_id, experience catalog_id_alias, experience id, experience title, expires_at, id, org_name, provisioning_config bastion_operating_system, provisioning_config collection_branch, provisioning_config experience_branch, provisioning_config flightcontrol_release, provisioning_config garage_id, provisioning_config gc_branch, provisioning_config gpu_alias, provisioning_config gpu_model, provisioning_config gpu_os_name, provisioning_config gpu_os_release, provisioning_config gpu_os_version, provisioning_config oem_name, provisioning_config persona, provisioning_config pipeline_branch, provisioning_config platform, provisioning_config provider_name, provisioning_config region, provisioning_config runtime_branch, provisioning_config runtime_cns_driver_version, provisioning_config runtime_cns_version, provisioning_config runtime_mig_profile, provisioning_config runtime_url, provisioning_config workshop_id, provisioning_request bastion_operating_system, provisioning_request collection_branch, provisioning_request experience_branch, provisioning_request flightcontrol_release, provisioning_request garage_id, provisioning_request gc_branch, provisioning_request gpu_alias, provisioning_request gpu_model, provisioning_request gpu_os_name, provisioning_request gpu_os_release, provisioning_request gpu_os_version, provisioning_request oem_name, provisioning_request persona, provisioning_request pipeline_branch, provisioning_request platform, provisioning_request provider_name, provisioning_request region, provisioning_request runtime_branch, provisioning_request runtime_cns_driver_version, provisioning_request runtime_cns_version, provisioning_request runtime_mig_profile, provisioning_request runtime_url, provisioning_request workshop_id, request_id, requester_email, requester_name, sales_id, sales_owner_email, sales_owner_name, services url, state, tags + schema: + type: string + - in: query + name: state + schema: + type: array + items: + type: string + enum: + - destroyed + - destroying + - error + - failed + - paused + - ready + - retrying + - starting + - stopped + - stopping + - waiting + description: |- + Multiple values may be separated by commas. + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + explode: false + style: form + - in: query + name: state_not + schema: + type: array + items: + type: string + enum: + - destroyed + - destroying + - error + - failed + - paused + - ready + - retrying + - starting + - stopped + - stopping + - waiting + description: |- + Multiple values may be separated by commas. + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + explode: false + style: form + - in: query + name: workshop + schema: + type: boolean + - in: query + name: workshop_id + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + post: + operationId: v1_catalog_deployments_create + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "cluster").' + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Deployment' + examples: + DeploymentRequest(CatalogIDAlias): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id_alias: LP-15 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + startup_script: '#!/bin/bash echo "Hello world"' + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Request (Catalog ID Alias) + DeploymentRequest(ExperienceID): + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + startup_script: '#!/bin/bash echo "Hello world"' + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Request (Experience ID) + DeploymentRequest(CatalogID): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id: aBY3Z000000xBL4NCO + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + startup_script: '#!/bin/bash echo "Hello world"' + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Request (Catalog ID) + DeploymentRequest(MinimumRequiredFields): + value: + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + org_name: NVIDIA + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + summary: Deployment Request (Minimum Required Fields) + DeploymentRequest(MinimumRequiredFieldsW/CatalogID): + value: + catalog_id: aBY3Z000000xBL4NCO + org_name: NVIDIA + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + summary: Deployment Request (Minimum Required Fields w/ Catalog ID) + DeploymentRequest(MinimumRequiredFieldsW/CatalogIDAlias): + value: + catalog_id_alias: LP-15 + org_name: NVIDIA + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + summary: Deployment Request (Minimum Required Fields w/ Catalog ID Alias) + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Deployment' + multipart/form-data: + schema: + $ref: '#/components/schemas/Deployment' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Deployment' + examples: + SuccessfulResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + /v1/catalog/deployments/{deployment_id}/instances/: + get: + operationId: v1_catalog_deployments_instances_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: instance_id + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-instances by id, instance_id, name, state, tags + schema: + type: string + - in: query + name: state + schema: + type: string + enum: + - running + - starting + - stopped + - stopping + - unknown + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentInstanceList' + examples: + DeploymentInstanceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: DeploymentInstance Response + description: '' + /v1/catalog/deployments/{deployment_id}/notes/: + get: + operationId: v1_catalog_deployments_notes_list + parameters: + - in: query + name: created_by + schema: + type: integer + - in: query + name: deployment + schema: + type: string + format: uuid + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: modified_by + schema: + type: integer + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-notes by content + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentNoteList' + examples: + DeploymentNoteResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + post: + operationId: v1_catalog_deployments_notes_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteRequest: + value: + content: Hello world + summary: DeploymentNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentNote' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + /v1/catalog/deployments/{deployment_id}/notes/{id}/: + get: + operationId: v1_catalog_deployments_notes_retrieve + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + put: + operationId: v1_catalog_deployments_notes_update + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteRequest: + value: + content: Hello world + summary: DeploymentNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + patch: + operationId: v1_catalog_deployments_notes_partial_update + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteRequest: + value: + content: Hello world + summary: DeploymentNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + delete: + operationId: v1_catalog_deployments_notes_destroy + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/deployments/{deployment_id}/pipelines/: + get: + operationId: v1_catalog_deployments_pipelines_list + parameters: + - in: query + name: action + schema: + type: string + enum: + - apply + - destroy + - notify + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: pipeline_id + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-pipelines by action, id, pipeline_id, url + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentPipelineList' + examples: + DeploymentPipelineResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - action: apply + created: '2024-04-01T06:14:32.602Z' + deployment: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + id: 4b9fab90-b441-4896-bb1f-c765fd846307 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124134 + url: https://gitlab.com/my-project/-/pipelines/5316124134 + summary: DeploymentPipeline Response + description: '' + post: + operationId: v1_catalog_deployments_pipelines_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + examples: + DeploymentPipelineRequest: + value: + action: apply + pipeline_id: 5316124134 + url: https://gitlab.com/my-project/-/pipelines/5316124134 + summary: DeploymentPipeline Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + examples: + DeploymentPipelineResponse: + value: + action: apply + created: '2024-04-01T06:14:32.602Z' + deployment: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + id: 4b9fab90-b441-4896-bb1f-c765fd846307 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124134 + url: https://gitlab.com/my-project/-/pipelines/5316124134 + summary: DeploymentPipeline Response + description: '' + /v1/catalog/deployments/{deployment_id}/services/: + get: + operationId: v1_catalog_deployments_services_list + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-services by id, name, url + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentServiceList' + examples: + DeploymentServiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: deb28859-d04e-4976-88d2-9488d9616bcf + modified: '2024-05-03T17:03:45.380Z' + name: root + url: https://a169edac-202c-46b9-8c61-47191000aca6.nvidialaunchpad.com + summary: DeploymentService Response + description: '' + post: + operationId: v1_catalog_deployments_services_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentService' + examples: + DeploymentServiceRequest: + value: + name: root + url: https://a169edac-202c-46b9-8c61-47191000aca6.nvidialaunchpad.com + summary: DeploymentService Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentService' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentService' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentService' + examples: + DeploymentServiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: deb28859-d04e-4976-88d2-9488d9616bcf + modified: '2024-05-03T17:03:45.380Z' + name: root + url: https://a169edac-202c-46b9-8c61-47191000aca6.nvidialaunchpad.com + summary: DeploymentService Response + description: '' + /v1/catalog/deployments/{deployment_id}/ssh-keys/: + get: + operationId: v1_catalog_deployments_ssh_keys_list + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-keys by name + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentKeyList' + examples: + DeploymentKeyResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 597f6c78-6195-4bc7-9db2-f344f71e8b47 + modified: '2024-05-03T17:03:45.380Z' + name: My Key + summary: DeploymentKey Response + description: '' + post: + operationId: v1_catalog_deployments_ssh_keys_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentKey' + examples: + DeploymentKeyRequest: + value: + name: My Key + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + summary: DeploymentKey Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentKey' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentKey' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentKey' + examples: + DeploymentKeyResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 597f6c78-6195-4bc7-9db2-f344f71e8b47 + modified: '2024-05-03T17:03:45.380Z' + name: My Key + summary: DeploymentKey Response + description: '' + /v1/catalog/deployments/{deployment_id}/ssh-keys/{id}/: + delete: + operationId: v1_catalog_deployments_ssh_keys_destroy + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/deployments/{deployment_id}/tasks/: + get: + operationId: v1_catalog_deployments_tasks_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: query + name: action + schema: + type: string + enum: + - start_instances + - stop_instances + description: |- + The action the task will perform + + * `start_instances` - Start all instances in the deployment + * `stop_instances` - Stop all instances in the deployment + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-tasks by action, id, status, status_text + schema: + type: string + - in: query + name: status + schema: + type: string + enum: + - completed + - failed + - pending + - processing + - retrying + description: |- + Current status of the task + + * `completed` - completed + * `failed` - failed + * `pending` - pending + * `processing` - processing + * `retrying` - retrying + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentTaskList' + examples: + DeploymentTaskResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - action: start_instances + created: '2024-04-01T06:14:32.602Z' + id: 1001d637-f16a-4b42-b540-ef58fcfaaef8 + modified: '2024-05-03T17:03:45.380Z' + retries: 0 + status: pending + status_text: '' + summary: DeploymentTask Response + description: '' + post: + operationId: v1_catalog_deployments_tasks_create + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentTask' + examples: + DeploymentTaskRequest: + value: + action: start_instances + summary: DeploymentTask Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentTask' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentTask' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentTask' + examples: + DeploymentTaskResponse: + value: + action: start_instances + created: '2024-04-01T06:14:32.602Z' + id: 1001d637-f16a-4b42-b540-ef58fcfaaef8 + modified: '2024-05-03T17:03:45.380Z' + retries: 0 + status: pending + status_text: '' + summary: DeploymentTask Response + description: '' + /v1/catalog/deployments/{deployment_id}/tasks/{id}/: + get: + operationId: v1_catalog_deployments_tasks_retrieve + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentTask' + examples: + DeploymentTaskResponse: + value: + action: start_instances + created: '2024-04-01T06:14:32.602Z' + id: 1001d637-f16a-4b42-b540-ef58fcfaaef8 + modified: '2024-05-03T17:03:45.380Z' + retries: 0 + status: pending + status_text: '' + summary: DeploymentTask Response + description: '' + /v1/catalog/deployments/{id}/: + get: + operationId: v1_catalog_deployments_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "cluster").' + - in: query + name: expiring + schema: + type: string + description: Include deployments whose expires_at value is within the given range (inclusive), specified as "today", "tomorrow", or "{start}[,end]". Start and end times must be in ISO format. + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Deployment' + examples: + SuccessfulResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + put: + operationId: v1_catalog_deployments_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentRequest: + value: + collection_branch: my-branch + experience_branch: main + expires_at: 2026-01-11 16:07:02.677916+00:00 + flightcontrol_release: latest + gc_branch: main + ip_allowlist: + - 192.0.2.1 + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + state: retrying + tags: + sample: test + summary: Deployment Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Response + description: '' + patch: + operationId: v1_catalog_deployments_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentRequest: + value: + collection_branch: my-branch + experience_branch: main + expires_at: 2026-01-11 16:07:02.677916+00:00 + flightcontrol_release: latest + gc_branch: main + ip_allowlist: + - 192.0.2.1 + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + state: retrying + tags: + sample: test + summary: Deployment Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Response + description: '' + delete: + operationId: v1_catalog_deployments_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DocDeploymentDelete' + examples: + SuccessfulDestroyingResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: destroying + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Destroying Response + description: '' + '204': + description: No response body + /v1/catalog/deployments/{id}/history/: + get: + operationId: v1_catalog_deployments_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/catalog/deployments/{id}/pipelines/trigger/: + post: + operationId: v1_catalog_deployments_pipelines_trigger_create + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + examples: + DeploymentPipelineTriggerRequest: + value: + action: apply + summary: DeploymentPipelineTrigger Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + examples: + DeploymentPipelineTriggerResponse: + value: + action: apply + created: '2024-04-01T06:14:32.602Z' + id: 05971347-30d6-410c-aff5-fa3513771d77 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 2101675389 + url: https://gitlab.com/my-project/-/pipelines/2101675389 + summary: DeploymentPipelineTrigger Response + description: '' + /v1/catalog/deployments/bulk/: + patch: + operationId: v1_catalog_deployments_bulk_partial_update + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + examples: + DeploymentBulkUpdateRequest: + value: + collection_branch: my-branch + experience_branch: main + expires_at: 2026-01-11 16:07:02.677916+00:00 + flightcontrol_release: latest + gc_branch: main + ids: + - 5330c898-f3e7-4972-bfd0-1d438e3774d7 + - b29d13e5-5894-4614-af2a-ea3f9be93fc5 + ip_allowlist: + - 192.0.2.1 + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + state: retrying + tags: + sample: test + summary: Deployment Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + examples: + DeploymentBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Deployment Bulk Update Response + description: '' + /v1/catalog/deployments/stats/: + get: + operationId: v1_catalog_deployments_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/catalog/experiences/: + get: + operationId: v1_catalog_experiences_list + parameters: + - in: query + name: assignee + schema: + type: string + - in: query + name: autoapprove + schema: + type: boolean + - in: query + name: autoprovision + schema: + type: boolean + - in: query + name: bootstrap + schema: + type: boolean + - in: query + name: catalog_id + schema: + type: string + - in: query + name: catalog_id_alias + schema: + type: string + - in: query + name: category + schema: + type: array + items: + type: string + enum: + - 3D Design Collaboration and Simulation + - AI + - Clara + - Data Science + - Developer + - Infrastructure Optimization + description: |- + Multiple values may be separated by commas. + + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + explode: false + style: form + - in: query + name: collection_branch + schema: + type: string + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "required_gpus").' + - in: query + name: experience + schema: + type: string + - in: query + name: experience_branch + schema: + type: string + - in: query + name: featured + schema: + type: boolean + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: garage_id + schema: + type: string + - in: query + name: gc_branch + schema: + type: string + - in: query + name: gpu_count + schema: + type: integer + - in: query + name: gpu_os_name + schema: + type: string + - in: query + name: gpu_os_release + schema: + type: string + - in: query + name: gpu_os_version + schema: + type: string + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: node_count + schema: + type: integer + - in: query + name: oem + schema: + type: string + format: uuid + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: persona + schema: + type: string + - in: query + name: pipeline + schema: + type: integer + - in: query + name: platform + schema: + type: string + enum: + - air + - flight_deck + - kvm_bastion + - lp-vmware-platform + - minimal + - openshift + - proxmox + - vsphere + - vsphere7 + - vsphere8 + - vsphere_horizon + description: |- + Base platform that the experience will be provisioned onto + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: published + schema: + type: array + items: + type: string + enum: + - draft + - 'no' + - 'yes' + description: |- + Multiple values may be separated by commas. + + * `draft` - draft + * `no` - no + * `yes` - yes + explode: false + style: form + - in: query + name: requires_gpu + schema: + type: string + description: Only include experiences that require a given GPU ID or model + - in: query + name: runtime + schema: + type: string + format: uuid + - in: query + name: sa_lab + schema: + type: boolean + - name: search + required: false + in: query + description: Search for experiences by assignee, catalog_id, catalog_id_alias, category, collection_branch, description, experience, experience_branch, gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, oem name, persona, pipeline, platform, provider name, required_gpus model, runtime name, system_arch, title, vgpu_profile + schema: + type: string + - in: query + name: system_arch + schema: + type: string + enum: + - amd64 + - arm64 + description: |- + Required CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + - in: query + name: vgpu_profile + schema: + type: string + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedExperienceList' + examples: + ExperienceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + post: + operationId: v1_catalog_experiences_create + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Experience' + multipart/form-data: + schema: + $ref: '#/components/schemas/Experience' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + /v1/catalog/experiences/{experience_id}/notes/: + get: + operationId: v1_catalog_experiences_notes_list + parameters: + - in: query + name: created_by + schema: + type: integer + - in: query + name: experience + schema: + type: string + format: uuid + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: modified_by + schema: + type: integer + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for experience-notes by content + schema: + type: string + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedExperienceNoteList' + examples: + ExperiencetNoteResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + post: + operationId: v1_catalog_experiences_notes_create + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteRequest: + value: + content: Hello world + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + summary: ExperiencetNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExperienceNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExperienceNote' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + /v1/catalog/experiences/{experience_id}/notes/{id}/: + get: + operationId: v1_catalog_experiences_notes_retrieve + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + put: + operationId: v1_catalog_experiences_notes_update + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteRequest: + value: + content: Hello world + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + summary: ExperiencetNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExperienceNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExperienceNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + patch: + operationId: v1_catalog_experiences_notes_partial_update + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteRequest: + value: + content: Hello world + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + summary: ExperiencetNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExperienceNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExperienceNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + delete: + operationId: v1_catalog_experiences_notes_destroy + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/experiences/{id}/: + get: + operationId: v1_catalog_experiences_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "required_gpus").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + put: + operationId: v1_catalog_experiences_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Experience' + multipart/form-data: + schema: + $ref: '#/components/schemas/Experience' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + patch: + operationId: v1_catalog_experiences_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Experience' + multipart/form-data: + schema: + $ref: '#/components/schemas/Experience' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + delete: + operationId: v1_catalog_experiences_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/experiences/{id}/history/: + get: + operationId: v1_catalog_experiences_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/catalog/experiences/bulk/: + post: + operationId: v1_catalog_experiences_bulk_create + description: Create experiences in bulk via CSV file upload + tags: + - catalog/experiences + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + csv_file: + type: string + format: binary + writeOnly: true + required: + - csv_file + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceBulk' + description: '' + patch: + operationId: v1_catalog_experiences_bulk_partial_update + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceBulkUpdate' + examples: + ExperienceBulkUpdateRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + ids: + - c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + - 3587f151-b02a-46c7-80a4-ac61db6633ed + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Bulk Update Request + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceBulkUpdate' + examples: + ExperienceBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Experience Bulk Update Response + description: '' + /v1/catalog/experiences/stats/: + get: + operationId: v1_catalog_experiences_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/catalog/gpu-os-choices/: + get: + operationId: v1_catalog_gpu_os_choices_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for gpuoschoices by id, name, release, version + schema: + type: string + tags: + - catalog/gpu-os-choices + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedGpuOsChoiceList' + examples: + GPUOSChoiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 22 + modified: '2024-05-03T17:03:45.380Z' + name: ubuntu + release: jammy + version: '22.04' + summary: GPU OS Choice Response + description: '' + post: + operationId: v1_catalog_gpu_os_choices_create + tags: + - catalog/gpu-os-choices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GpuOsChoice' + examples: + GPUOSChoiceRequest: + value: + name: ubuntu + release: jammy + version: '22.04' + summary: GPU OS Choice Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GpuOsChoice' + multipart/form-data: + schema: + $ref: '#/components/schemas/GpuOsChoice' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/GpuOsChoice' + examples: + GPUOSChoiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 22 + modified: '2024-05-03T17:03:45.380Z' + name: ubuntu + release: jammy + version: '22.04' + summary: GPU OS Choice Response + description: '' + /v1/catalog/instance-types/: + get: + operationId: v1_catalog_instance_types_list + parameters: + - in: query + name: delivery + schema: + type: string + enum: + - fast + - slow + description: Limit results to instance types that can meet the given delivery timelines. + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/instance-types + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInstanceTypeList' + examples: + InstanceTypeResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - capacity: + us-tx-1: 10 + cloud: oci + cpu: 16 + gpu: + count: 1 + family: A100 + interconnection_type: SXM + manufacturer: NVIDIA + memory_gb: 80 + model: A100-80GB + memory_gb: 120 + price: + currency: USD + on_demand_per_hour: 2.5 + regions: + - us-tx-1 + storage: + - size_gb: 1024 + type: ssd + - size_gb: 2048 + type: ssd + system_arch: amd64 + workshop_id: January training + summary: Instance Type Response + description: '' + /v1/catalog/persona-choices/: + get: + operationId: v1_catalog_persona_choices_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for personachoices by id, name + schema: + type: string + tags: + - catalog/persona-choices + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPersonaChoiceList' + examples: + PersonaChoiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: developer + summary: Persona Choice Response + description: '' + post: + operationId: v1_catalog_persona_choices_create + tags: + - catalog/persona-choices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PersonaChoice' + examples: + PersonaChoiceRequest: + value: + name: developer + summary: Persona Choice Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PersonaChoice' + multipart/form-data: + schema: + $ref: '#/components/schemas/PersonaChoice' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PersonaChoice' + examples: + PersonaChoiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: developer + summary: Persona Choice Response + description: '' + /v1/catalog/runtimes/: + get: + operationId: v1_catalog_runtimes_list + parameters: + - in: query + name: branch + schema: + type: string + - in: query + name: cns_addon_pack + schema: + type: boolean + - in: query + name: cns_docker + schema: + type: boolean + - in: query + name: cns_driver_version + schema: + type: string + - in: query + name: cns_k8s + schema: + type: boolean + - in: query + name: cns_nvidia_driver + schema: + type: boolean + - in: query + name: cns_version + schema: + type: string + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: mig + schema: + type: boolean + - in: query + name: mig_profile + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for runtimes by branch, cns_driver_version, cns_version, mig_profile, id, name, url + schema: + type: string + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRuntimeList' + examples: + RuntimeResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + post: + operationId: v1_catalog_runtimes_create + tags: + - catalog/runtimes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeRequest: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + mig: true + mig_profile: all-2g.20gb + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Runtime' + multipart/form-data: + schema: + $ref: '#/components/schemas/Runtime' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + /v1/catalog/runtimes/{id}/: + get: + operationId: v1_catalog_runtimes_retrieve + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + put: + operationId: v1_catalog_runtimes_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + tags: + - catalog/runtimes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeRequest: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + mig: true + mig_profile: all-2g.20gb + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Runtime' + multipart/form-data: + schema: + $ref: '#/components/schemas/Runtime' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + patch: + operationId: v1_catalog_runtimes_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + tags: + - catalog/runtimes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeRequest: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + mig: true + mig_profile: all-2g.20gb + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Runtime' + multipart/form-data: + schema: + $ref: '#/components/schemas/Runtime' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + delete: + operationId: v1_catalog_runtimes_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/runtimes/{id}/history/: + get: + operationId: v1_catalog_runtimes_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/catalog/vgpu-profile-choices/: + get: + operationId: v1_catalog_vgpu_profile_choices_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for vgpuprofilechoices by id, name + schema: + type: string + tags: + - catalog/vgpu-profile-choices + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVGpuProfileChoiceList' + examples: + VGPUProfileChoiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: flight_deck + summary: vGPU Profile Choice Response + description: '' + post: + operationId: v1_catalog_vgpu_profile_choices_create + tags: + - catalog/vgpu-profile-choices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + examples: + VGPUProfileChoiceRequest: + value: + name: flight_deck + summary: vGPU Profile Choice Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + multipart/form-data: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + examples: + VGPUProfileChoiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: flight_deck + summary: vGPU Profile Choice Response + description: '' + /v1/identity/profile/: + get: + operationId: v1_identity_profile_retrieve + tags: + - identity/profile + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Profile' + examples: + ProfileResponse: + value: + created: '2024-10-01T07:24:42.702Z' + display_name: John Doe + groups: + - Reporters + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + modified: '2024-11-03T18:04:55.480Z' + preferred_theme: dark + preferred_view_settings: + view_name: + ordering: -column_name + page_size: 50 + username: jdoe@nvidia.com + summary: Profile Response + description: '' + patch: + operationId: v1_identity_profile_partial_update + tags: + - identity/profile + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Profile' + examples: + ProfileRequest: + value: + preferred_theme: dark + preferred_view_settings: + view_name: + ordering: -column_name + page_size: 50 + summary: Profile Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Profile' + multipart/form-data: + schema: + $ref: '#/components/schemas/Profile' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Profile' + examples: + ProfileResponse: + value: + created: '2024-10-01T07:24:42.702Z' + display_name: John Doe + groups: + - Reporters + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + modified: '2024-11-03T18:04:55.480Z' + preferred_theme: dark + preferred_view_settings: + view_name: + ordering: -column_name + page_size: 50 + username: jdoe@nvidia.com + summary: Profile Response + description: '' + /v1/inventory/clusters/: + get: + operationId: v1_inventory_clusters_list + parameters: + - in: query + name: available + schema: + type: boolean + description: Is the cluster currently available for provisioning? + - in: query + name: bastion_name + schema: + type: string + - in: query + name: deployment + schema: + type: string + format: uuid + - in: query + name: enabled + schema: + type: boolean + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate nested relationships with a period (ex: "nodes.location"). Separate multiple fields with a comma (ex: "gpus,nodes")' + - in: query + name: experience + schema: + type: string + format: uuid + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: garage_id + schema: + type: string + description: Only include clusters whose nodes have the given garage ID + - in: query + name: gpu + schema: + type: array + items: + type: string + format: uuid + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: gpu_alias + schema: + type: string + description: Alias for GPU plan (i.e. installed GPU type and count) + - in: query + name: gpu_count + schema: + type: number + description: Only include clusters with a physical GPU count equal to this value + - in: query + name: gpu_model + schema: + type: string + description: Only include clusters with the given GPU model name + - in: query + name: has_deployment + schema: + type: boolean + - in: query + name: has_request_id + schema: + type: boolean + - in: query + name: has_workshop_id + schema: + type: boolean + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: location + schema: + type: string + format: uuid + - in: query + name: location_name + schema: + type: string + description: Only include clusters whose nodes are in the location with the given name + - in: query + name: location_region + schema: + type: string + description: Only include clusters whose nodes are in the location in the given region + - in: query + name: maintenance + schema: + type: boolean + - in: query + name: mgmt_ip + schema: + type: string + - in: query + name: mgmt_mac + schema: + type: string + - in: query + name: min_gpu_count + schema: + type: number + description: Only include clusters that have a gpu_count greater than or equal to this value + - in: query + name: min_node_count + schema: + type: number + description: Only include clusters that have a node_count greater than or equal to this value + - in: query + name: min_provisioning_attempts + schema: + type: integer + description: Only include clusters that have a provisioning_attempts value greater than or equal to this value + - in: query + name: min_tenant_count + schema: + type: number + description: Only include clusters whose number of tenant_ids is greater than or equal to this value + - in: query + name: netmask + schema: + type: integer + - in: query + name: node_count + schema: + type: number + description: Only include clusters with a node count equal to this value + - in: query + name: oem + schema: + type: string + format: uuid + description: Only include clusters with nodes that have the given OEM ID + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: persist + schema: + type: boolean + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: provider_capacity + schema: + type: boolean + - in: query + name: provider_name + schema: + type: string + description: Only include clusters whose nodes are from the provider with the given name + - in: query + name: provider_node_id + schema: + type: string + format: uuid + - in: query + name: provision_user + schema: + type: string + - in: query + name: provisioning_attempts + schema: + type: integer + - in: query + name: provisioning_state + schema: + type: array + items: + type: string + enum: + - deployed + - deploying + - destroying + - pending + - ready + - reserved + - unprovisioned + description: |- + Multiple values may be separated by commas. + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + explode: false + style: form + - in: query + name: provisioning_state_not + schema: + type: array + items: + type: string + enum: + - deployed + - deploying + - destroying + - pending + - ready + - reserved + - unprovisioned + description: |- + Multiple values may be separated by commas. + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + explode: false + style: form + - in: query + name: public_address + schema: + type: string + - in: query + name: rack + schema: + type: string + description: Only include clusters whose nodes are in the given rack + - in: query + name: request_id + schema: + type: string + - in: query + name: reservation + schema: + type: boolean + - name: search + required: false + in: query + description: Search for clusters by bastion_name, experience id, gpu_alias, gpus model, id, mgmt_ip, mgmt_mac, netmask, nodes garage_id, nodes location name, nodes location provider name, nodes oem name, nodes provider_node_id, nodes rack, notes, provision_user, provisioning_state, public_address, request_id, tenant_ids, workshop_id + schema: + type: string + - in: query + name: system_arch + schema: + type: string + description: Only include clusters whose nodes have the given CPU architecture + - in: query + name: vlan_id + schema: + type: integer + - in: query + name: workshop + schema: + type: boolean + - in: query + name: workshop_id + schema: + type: string + - in: query + name: workshop_id_not + schema: + type: string + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedClusterList' + examples: + ClusterResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + post: + operationId: v1_inventory_clusters_create + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Cluster' + multipart/form-data: + schema: + $ref: '#/components/schemas/Cluster' + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + /v1/inventory/clusters/{cluster_id}/pipelines/: + get: + operationId: v1_inventory_clusters_pipelines_list + parameters: + - in: query + name: action + schema: + type: string + enum: + - apply + - destroy + - notify + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + - in: path + name: cluster_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: pipeline_id + schema: + type: integer + - in: query + name: request_id + schema: + type: string + - name: search + required: false + in: query + description: Search for cluster-pipelines by action, id, pipeline_id, request_id, url + schema: + type: string + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedClusterPipelineList' + examples: + ClusterPipelineResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - action: apply + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 6d736f2c-d6b8-4e44-86a0-e6e2b7b9eaf4 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124135 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/5316124135 + summary: ClusterPipeline Response + description: '' + /v1/inventory/clusters/{cluster_id}/tenants/: + post: + operationId: v1_inventory_clusters_tenants_create + parameters: + - in: path + name: cluster_id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Tenant' + multipart/form-data: + schema: + $ref: '#/components/schemas/Tenant' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + /v1/inventory/clusters/{cluster_id}/tenants/{id}/: + delete: + operationId: v1_inventory_clusters_tenants_destroy + parameters: + - in: path + name: cluster_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/clusters/{id}/: + get: + operationId: v1_inventory_clusters_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate nested relationships with a period (ex: "nodes.location"). Separate multiple fields with a comma (ex: "gpus,nodes")' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + put: + operationId: v1_inventory_clusters_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Cluster' + multipart/form-data: + schema: + $ref: '#/components/schemas/Cluster' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + patch: + operationId: v1_inventory_clusters_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Cluster' + multipart/form-data: + schema: + $ref: '#/components/schemas/Cluster' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + delete: + operationId: v1_inventory_clusters_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/clusters/{id}/history/: + get: + operationId: v1_inventory_clusters_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/clusters/{id}/pipelines/trigger/: + post: + operationId: v1_inventory_clusters_pipelines_trigger_create + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + examples: + ClusterPipelineTriggerRequest: + value: + action: apply + summary: ClusterPipelineTrigger Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + multipart/form-data: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + examples: + ClusterPipelineTriggerResponse: + value: + action: apply + created: '2024-04-01T06:14:32.602Z' + id: 84d750af-fa43-4ff1-9198-39535584f83e + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 2101675388 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/2101675388 + summary: ClusterPipelineTrigger Response + description: '' + /v1/inventory/clusters/{id}/provision/: + patch: + operationId: v1_inventory_clusters_provision_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + examples: + ProvisioningRequest(CatalogIDAlias): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id_alias: LP-15 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID Alias) + ProvisioningRequest(ExperienceID): + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Experience ID) + ProvisioningRequest(CatalogID): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id: aBY3Z000000xBL4NCO + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID) + ProvisioningRequest(MinimumRequiredFields): + value: + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogID): + value: + catalog_id: aBY3Z000000xBL4NCO + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog ID) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogIDAlias): + value: + catalog_id_alias: LP-15 + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog ID Alias) + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + examples: + SuccessfulResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + delete: + operationId: v1_inventory_clusters_provision_destroy + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "cluster,experience").' + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + /v1/inventory/clusters/bulk/: + patch: + operationId: v1_inventory_clusters_bulk_partial_update + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + examples: + ClusterBulkUpdateRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + ids: + - 089324a5-708c-4386-9fdc-92dd9aa63d2b + - 3587f151-b02a-46c7-80a4-ac61db6633ed + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + examples: + ClusterBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Cluster Bulk Update Response + description: '' + /v1/inventory/clusters/provision/: + post: + operationId: v1_inventory_clusters_provision_create + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "cluster,experience").' + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + examples: + ProvisioningRequest(CatalogIDAlias): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id_alias: LP-15 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID Alias) + ProvisioningRequest(ExperienceID): + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Experience ID) + ProvisioningRequest(CatalogID): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id: aBY3Z000000xBL4NCO + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID) + ProvisioningRequest(MinimumRequiredFields): + value: + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogID): + value: + catalog_id: aBY3Z000000xBL4NCO + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog ID) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogIDAlias): + value: + catalog_id_alias: LP-15 + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog ID Alias) + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterProvisionCreateResponse' + examples: + ClusterProvisionResponse: + value: + pipeline: + action: apply + created: '2024-04-01T06:14:32.602Z' + id: 6d736f2c-d6b8-4e44-86a0-e6e2b7b9eaf4 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124135 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/5316124135 + provisioning_config: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: noble + gpu_os_version: '24.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: ClusterProvision Response + description: '' + /v1/inventory/clusters/stats/: + get: + operationId: v1_inventory_clusters_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/inventory/gpus/: + get: + operationId: v1_inventory_gpus_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: form_factor + schema: + type: string + enum: + - pcie + - sxm + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: model + schema: + type: array + items: + type: string + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: priority + schema: + type: integer + - name: search + required: false + in: query + description: Search for gpus by form_factor, id, memory, model + schema: + type: string + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedGpuList' + examples: + GPUResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + post: + operationId: v1_inventory_gpus_create + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPURequest: + value: + form_factor: pcie + memory: 48 + model: l40s + priority: 60 + summary: GPU Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Gpu' + multipart/form-data: + schema: + $ref: '#/components/schemas/Gpu' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + /v1/inventory/gpus/{id}/: + get: + operationId: v1_inventory_gpus_retrieve + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + put: + operationId: v1_inventory_gpus_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPURequest: + value: + form_factor: pcie + memory: 48 + model: l40s + priority: 60 + summary: GPU Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Gpu' + multipart/form-data: + schema: + $ref: '#/components/schemas/Gpu' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + patch: + operationId: v1_inventory_gpus_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPURequest: + value: + form_factor: pcie + memory: 48 + model: l40s + priority: 60 + summary: GPU Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Gpu' + multipart/form-data: + schema: + $ref: '#/components/schemas/Gpu' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + delete: + operationId: v1_inventory_gpus_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/gpus/{id}/history/: + get: + operationId: v1_inventory_gpus_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/gpus/bulk/: + patch: + operationId: v1_inventory_gpus_bulk_partial_update + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + examples: + GPUBulkUpdateRequest: + value: + form_factor: pcie + ids: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + - d63c8b0d-acb9-4c87-b4f7-656ecea5b02a + memory: 48 + priority: 60 + summary: GPU Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + examples: + GPUBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: GPU Bulk Update Response + description: '' + /v1/inventory/gpus/stats/: + get: + operationId: v1_inventory_gpus_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/inventory/instances/: + get: + operationId: v1_inventory_instances_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: query + name: cluster + schema: + type: string + format: uuid + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "cluster").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: instance_id + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for instances by cluster, id, instance_id, name, state, tags + schema: + type: string + - in: query + name: state + schema: + type: string + enum: + - running + - starting + - stopped + - stopping + - unknown + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInstanceList' + examples: + InstanceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + post: + operationId: v1_inventory_instances_create + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + instance_id: instance-934ea164 + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Instance' + multipart/form-data: + schema: + $ref: '#/components/schemas/Instance' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + /v1/inventory/instances/{id}/: + get: + operationId: v1_inventory_instances_retrieve + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "cluster").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + put: + operationId: v1_inventory_instances_update + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + instance_id: instance-934ea164 + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Instance' + multipart/form-data: + schema: + $ref: '#/components/schemas/Instance' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + patch: + operationId: v1_inventory_instances_partial_update + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + instance_id: instance-934ea164 + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Instance' + multipart/form-data: + schema: + $ref: '#/components/schemas/Instance' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + delete: + operationId: v1_inventory_instances_destroy + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/instances/{id}/history/: + get: + operationId: v1_inventory_instances_history_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/instances/bulk/: + patch: + operationId: v1_inventory_instances_bulk_partial_update + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + examples: + InstanceBulkUpdateRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + ids: + - 899d8680-454a-41f3-af99-9e0497ac955d + - 3280c16f-0e3e-4897-b8ba-7f66d40281bf + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + examples: + InstanceBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Instance Bulk Update Response + description: '' + /v1/inventory/locations/: + get: + operationId: v1_inventory_locations_list + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "provider").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: region + schema: + type: string + - name: search + required: false + in: query + description: Search for locations by id, name, provider name, region + schema: + type: string + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedLocationList' + examples: + LocationResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + post: + operationId: v1_inventory_locations_create + tags: + - inventory/locations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationRequest: + value: + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Location' + multipart/form-data: + schema: + $ref: '#/components/schemas/Location' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + /v1/inventory/locations/{id}/: + get: + operationId: v1_inventory_locations_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: "provider").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + put: + operationId: v1_inventory_locations_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + tags: + - inventory/locations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationRequest: + value: + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Location' + multipart/form-data: + schema: + $ref: '#/components/schemas/Location' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + patch: + operationId: v1_inventory_locations_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + tags: + - inventory/locations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationRequest: + value: + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Location' + multipart/form-data: + schema: + $ref: '#/components/schemas/Location' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + delete: + operationId: v1_inventory_locations_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/locations/{id}/history/: + get: + operationId: v1_inventory_locations_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/nodes/: + get: + operationId: v1_inventory_nodes_list + parameters: + - in: query + name: bmc_ip + schema: + type: string + - in: query + name: bmc_mac + schema: + type: string + - in: query + name: cluster + schema: + type: string + format: uuid + - in: query + name: cpu + schema: + type: integer + - in: query + name: cpu_manufacturer + schema: + type: + - string + - 'null' + enum: + - amd + - arm + - intel + description: |- + Manufacturer of the node's CPU + + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + - in: query + name: cpu_model + schema: + type: string + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate nested relationships with a period (ex: "location.provider"). Separate multiple fields with a comma (ex: "location,oem")' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: garage_id + schema: + type: string + - in: query + name: gpu + schema: + type: array + items: + type: string + format: uuid + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: gpu_alias + schema: + type: string + description: Alias for GPU plan (i.e. installed GPU type and count) + - in: query + name: gpu_count + schema: + type: integer + - in: query + name: gpu_model + schema: + type: string + description: Model of GPU(s) installed + - in: query + name: gpu_vbios + schema: + type: string + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: location + schema: + type: string + format: uuid + - in: query + name: memory + schema: + type: integer + - in: query + name: mgmt_ip + schema: + type: string + - in: query + name: mgmt_mac + schema: + type: string + - in: query + name: min_gpu_count + schema: + type: integer + description: Only include nodes that have a gpu_count greater than or equal to this value + - in: query + name: model + schema: + type: string + - in: query + name: network_type + schema: + type: string + enum: + - ethernet + - infiniband + description: |- + Type of networking technology used + + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + - in: query + name: oem + schema: + type: string + format: uuid + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: provider_node_id + schema: + type: string + - in: query + name: rack + schema: + type: string + - in: query + name: rack_unit + schema: + type: integer + - name: search + required: false + in: query + description: Search for nodes by bmc_ip, bmc_mac, cpu_manufacturer, cpu_model, garage_id, gpu_alias, gpu model, gpu_vbios, id, location name, location provider name, memory, mgmt_ip, mgmt_mac, model, network_type, nic_prefixes, notes, oem name, provider_node_id, rack, rack_unit, serial_number, storage, system_arch + schema: + type: string + - in: query + name: serial_number + schema: + type: string + - in: query + name: system_arch + schema: + type: string + enum: + - amd64 + - arm64 + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + - in: query + name: tee + schema: + type: boolean + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeList' + examples: + NodeResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + post: + operationId: v1_inventory_nodes_create + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + /v1/inventory/nodes/{id}/: + get: + operationId: v1_inventory_nodes_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate nested relationships with a period (ex: "location.provider"). Separate multiple fields with a comma (ex: "location,oem")' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + put: + operationId: v1_inventory_nodes_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + patch: + operationId: v1_inventory_nodes_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + delete: + operationId: v1_inventory_nodes_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/nodes/{id}/history/: + get: + operationId: v1_inventory_nodes_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/nodes/bulk/: + post: + operationId: v1_inventory_nodes_bulk_create + description: Create nodes in bulk via CSV file upload + tags: + - inventory/nodes + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + csv_file: + type: string + format: binary + writeOnly: true + required: + - csv_file + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeBulk' + description: '' + patch: + operationId: v1_inventory_nodes_bulk_partial_update + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeBulkUpdate' + examples: + NodeBulkUpdateRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + ids: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + - 6fcf07f8-d821-48cf-b20e-b6eb65db9387 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Bulk Update Request + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeBulkUpdate' + examples: + NodeBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Node Bulk Update Response + description: '' + /v1/inventory/oems/: + get: + operationId: v1_inventory_oems_list + parameters: + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for oems by id, name + schema: + type: string + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedOEMList' + examples: + OEMResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + post: + operationId: v1_inventory_oems_create + tags: + - inventory/oems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMRequest: + value: + name: My OEM + summary: OEM Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/OEM' + multipart/form-data: + schema: + $ref: '#/components/schemas/OEM' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + /v1/inventory/oems/{id}/: + get: + operationId: v1_inventory_oems_retrieve + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + put: + operationId: v1_inventory_oems_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMRequest: + value: + name: My OEM + summary: OEM Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/OEM' + multipart/form-data: + schema: + $ref: '#/components/schemas/OEM' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + patch: + operationId: v1_inventory_oems_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMRequest: + value: + name: My OEM + summary: OEM Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/OEM' + multipart/form-data: + schema: + $ref: '#/components/schemas/OEM' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + delete: + operationId: v1_inventory_oems_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/oems/{id}/history/: + get: + operationId: v1_inventory_oems_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/providers/: + get: + operationId: v1_inventory_providers_list + parameters: + - in: query + name: display_name + schema: + type: string + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: instance_limit + schema: + type: integer + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - in: query + name: on_demand_speed + schema: + type: string + enum: + - fast + - slow + description: |- + Speed of on-demand inventory provisioning + + * `fast` - fast + * `slow` - slow + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: priority + schema: + type: integer + - name: search + required: false + in: query + description: Search for providers by display_name, id, name, on_demand_speed + schema: + type: string + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedProviderList' + examples: + ProviderResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + post: + operationId: v1_inventory_providers_create + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderRequest: + value: + display_name: My Provider + instance_limit: 250 + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Provider' + multipart/form-data: + schema: + $ref: '#/components/schemas/Provider' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + /v1/inventory/providers/{id}/: + get: + operationId: v1_inventory_providers_retrieve + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + put: + operationId: v1_inventory_providers_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderRequest: + value: + display_name: My Provider + instance_limit: 250 + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Provider' + multipart/form-data: + schema: + $ref: '#/components/schemas/Provider' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + patch: + operationId: v1_inventory_providers_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderRequest: + value: + display_name: My Provider + instance_limit: 250 + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Provider' + multipart/form-data: + schema: + $ref: '#/components/schemas/Provider' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + delete: + operationId: v1_inventory_providers_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/providers/{id}/history/: + get: + operationId: v1_inventory_providers_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/providers/bulk/: + patch: + operationId: v1_inventory_providers_bulk_partial_update + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + examples: + ProviderBulkUpdateRequest: + value: + display_name: My Provider + ids: + - f8bd1b72-c213-43ec-82ad-a56a44757a11 + - 5b528083-ab61-42dd-a6a1-90aa9babb014 + instance_limit: 250 + on_demand_speed: slow + priority: 50 + summary: Provider Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + examples: + ProviderBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Provider Bulk Update Response + description: '' + /v1/inventory/providers/stats/: + get: + operationId: v1_inventory_providers_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /version/: + get: + operationId: version_retrieve + tags: + - version + security: + - TokenAuthentication: [] + - {} + responses: + '200': + content: + application/json: + schema: + type: object + properties: + application_version: + type: string + examples: + ExampleResponse: + value: + application_version: 1.0.0 + summary: Example Response + description: '' +components: + schemas: + AuthLogin: + type: object + properties: + auth_code: + type: string + password: + type: string + username: + type: string + AuthRedirect: + type: object + properties: + redirect: + type: string + format: uri + required: + - redirect + AuthToken: + type: object + properties: + token: + type: string + readOnly: true + username: + type: string + readOnly: true + required: + - token + - username + BlankEnum: + enum: + - '' + x-enum-varnames: + - Blank + CategoryEnum: + enum: + - AI + - Clara + - Data Science + - 3D Design Collaboration and Simulation + - Developer + - Infrastructure Optimization + type: string + description: |- + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + x-enum-varnames: + - CategoryAI + - CategoryClara + - CategoryDataScience + - Category3DDesignCollaborationAndSimulation + - CategoryDeveloper + - CategoryInfrastructureOptimization + Cluster: + type: object + properties: + available: + type: boolean + readOnly: true + description: Is the cluster currently available for provisioning? + bastion_name: + type: + - string + - 'null' + description: Name of the bastion assigned to the cluster + maxLength: 32 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Deployment" + x-go-json-tag: "deployment,omitempty" + enabled: + type: boolean + description: Is the cluster administratively enabled? + experience: + type: + - string + - 'null' + format: uuid + description: Experience provisioned onto this cluster + free_by: + type: + - string + - 'null' + format: date-time + gpus: + type: array + items: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Gpu" + x-go-json-tag: "gpu,omitempty" + x-go-json-tag: "gpus,omitempty" + gpu_alias: + type: string + readOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + readOnly: true + id: + type: string + format: uuid + readOnly: true + instances: + type: array + items: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Instance" + x-go-json-tag: "instance,omitempty" + x-go-json-tag: "instances,omitempty" + last_provisioning_state_change: + type: + - string + - 'null' + format: date-time + readOnly: true + description: Timestamp of the last time the cluster's provisioning_state changed + last_used: + type: + - string + - 'null' + format: date-time + readOnly: true + description: Timestamp of when the cluster was last in use + maintenance: + type: boolean + description: Is the cluster in maintenance mode? + mgmt_ip: + type: string + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + description: Management MAC address + maxLength: 17 + minLength: 17 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + netmask: + type: + - integer + - 'null' + maximum: 32 + minimum: 0 + description: The subnet mask of the cluster's public IP address in CIDR notation + node_count: + type: integer + readOnly: true + nodes: + type: array + items: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Node" + x-go-json-tag: "node,omitempty" + x-go-json-tag: "nodes,omitempty" + notes: + type: + - string + - 'null' + description: Administrative comments about the cluster + persist: + type: boolean + description: Is the cluster exempt from provisioning_state timeouts? Can be used to ensure the cluster persists after a provisioning failure. + provider_capacity: + type: boolean + readOnly: true + description: Does the provider have capacity to provision this cluster? + provision_user: + type: + - string + - 'null' + description: Username used for provisioning this cluster + maxLength: 64 + provisioning_attempts: + type: integer + maximum: 2147483647 + minimum: 0 + description: The number of attempts that have been made to provision this cluster. Automatically resets to 0 after successful provisioning. + provisioning_config: + type: + - string + - 'null' + format: uuid + description: Applied provisioning configuration for the cluster + provisioning_request: + type: + - string + - 'null' + format: uuid + description: Requested provisioning configuration for the cluster + provisioning_state: + allOf: + - $ref: '#/components/schemas/ProvisioningStateEnum' + description: |- + Is the cluster currently provisioned? + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + public_address: + type: + - string + - 'null' + description: Public IP address or fully-qualified domain name of this cluster + maxLength: 255 + request_id: + type: + - string + - 'null' + description: 'The request ID for the lab that is currently provisioned on this cluster (ex: TRY-1234)' + maxLength: 32 + reservation: + type: boolean + description: Is the cluster a static reservation from its provider? + tenant_ids: + type: array + items: + type: string + format: uuid + readOnly: true + description: Tenant UUID(s) that have been generated for this cluster during provisioning + vlan_id: + type: integer + maximum: 4094 + minimum: 1 + description: VLAN number + workshop: + type: boolean + description: Is the cluster set aside for use in a workshop? + workshop_id: + type: + - string + - 'null' + description: Identifier of the workshop this cluster is set aside for + maxLength: 64 + required: + - available + - created + - deployment + - gpus + - id + - instances + - last_provisioning_state_change + - last_used + - modified + - provider_capacity + - tenant_ids + ClusterBulkUpdate: + type: object + properties: + available: + type: boolean + readOnly: true + writeOnly: true + description: Is the cluster currently available for provisioning? + bastion_name: + type: + - string + - 'null' + writeOnly: true + description: Name of the bastion assigned to the cluster + maxLength: 32 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + deployment: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Deployment" + x-go-json-tag: "deployment,omitempty" + enabled: + type: boolean + writeOnly: true + description: Is the cluster administratively enabled? + experience: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Experience provisioned onto this cluster + free_by: + type: + - string + - 'null' + format: date-time + writeOnly: true + gpus: + type: array + items: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Gpu" + x-go-json-tag: "gpu,omitempty" + x-go-json-tag: "gpus,omitempty" + gpu_alias: + type: string + readOnly: true + writeOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + readOnly: true + writeOnly: true + id: + type: string + format: uuid + readOnly: true + writeOnly: true + instances: + type: array + items: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Instance" + x-go-json-tag: "instance,omitempty" + x-go-json-tag: "instances,omitempty" + last_provisioning_state_change: + type: + - string + - 'null' + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of the last time the cluster's provisioning_state changed + last_used: + type: + - string + - 'null' + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the cluster was last in use + maintenance: + type: boolean + writeOnly: true + description: Is the cluster in maintenance mode? + mgmt_ip: + type: string + writeOnly: true + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + writeOnly: true + description: Management MAC address + maxLength: 17 + minLength: 17 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + netmask: + type: + - integer + - 'null' + maximum: 32 + minimum: 0 + writeOnly: true + description: The subnet mask of the cluster's public IP address in CIDR notation + node_count: + type: integer + readOnly: true + writeOnly: true + nodes: + type: array + items: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Node" + x-go-json-tag: "node,omitempty" + x-go-json-tag: "nodes,omitempty" + notes: + type: + - string + - 'null' + writeOnly: true + description: Administrative comments about the cluster + persist: + type: boolean + writeOnly: true + description: Is the cluster exempt from provisioning_state timeouts? Can be used to ensure the cluster persists after a provisioning failure. + provider_capacity: + type: boolean + readOnly: true + writeOnly: true + description: Does the provider have capacity to provision this cluster? + provision_user: + type: + - string + - 'null' + writeOnly: true + description: Username used for provisioning this cluster + maxLength: 64 + provisioning_attempts: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: The number of attempts that have been made to provision this cluster. Automatically resets to 0 after successful provisioning. + provisioning_config: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Applied provisioning configuration for the cluster + provisioning_request: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Requested provisioning configuration for the cluster + provisioning_state: + allOf: + - $ref: '#/components/schemas/ProvisioningStateEnum' + writeOnly: true + description: |- + Is the cluster currently provisioned? + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + public_address: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Public IP address or fully-qualified domain name of this cluster + maxLength: 255 + request_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: 'The request ID for the lab that is currently provisioned on this cluster (ex: TRY-1234)' + maxLength: 32 + reservation: + type: boolean + writeOnly: true + description: Is the cluster a static reservation from its provider? + tenant_ids: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + description: Tenant UUID(s) that have been generated for this cluster during provisioning + vlan_id: + type: integer + maximum: 4094 + minimum: 1 + writeOnly: true + description: VLAN number + workshop: + type: boolean + writeOnly: true + description: Is the cluster set aside for use in a workshop? + workshop_id: + type: + - string + - 'null' + writeOnly: true + description: Identifier of the workshop this cluster is set aside for + maxLength: 64 + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - available + - count + - created + - deployment + - gpu_alias + - gpu_count + - gpus + - id + - ids + - instances + - last_provisioning_state_change + - last_used + - modified + - node_count + - provider_capacity + - public_address + - request_id + - result + - tenant_ids + ClusterPipeline: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + readOnly: true + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + cluster: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Cluster" + x-go-json-tag: "cluster,omitempty" + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + readOnly: true + description: GitLab pipeline ID + request_id: + type: string + readOnly: true + description: Request ID that the pipeline was triggered for + url: + type: string + format: uri + readOnly: true + description: URL for the pipeline details + required: + - action + - cluster + - created + - id + - modified + - pipeline_id + - request_id + - url + ClusterPipelineTrigger: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + readOnly: true + description: GitLab pipeline ID + request_id: + type: string + readOnly: true + description: Request ID that the pipeline was triggered for + url: + type: string + format: uri + readOnly: true + description: URL for the pipeline details + required: + - action + - created + - id + - modified + - pipeline_id + - request_id + - url + ClusterProvisionCreateResponse: + type: object + properties: + pipeline: + allOf: + - $ref: '#/components/schemas/ClusterPipeline' + readOnly: true + provisioning_config: + allOf: + - $ref: '#/components/schemas/ProvisioningRequest' + readOnly: true + required: + - pipeline + - provisioning_config + CpuManufacturerEnum: + enum: + - amd + - arm + - intel + type: string + description: |- + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + x-enum-varnames: + - CpuManufacturerAMD + - CpuManufacturerARM + - CpuManufacturerIntel + Deployment: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured by Liftoff + maxLength: 32 + catalog_id: + type: string + writeOnly: true + description: Catalog ID of the experience provisioned to the cluster + catalog_id_alias: + type: string + writeOnly: true + description: Catalog ID alias of the experience provisioned to the cluster + cluster: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Cluster" + x-go-json-tag: "cluster,omitempty" + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + experience_id: + type: string + format: uuid + writeOnly: true + description: UUID of the experience provisioned to the cluster + expires_at: + type: + - string + - 'null' + format: date-time + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + ip_allowlist: + type: array + items: + type: string + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + description: Set expires_at value to be a given number of days from the current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster whose GPU count is greater than or equal to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + default: false + description: Override the default cleanup/destroy behavior when a provisioning failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + default: 0 + description: Override the pipeline ID that will be triggered for request fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - type: 'null' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + writeOnly: true + description: The initial or administrative public key used during deployment creation. Additional keys can be authorized for access using the `ssh-keys` endpoint. + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + format: email + description: Email address of the user requesting the experience + maxLength: 254 + requester_name: + type: string + description: Name of the user requesting the experience + maxLength: 255 + retry_count: + type: integer + readOnly: true + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + sales_id: + type: + - string + - 'null' + description: Unique identifier for the requester's sales relationship + maxLength: 32 + sales_owner_email: + type: + - string + - 'null' + format: email + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + ssh_port: + type: integer + readOnly: true + ssh_user: + type: string + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + readOnly: true + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static password. This is useful for workshops when you'd like an identical password associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - created + - id + - modified + - org_name + - overrides + - pipelines + - requester_email + - requester_name + - retry_count + - services + - ssh_port + - ssh_user + - state + DeploymentBulkUpdate: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override bastion operating system provisioned and/or configured by Liftoff + maxLength: 32 + cluster: + type: + - string + - 'null' + format: uuid + readOnly: true + writeOnly: true + description: The cluster where the experience has been deployed + collection_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + writeOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the experience branch + maxLength: 255 + expires_at: + type: + - string + - 'null' + format: date-time + writeOnly: true + flightcontrol_release: + type: + - string + - 'null' + writeOnly: true + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + writeOnly: true + ip_allowlist: + type: array + items: + type: string + writeOnly: true + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + description: Set expires_at value to be a given number of days from the current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + default: 0 + description: Require a cluster whose GPU count is greater than or equal to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + writeOnly: true + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + writeOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + writeOnly: true + default: false + description: Override the default cleanup/destroy behavior when a provisioning failure occurs + persona: + type: + - string + - 'null' + writeOnly: true + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + writeOnly: true + default: 0 + description: Override the pipeline ID that will be triggered for request fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the default pipeline branch ref used when triggering a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + platform: + writeOnly: true + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - type: 'null' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + readOnly: true + writeOnly: true + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: The initial or administrative public key used during deployment creation. Additional keys can be authorized for access using the `ssh-keys` endpoint. + region: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + readOnly: true + writeOnly: true + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + writeOnly: true + description: Email address of the user requesting the experience + requester_name: + type: string + writeOnly: true + description: Name of the user requesting the experience + retry_count: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + readOnly: true + writeOnly: true + description: Timestamp when the requester's sales relationship was created + sales_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Unique identifier for the requester's sales relationship + sales_owner_email: + type: + - string + - 'null' + format: email + writeOnly: true + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + writeOnly: true + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + writeOnly: true + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + writeOnly: true + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + readOnly: true + writeOnly: true + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the deployment's default authentication to use a static password. This is useful for workshops when you'd like an identical password associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - bastion_operating_system + - cluster + - count + - created + - experience + - garage_id + - gpu_alias + - gpu_count + - gpu_model + - gpu_os_name + - gpu_os_release + - gpu_os_version + - id + - ids + - lifetime + - min_gpu_count + - modified + - node_count + - oem_name + - overrides + - pipelines + - priority + - provider_name + - public_key + - region + - request_id + - result + - sales_created_date + - sales_id + - services + - workshop + - workshop_id + - workshop_override_password + DeploymentInstance: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + instance_id: + type: string + readOnly: true + description: Unique ID for this instance assigned by its provider + name: + type: + - string + - 'null' + readOnly: true + description: User-friendly name of this instance + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + state: + allOf: + - $ref: '#/components/schemas/InstanceState' + readOnly: true + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + state_modified: + type: string + format: date-time + readOnly: true + tags: + type: array + items: + type: string + maxLength: 64 + readOnly: true + description: Tags associated with this instance + required: + - created + - id + - instance_id + - modified + - name + - state + - state_modified + - tags + DeploymentKey: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Deployment" + x-go-json-tag: "deployment,omitempty" + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: Descriptive name for the SSH public key + maxLength: 64 + public_key: + type: string + writeOnly: true + description: An SSH public key that should be authorized to access the deployment + required: + - created + - deployment + - id + - modified + - name + - public_key + DeploymentNote: + type: object + properties: + content: + type: string + description: Text content of the note + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + created_by: + type: string + readOnly: true + deployment: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Deployment" + x-go-json-tag: "deployment,omitempty" + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + modified_by: + type: string + readOnly: true + required: + - created + - created_by + - deployment + - id + - modified + - modified_by + DeploymentPipeline: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Deployment" + x-go-json-tag: "deployment,omitempty" + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: GitLab pipeline ID + url: + type: string + format: uri + description: URL for the pipeline details + maxLength: 200 + required: + - action + - created + - deployment + - id + - modified + - pipeline_id + - url + DeploymentPipelineTrigger: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + readOnly: true + description: GitLab pipeline ID + url: + type: string + format: uri + readOnly: true + description: URL for the pipeline details + required: + - action + - created + - id + - modified + - pipeline_id + - url + DeploymentService: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Deployment" + x-go-json-tag: "deployment,omitempty" + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: Name of the service + maxLength: 32 + url: + type: string + format: uri + description: URL used to reach the service + maxLength: 200 + required: + - created + - deployment + - id + - modified + - name + - url + DeploymentState: + enum: + - destroyed + - destroying + - error + - failed + - paused + - ready + - retrying + - starting + - stopped + - stopping + - waiting + type: string + description: |- + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + x-enum-varnames: + - DeploymentStateDestroyed + - DeploymentStateDestroying + - DeploymentStateError + - DeploymentStateFailed + - DeploymentStatePaused + - DeploymentStateReady + - DeploymentStateRetrying + - DeploymentStateStarting + - DeploymentStateStopped + - DeploymentStateStopping + - DeploymentStateWaiting + DeploymentTask: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/DeploymentTaskActionEnum' + description: |- + The action the task will perform + + * `start_instances` - Start all instances in the deployment + * `stop_instances` - Stop all instances in the deployment + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Deployment" + x-go-json-tag: "deployment,omitempty" + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + retries: + type: integer + readOnly: true + description: Number of times the task has been retried + status: + allOf: + - $ref: '#/components/schemas/StatusEnum' + readOnly: true + description: |- + Current status of the task + + * `completed` - completed + * `failed` - failed + * `pending` - pending + * `processing` - processing + * `retrying` - retrying + status_text: + type: string + readOnly: true + description: Messages related to the current task status + required: + - action + - created + - deployment + - id + - modified + - retries + - status + - status_text + DeploymentTaskActionEnum: + enum: + - start_instances + - stop_instances + type: string + description: |- + * `start_instances` - Start all instances in the deployment + * `stop_instances` - Stop all instances in the deployment + x-enum-varnames: + - DeploymentTaskActionStartInstances + - DeploymentTaskActionStopInstances + DeploymentUpdate: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + readOnly: true + description: Override bastion operating system provisioned and/or configured by Liftoff + maxLength: 32 + cluster: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The cluster where the experience has been deployed + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + expires_at: + type: + - string + - 'null' + format: date-time + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + readOnly: true + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + readOnly: true + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + readOnly: true + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + readOnly: true + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + ip_allowlist: + type: array + items: + type: string + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + readOnly: true + description: Set expires_at value to be a given number of days from the current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + readOnly: true + default: 0 + description: Require a cluster whose GPU count is greater than or equal to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + readOnly: true + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + readOnly: true + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + default: false + description: Override the default cleanup/destroy behavior when a provisioning failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + default: 0 + description: Override the pipeline ID that will be triggered for request fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - type: 'null' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + readOnly: true + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + readOnly: true + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + readOnly: true + description: The initial or administrative public key used during deployment creation. Additional keys can be authorized for access using the `ssh-keys` endpoint. + region: + type: + - string + - 'null' + readOnly: true + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + readOnly: true + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + description: Email address of the user requesting the experience + requester_name: + type: string + description: Name of the user requesting the experience + retry_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + readOnly: true + description: Timestamp when the requester's sales relationship was created + sales_id: + type: + - string + - 'null' + readOnly: true + description: Unique identifier for the requester's sales relationship + sales_owner_email: + type: + - string + - 'null' + format: email + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + readOnly: true + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + readOnly: true + description: Override the deployment's default authentication to use a static password. This is useful for workshops when you'd like an identical password associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - bastion_operating_system + - cluster + - created + - experience + - garage_id + - gpu_alias + - gpu_count + - gpu_model + - gpu_os_name + - gpu_os_release + - gpu_os_version + - id + - lifetime + - min_gpu_count + - modified + - node_count + - oem_name + - overrides + - pipelines + - priority + - provider_name + - public_key + - region + - request_id + - sales_created_date + - sales_id + - services + - workshop + - workshop_id + - workshop_override_password + DocDeploymentDelete: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured by Liftoff + maxLength: 32 + catalog_id: + type: string + writeOnly: true + description: Catalog ID of the experience provisioned to the cluster + catalog_id_alias: + type: string + writeOnly: true + description: Catalog ID alias of the experience provisioned to the cluster + cluster: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Cluster" + x-go-json-tag: "cluster,omitempty" + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + experience_id: + type: string + format: uuid + writeOnly: true + description: UUID of the experience provisioned to the cluster + expires_at: + type: + - string + - 'null' + format: date-time + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + ip_allowlist: + type: array + items: + type: string + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + description: Set expires_at value to be a given number of days from the current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster whose GPU count is greater than or equal to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + default: false + description: Override the default cleanup/destroy behavior when a provisioning failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + default: 0 + description: Override the pipeline ID that will be triggered for request fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - type: 'null' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + writeOnly: true + description: The initial or administrative public key used during deployment creation. Additional keys can be authorized for access using the `ssh-keys` endpoint. + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + format: email + description: Email address of the user requesting the experience + maxLength: 254 + requester_name: + type: string + description: Name of the user requesting the experience + maxLength: 255 + retry_count: + type: integer + readOnly: true + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + sales_id: + type: + - string + - 'null' + description: Unique identifier for the requester's sales relationship + maxLength: 32 + sales_owner_email: + type: + - string + - 'null' + format: email + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + ssh_port: + type: integer + readOnly: true + ssh_user: + type: string + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + readOnly: true + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static password. This is useful for workshops when you'd like an identical password associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - created + - experience + - id + - modified + - org_name + - overrides + - pipelines + - requester_email + - requester_name + - retry_count + - services + - ssh_port + - ssh_user + - state + Experience: + type: object + properties: + assignee: + type: + - string + - 'null' + description: User ID who is responsible for manual provisioning + maxLength: 32 + autoapprove: + type: boolean + description: Can the experience be provisioned without human approval? + autoprovision: + type: boolean + description: Can the experience be provisioned without human intervention? + bootstrap: + type: boolean + description: Can this experience be used to bootstrap another compatible experience? + catalog_id: + type: string + description: Unique ID for this experience in the sales catalog. Must be unique. + maxLength: 32 + catalog_id_alias: + type: + - string + - 'null' + description: 'Human-readable identifier for the experience in the sales catalog (ex: LP-15). Must be unique.' + maxLength: 8 + category: + allOf: + - $ref: '#/components/schemas/CategoryEnum' + description: |- + Functional group that this experience is targetting + + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + collection_branch: + type: string + description: Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + description: + type: + - string + - 'null' + experience: + type: string + description: Experience name slug + maxLength: 64 + experience_branch: + type: string + description: 'Experience branch name used during deployment (default: origin/main)' + maxLength: 255 + fc_platform: + writeOnly: true + description: |- + Fleet Command platform type + + * `docker` - docker + * `k8s` - k8s + oneOf: + - $ref: '#/components/schemas/FcPlatformEnum' + - type: 'null' + fc_support: + type: boolean + writeOnly: true + description: Does the experience support Flight Control? + featured: + type: boolean + readOnly: true + description: Is the experience featured in the catalog? + garage_id: + type: + - string + - 'null' + description: ID of the garage where nodes for this experience should be selected from + maxLength: 64 + gc_branch: + type: string + description: 'Ground Control branch name (default: main)' + maxLength: 255 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Number of GPUs used + gpu_os: + $ref: '#/components/schemas/GpuOs' + id: + type: string + format: uuid + readOnly: true + inactivity_max: + type: integer + maximum: 2147483647 + minimum: 0 + description: 'Number of days without user interaction before the experience is torn down (default: 3)' + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + description: 'Default number of days a provisioned experience should remain active (default: 3). A null lifetime will cause a deployment to remain active indefinitely.' + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Number of Nodes used + oem: + type: + - string + - 'null' + format: uuid + description: If set, the experience must be provisioned to hardware manufactured by the given OEM + persona: + type: string + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: Pipeline ID used for provisioning + platform: + allOf: + - $ref: '#/components/schemas/PlatformEnum' + description: |- + Base platform that the experience will be provisioned onto + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + provider: + type: + - string + - 'null' + format: uuid + description: If set, the experience must be provisioned to the given provider + published: + allOf: + - $ref: '#/components/schemas/PublishedEnum' + description: |- + Is the experience published for use? + + * `draft` - draft + * `no` - no + * `yes` - yes + repo: + type: + - string + - 'null' + format: uri + writeOnly: true + description: URL of the repository for provisioning automation + maxLength: 200 + required_gpus: + type: array + items: + type: string + format: uuid + description: 'If set, the experience must be provisioned using one of the given GPU types. GPU requirements are evaluated in the order they are set (ex: ["{l40s_gpu_uuid}", "{a100_gpu_uuid}"] will prefer an l40s).' + runtime: + type: + - string + - 'null' + format: uuid + description: The default runtime to use when provisioning this experience + sa_lab: + type: boolean + description: Is this a persistent experience for SAs? + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + description: |- + Required CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + title: + type: string + vgpu_profile: + type: + - string + - 'null' + required: + - catalog_id + - category + - created + - experience + - featured + - gpu_os + - id + - modified + - persona + - pipeline + - platform + - system_arch + - title + ExperienceBulk: + type: object + properties: + csv_file: + type: string + format: uri + writeOnly: true + experiences: + type: array + items: + $ref: '#/components/schemas/Experience' + readOnly: true + required: + - csv_file + - experiences + ExperienceBulkUpdate: + type: object + properties: + assignee: + type: + - string + - 'null' + writeOnly: true + description: User ID who is responsible for manual provisioning + maxLength: 32 + autoapprove: + type: boolean + writeOnly: true + description: Can the experience be provisioned without human approval? + autoprovision: + type: boolean + writeOnly: true + description: Can the experience be provisioned without human intervention? + bootstrap: + type: boolean + writeOnly: true + description: Can this experience be used to bootstrap another compatible experience? + catalog_id: + type: string + readOnly: true + writeOnly: true + description: Unique ID for this experience in the sales catalog. Must be unique. + maxLength: 32 + catalog_id_alias: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: 'Human-readable identifier for the experience in the sales catalog (ex: LP-15). Must be unique.' + maxLength: 8 + category: + allOf: + - $ref: '#/components/schemas/CategoryEnum' + writeOnly: true + description: |- + Functional group that this experience is targetting + + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + collection_branch: + type: string + writeOnly: true + description: Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + description: + type: + - string + - 'null' + writeOnly: true + experience: + type: string + writeOnly: true + description: Experience name slug + maxLength: 64 + experience_branch: + type: string + writeOnly: true + description: 'Experience branch name used during deployment (default: origin/main)' + maxLength: 255 + fc_platform: + writeOnly: true + description: |- + Fleet Command platform type + + * `docker` - docker + * `k8s` - k8s + oneOf: + - $ref: '#/components/schemas/FcPlatformEnum' + - type: 'null' + fc_support: + type: boolean + writeOnly: true + description: Does the experience support Flight Control? + featured: + type: boolean + readOnly: true + writeOnly: true + description: Is the experience featured in the catalog? + garage_id: + type: + - string + - 'null' + writeOnly: true + description: ID of the garage where nodes for this experience should be selected from + maxLength: 64 + gc_branch: + type: string + writeOnly: true + description: 'Ground Control branch name (default: main)' + maxLength: 255 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + writeOnly: true + description: Number of GPUs used + gpu_os: + allOf: + - $ref: '#/components/schemas/GpuOs' + writeOnly: true + id: + type: string + format: uuid + readOnly: true + writeOnly: true + inactivity_max: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: 'Number of days without user interaction before the experience is torn down (default: 3)' + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: 'Default number of days a provisioned experience should remain active (default: 3). A null lifetime will cause a deployment to remain active indefinitely.' + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: Number of Nodes used + oem: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: If set, the experience must be provisioned to hardware manufactured by the given OEM + persona: + type: string + writeOnly: true + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + writeOnly: true + description: Pipeline ID used for provisioning + platform: + allOf: + - $ref: '#/components/schemas/PlatformEnum' + writeOnly: true + description: |- + Base platform that the experience will be provisioned onto + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + provider: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: If set, the experience must be provisioned to the given provider + published: + allOf: + - $ref: '#/components/schemas/PublishedEnum' + writeOnly: true + description: |- + Is the experience published for use? + + * `draft` - draft + * `no` - no + * `yes` - yes + repo: + type: + - string + - 'null' + format: uri + writeOnly: true + description: URL of the repository for provisioning automation + maxLength: 200 + required_gpus: + type: array + items: + type: string + format: uuid + writeOnly: true + description: 'If set, the experience must be provisioned using one of the given GPU types. GPU requirements are evaluated in the order they are set (ex: ["{l40s_gpu_uuid}", "{a100_gpu_uuid}"] will prefer an l40s).' + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: The default runtime to use when provisioning this experience + sa_lab: + type: boolean + writeOnly: true + description: Is this a persistent experience for SAs? + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + writeOnly: true + description: |- + Required CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + title: + type: string + writeOnly: true + vgpu_profile: + type: + - string + - 'null' + writeOnly: true + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - catalog_id + - catalog_id_alias + - category + - count + - created + - experience + - featured + - gpu_os + - id + - ids + - modified + - persona + - pipeline + - platform + - result + - system_arch + - title + ExperienceNote: + type: object + properties: + content: + type: string + description: Text content of the note + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + created_by: + type: string + readOnly: true + experience: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Experience" + x-go-json-tag: "experience,omitempty" + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + modified_by: + type: string + readOnly: true + required: + - created + - created_by + - experience + - id + - modified + - modified_by + FcPlatformEnum: + enum: + - docker + - k8s + type: string + description: |- + * `docker` - docker + * `k8s` - k8s + x-enum-varnames: + - FcPlatformDocker + - FcPlatformK8s + Gpu: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + form_factor: + allOf: + - $ref: '#/components/schemas/InterconnectionTypeEnum' + default: pcie + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + id: + type: string + format: uuid + readOnly: true + memory: + type: integer + maximum: 32768 + minimum: 0 + default: 0 + description: Total GPU memory (in GB) + model: + type: string + description: GPU model name + maxLength: 32 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + readOnly: true + priority: + type: integer + maximum: 100 + minimum: 0 + description: Weighted preference to use in selecting a GPU for a deployment. A higher priority means the GPU is in higher demand. Lower priority values will be preferred over higher ones during cluster selection. + required: + - created + - id + - model + - modified + GpuBulkUpdate: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + form_factor: + allOf: + - $ref: '#/components/schemas/InterconnectionTypeEnum' + writeOnly: true + default: pcie + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + id: + type: string + format: uuid + readOnly: true + writeOnly: true + memory: + type: integer + maximum: 32768 + minimum: 0 + writeOnly: true + default: 0 + description: Total GPU memory (in GB) + model: + type: string + writeOnly: true + description: GPU model name + maxLength: 32 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + readOnly: true + writeOnly: true + priority: + type: integer + maximum: 100 + minimum: 0 + writeOnly: true + description: Weighted preference to use in selecting a GPU for a deployment. A higher priority means the GPU is in higher demand. Lower priority values will be preferred over higher ones during cluster selection. + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - count + - created + - id + - ids + - model + - modified + - node_count + - result + GpuOs: + type: object + properties: + name: + type: string + release: + type: string + version: + type: string + required: + - name + - release + - version + GpuOsChoice: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: integer + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: 'Name of the OS to be provisioned onto GPU Node(s) (ex: ubuntu)' + maxLength: 16 + release: + type: string + description: 'Release name of the OS to be provisioned onto GPU Node(s) (ex: jammy)' + maxLength: 16 + version: + type: string + description: 'Version number of the OS to be provisioned onto GPU Node(s) (ex: 22.04)' + maxLength: 8 + required: + - created + - id + - modified + - name + - release + - version + Instance: + type: object + properties: + cluster: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Cluster" + x-go-json-tag: "cluster,omitempty" + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + instance_id: + type: string + description: Unique ID for this instance assigned by its provider + maxLength: 128 + name: + type: + - string + - 'null' + description: User-friendly name of this instance + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + state: + allOf: + - $ref: '#/components/schemas/InstanceState' + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + state_modified: + type: string + format: date-time + readOnly: true + tags: + type: array + items: + type: string + maxLength: 64 + description: Tags associated with this instance + required: + - cluster + - created + - id + - instance_id + - modified + - state_modified + InstanceBulkUpdate: + type: object + properties: + cluster: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Cluster" + x-go-json-tag: "cluster,omitempty" + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + writeOnly: true + instance_id: + type: string + readOnly: true + writeOnly: true + description: Unique ID for this instance assigned by its provider + maxLength: 128 + name: + type: + - string + - 'null' + writeOnly: true + description: User-friendly name of this instance + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + state: + allOf: + - $ref: '#/components/schemas/InstanceState' + writeOnly: true + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + state_modified: + type: string + format: date-time + readOnly: true + writeOnly: true + tags: + type: array + items: + type: string + maxLength: 64 + writeOnly: true + description: Tags associated with this instance + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - cluster + - count + - created + - id + - ids + - instance_id + - modified + - result + - state_modified + InstanceState: + enum: + - running + - starting + - stopped + - stopping + - unknown + type: string + description: |- + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + x-enum-varnames: + - InstanceStateRunning + - InstanceStateStarting + - InstanceStateStopped + - InstanceStateStopping + - InstanceStateUnknown + InstanceType: + type: object + properties: + capacity: + type: object + additionalProperties: + type: integer + description: Key/value pairs of region name and total available capacity for the instance type + cloud: + type: string + description: Cloud provider name + cpu: + type: integer + description: Total number of CPUs/vCPUs available + gpu: + $ref: '#/components/schemas/InstanceTypeGpu' + memory_gb: + type: integer + description: Total system memory (in GB) + price: + $ref: '#/components/schemas/InstanceTypePrice' + regions: + type: array + items: + type: string + description: List of regions names that have available capacity for the instance type + storage: + type: array + items: + $ref: '#/components/schemas/InstanceTypeStorage' + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + workshop_id: + type: string + description: ID of the workshop this instance type is reserved for + required: + - capacity + - cloud + - cpu + - gpu + - memory_gb + - price + - regions + - storage + - system_arch + - workshop_id + InstanceTypeGpu: + type: object + properties: + count: + type: integer + description: Total number of GPUs + family: + type: string + description: GPU family name + interconnection_type: + allOf: + - $ref: '#/components/schemas/InterconnectionTypeEnum' + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + manufacturer: + type: string + description: GPU manufacturer name + memory_gb: + type: integer + description: Total GPU memory (in GB) + model: + type: string + description: GPU model name + required: + - count + - family + - interconnection_type + - manufacturer + - memory_gb + - model + InstanceTypePrice: + type: object + properties: + currency: + type: string + description: Currency code + on_demand_per_hour: + type: number + format: double + description: Price per hour + required: + - currency + - on_demand_per_hour + InstanceTypeStorage: + type: object + properties: + size_gb: + type: integer + description: System storage size (in GB) + type: + allOf: + - $ref: '#/components/schemas/TypeEnum' + description: |- + Disk type + + * `nvme` - NVMe + * `ssd` - ssd + required: + - size_gb + - type + InterconnectionTypeEnum: + enum: + - pcie + - sxm + type: string + description: |- + * `pcie` - PCIe + * `sxm` - SXM + x-enum-varnames: + - InterconnectionTypePCIe + - InterconnectionTypeSXM + Location: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + provider: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Provider" + x-go-json-tag: "provider,omitempty" + region: + type: + - string + - 'null' + description: Name of the region the location is in + maxLength: 64 + required: + - created + - id + - modified + - name + - provider + Logout: + type: object + properties: + result: + type: string + readOnly: true + default: Successfully logged out. + required: + - result + ModelChange: + type: object + properties: + change_type: + type: string + readOnly: true + changes: + type: array + items: + type: object + properties: + field: + type: string + new_value: + oneOf: + - type: string + - type: boolean + - type: integer + nullable: true + old_value: + oneOf: + - type: string + - type: boolean + - type: integer + nullable: true + required: + - field + - new_value + - old_value + readOnly: true + created: + type: string + format: date-time + id: + type: integer + username: + type: string + required: + - change_type + - changes + - created + - id + - username + NetworkTypeEnum: + enum: + - ethernet + - infiniband + type: string + description: |- + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + x-enum-varnames: + - NetworkTypeEthernet + - NetworkTypeInfiniband + Node: + type: object + properties: + bmc_ip: + type: + - string + - 'null' + description: IP address of the BMC + bmc_mac: + type: + - string + - 'null' + description: MAC address of the BMC + maxLength: 17 + minLength: 17 + bmc_password: + type: + - string + - 'null' + description: Password for the BMC + maxLength: 32 + bmc_user: + type: + - string + - 'null' + description: Username for the BMC + maxLength: 64 + cluster: + type: + - string + - 'null' + format: uuid + description: UUID of the node's parent cluster + cpu: + type: integer + maximum: 1024 + minimum: 0 + description: Number of CPU cores installed + cpu_manufacturer: + description: |- + Manufacturer of the node's CPU + + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + oneOf: + - $ref: '#/components/schemas/CpuManufacturerEnum' + - type: 'null' + cpu_model: + type: + - string + - 'null' + description: Model information for the node's CPU + maxLength: 64 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + garage_id: + type: + - string + - 'null' + description: ID for the garage where a node is parked when unprovisioned + maxLength: 128 + gpu: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Gpu" + x-go-json-tag: "gpu,omitempty" + gpu_alias: + type: string + readOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Number of GPUs installed + gpu_model: + type: string + readOnly: true + description: Model of GPU(s) installed + gpu_vbios: + type: + - string + - 'null' + description: VBIOS version used by installed GPU(s) + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + location: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Location" + x-go-json-tag: "location,omitempty" + memory: + type: integer + maximum: 32768 + minimum: 0 + description: Amount of RAM installed (in GB) + mgmt_ip: + type: string + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + description: Management MAC address + maxLength: 17 + minLength: 17 + model: + type: + - string + - 'null' + description: Hardware model of the node + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + network_type: + allOf: + - $ref: '#/components/schemas/NetworkTypeEnum' + description: |- + Type of networking technology used + + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + nic_prefixes: + type: array + items: + type: string + maxLength: 15 + description: Prefixes for the node's network interface(s) + notes: + type: + - string + - 'null' + description: Administrative comments about the node + oem: + type: + - string + - 'null' + format: uuid + description: UUID of the node's OEM + provider_node_id: + type: + - string + - 'null' + description: Unique ID for this node assigned by its provider + maxLength: 128 + rack: + type: + - string + - 'null' + description: Physical rack identifier + maxLength: 32 + rack_unit: + type: + - integer + - 'null' + maximum: 52 + minimum: 0 + description: The rack unit (RU) within the rack where the node is installed + serial_number: + type: + - string + - 'null' + description: Serial number of the node + maxLength: 32 + storage: + type: array + items: + $ref: '#/components/schemas/NodeStorage' + minItems: 1 + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + tee: + type: boolean + description: Does the node support Trusted Execution Environment (TEE)? + required: + - created + - gpu + - gpu_alias + - gpu_model + - id + - location + - modified + - storage + - system_arch + NodeBulk: + type: object + properties: + csv_file: + type: string + format: uri + writeOnly: true + nodes: + type: array + items: + $ref: '#/components/schemas/Node' + readOnly: true + required: + - csv_file + - nodes + NodeBulkUpdate: + type: object + properties: + bmc_ip: + type: + - string + - 'null' + writeOnly: true + description: IP address of the BMC + bmc_mac: + type: + - string + - 'null' + writeOnly: true + description: MAC address of the BMC + maxLength: 17 + minLength: 17 + bmc_password: + type: + - string + - 'null' + writeOnly: true + description: Password for the BMC + maxLength: 32 + bmc_user: + type: + - string + - 'null' + writeOnly: true + description: Username for the BMC + maxLength: 64 + cluster: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: UUID of the node's parent cluster + cpu: + type: integer + maximum: 1024 + minimum: 0 + writeOnly: true + description: Number of CPU cores installed + cpu_manufacturer: + writeOnly: true + description: |- + Manufacturer of the node's CPU + + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + oneOf: + - $ref: '#/components/schemas/CpuManufacturerEnum' + - type: 'null' + cpu_model: + type: + - string + - 'null' + writeOnly: true + description: Model information for the node's CPU + maxLength: 64 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + garage_id: + type: + - string + - 'null' + writeOnly: true + description: ID for the garage where a node is parked when unprovisioned + maxLength: 128 + gpu: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Gpu" + x-go-json-tag: "gpu,omitempty" + gpu_alias: + type: string + readOnly: true + writeOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + maximum: 512 + minimum: 0 + writeOnly: true + description: Number of GPUs installed + gpu_model: + type: string + readOnly: true + writeOnly: true + description: Model of GPU(s) installed + gpu_vbios: + type: + - string + - 'null' + writeOnly: true + description: VBIOS version used by installed GPU(s) + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + writeOnly: true + location: + oneOf: + - type: + - string + format: uuid + - $ref: "#/components/schemas/Location" + x-go-json-tag: "location,omitempty" + memory: + type: integer + maximum: 32768 + minimum: 0 + writeOnly: true + description: Amount of RAM installed (in GB) + mgmt_ip: + type: string + writeOnly: true + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + writeOnly: true + description: Management MAC address + maxLength: 17 + minLength: 17 + model: + type: + - string + - 'null' + writeOnly: true + description: Hardware model of the node + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + network_type: + allOf: + - $ref: '#/components/schemas/NetworkTypeEnum' + writeOnly: true + description: |- + Type of networking technology used + + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + nic_prefixes: + type: array + items: + type: string + maxLength: 15 + writeOnly: true + description: Prefixes for the node's network interface(s) + notes: + type: + - string + - 'null' + writeOnly: true + description: Administrative comments about the node + oem: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: UUID of the node's OEM + provider_node_id: + type: + - string + - 'null' + writeOnly: true + description: Unique ID for this node assigned by its provider + maxLength: 128 + rack: + type: + - string + - 'null' + writeOnly: true + description: Physical rack identifier + maxLength: 32 + rack_unit: + type: + - integer + - 'null' + maximum: 52 + minimum: 0 + writeOnly: true + description: The rack unit (RU) within the rack where the node is installed + serial_number: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Serial number of the node + maxLength: 32 + storage: + type: array + items: + $ref: '#/components/schemas/NodeStorage' + writeOnly: true + minItems: 1 + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + writeOnly: true + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + tee: + type: boolean + writeOnly: true + description: Does the node support Trusted Execution Environment (TEE)? + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - count + - created + - gpu + - gpu_alias + - gpu_model + - id + - ids + - location + - modified + - result + - serial_number + - storage + - system_arch + NodeStorage: + type: object + properties: + size: + type: integer + default: 0 + description: Disk size (in GB) + maximum: 1000000 + minimum: 0 + type: + allOf: + - $ref: '#/components/schemas/TypeEnum' + description: |- + Disk type + + * `nvme` - NVMe + * `ssd` - ssd + required: + - type + NullEnum: + type: 'null' + OEM: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + required: + - created + - id + - modified + - name + OnDemandSpeedEnum: + enum: + - fast + - slow + type: string + description: |- + * `fast` - fast + * `slow` - slow + x-enum-varnames: + - OnDemandSpeedFast + - OnDemandSpeedSlow + Overrides: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured by Liftoff + maxLength: 32 + cluster: + type: + - string + - 'null' + format: uuid + description: Target a specific cluster for provisioning + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the pipeline + maxLength: 255 + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster with the given number of GPUs + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + min_gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster whose GPU count is greater than or equal to the given number + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Require a cluster with the given number of nodes + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + persist_on_failure: + type: + - boolean + - 'null' + description: Override the default cleanup/destroy behavior when a provisioning failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: Override the pipeline ID that will be triggered for request fulfillment + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering a Fuselage pipeline + maxLength: 255 + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - type: 'null' + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + runtime: + type: + - string + - 'null' + format: uuid + description: Use the presets of the given runtime when provisioning this experience + runtime_branch: + type: + - string + - 'null' + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + description: Override the URL of the runtime repository + maxLength: 200 + workshop: + type: + - boolean + - 'null' + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static password. This is useful for workshops when you'd like an identical password associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + PaginatedClusterList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Cluster' + PaginatedClusterPipelineList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ClusterPipeline' + PaginatedDeploymentInstanceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentInstance' + PaginatedDeploymentKeyList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentKey' + PaginatedDeploymentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Deployment' + PaginatedDeploymentNoteList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentNote' + PaginatedDeploymentPipelineList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentPipeline' + PaginatedDeploymentServiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentService' + PaginatedDeploymentTaskList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentTask' + PaginatedExperienceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Experience' + PaginatedExperienceNoteList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ExperienceNote' + PaginatedGpuList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Gpu' + PaginatedGpuOsChoiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/GpuOsChoice' + PaginatedInstanceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Instance' + PaginatedInstanceTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/InstanceType' + PaginatedLocationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Location' + PaginatedModelChangeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ModelChange' + PaginatedNodeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Node' + PaginatedOEMList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/OEM' + PaginatedPersonaChoiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/PersonaChoice' + PaginatedProviderList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Provider' + PaginatedRuntimeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Runtime' + PaginatedVGpuProfileChoiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/VGpuProfileChoice' + PasswordChange: + type: object + properties: + username: + type: string + writeOnly: true + password: + type: string + writeOnly: true + new_password: + type: string + writeOnly: true + result: + type: string + readOnly: true + default: Password changed successfully. + required: + - new_password + - password + - result + - username + PersonaChoice: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: integer + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 32 + required: + - created + - id + - modified + - name + PipelineAction: + enum: + - apply + - destroy + - notify + type: string + description: |- + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + x-enum-varnames: + - PipelineActionApply + - PipelineActionDestroy + - PipelineActionNotify + PlatformEnum: + enum: + - air + - flight_deck + - kvm_bastion + - lp-vmware-platform + - minimal + - openshift + - proxmox + - vsphere + - vsphere_horizon + - vsphere7 + - vsphere8 + type: string + description: |- + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + x-enum-varnames: + - PlatformAir + - PlatformFlightDeck + - PlatformKvmBastion + - PlatformLpVmwarePlatformLegacy + - PlatformMinimal + - PlatformOpenshift + - PlatformProxmox + - PlatformVsphere + - PlatformVsphereHorizon + - PlatformVsphere7 + - PlatformVsphere8 + PreferredThemeEnum: + enum: + - light + - dark + type: string + description: |- + * `light` - light + * `dark` - dark + x-enum-varnames: + - PreferredThemeLight + - PreferredThemeDark + PriorityEnum: + enum: + - p0 + - p1 + - p2 + - p3 + type: string + description: |- + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + x-enum-varnames: + - PriorityP0 + - PriorityP1 + - PriorityP2 + - PriorityP3 + Profile: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + display_name: + type: + - string + - 'null' + readOnly: true + description: Display name of the user + groups: + type: array + items: + type: string + readOnly: true + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + preferred_theme: + description: |- + Preferred user interface theme + + * `light` - light + * `dark` - dark + oneOf: + - $ref: '#/components/schemas/PreferredThemeEnum' + - type: 'null' + preferred_view_settings: + description: Preferred user view settings + username: + type: string + required: + - created + - display_name + - groups + - id + - modified + - username + Provider: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + display_name: + type: + - string + - 'null' + description: Human-friendly version of name. Used for display purposes. + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + instance_limit: + type: integer + maximum: 2147483647 + minimum: 0 + description: The maximum number of provisionined instances allowed globally for the provider (0 = unlimited) + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + on_demand_speed: + allOf: + - $ref: '#/components/schemas/OnDemandSpeedEnum' + description: |- + Speed of on-demand inventory provisioning + + * `fast` - fast + * `slow` - slow + priority: + type: integer + maximum: 100 + minimum: 0 + description: Weighted preference to use in selecting a provider for a deployment. Higher priority values will be preferred over lower ones. + required: + - created + - id + - modified + - name + ProviderBulkUpdate: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + display_name: + type: + - string + - 'null' + writeOnly: true + description: Human-friendly version of name. Used for display purposes. + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + writeOnly: true + instance_limit: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: The maximum number of provisionined instances allowed globally for the provider (0 = unlimited) + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + name: + type: string + readOnly: true + writeOnly: true + maxLength: 64 + on_demand_speed: + allOf: + - $ref: '#/components/schemas/OnDemandSpeedEnum' + writeOnly: true + description: |- + Speed of on-demand inventory provisioning + + * `fast` - fast + * `slow` - slow + priority: + type: integer + maximum: 100 + minimum: 0 + writeOnly: true + description: Weighted preference to use in selecting a provider for a deployment. Higher priority values will be preferred over lower ones. + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - count + - created + - id + - ids + - modified + - name + - result + ProvisioningRequest: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured by Liftoff + maxLength: 32 + catalog_id: + type: string + writeOnly: true + description: Catalog ID of the experience provisioned to the cluster + catalog_id_alias: + type: string + writeOnly: true + description: Catalog ID alias of the experience provisioned to the cluster + cluster: + type: + - string + - 'null' + format: uuid + description: Target a specific cluster for provisioning + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the pipeline + maxLength: 255 + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + experience_id: + type: string + format: uuid + writeOnly: true + description: UUID of the experience provisioned to the cluster + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster with the given number of GPUs + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + min_gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster whose GPU count is greater than or equal to the given number + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Require a cluster with the given number of nodes + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + persist_on_failure: + type: + - boolean + - 'null' + description: Override the default cleanup/destroy behavior when a provisioning failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: Override the pipeline ID that will be triggered for request fulfillment + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering a Fuselage pipeline + maxLength: 255 + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - type: 'null' + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + description: 'Trial request ID (ex: TRY-1234)' + maxLength: 32 + runtime: + type: + - string + - 'null' + format: uuid + description: Use the presets of the given runtime when provisioning this experience + runtime_branch: + type: + - string + - 'null' + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + description: Override the URL of the runtime repository + maxLength: 200 + workshop: + type: + - boolean + - 'null' + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static password. This is useful for workshops when you'd like an identical password associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - experience + - request_id + ProvisioningStateEnum: + enum: + - deployed + - deploying + - destroying + - pending + - ready + - reserved + - unprovisioned + type: string + description: |- + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + x-enum-varnames: + - ProvisioningStateDeployed + - ProvisioningStateDeploying + - ProvisioningStateDestroying + - ProvisioningStatePending + - ProvisioningStateReady + - ProvisioningStateReserved + - ProvisioningStateUnprovisioned + PublishedEnum: + enum: + - draft + - 'no' + - 'yes' + type: string + description: |- + * `draft` - draft + * `no` - no + * `yes` - yes + x-enum-varnames: + - PublishedDraft + - PublishedNo + - PublishedYes + Runtime: + type: object + properties: + branch: + type: string + description: Runtime repository branch + maxLength: 255 + cns_addon_pack: + type: boolean + description: Include CNS add-ons? + cns_docker: + type: boolean + description: Include Docker with CNS? + cns_driver_version: + type: + - string + - 'null' + description: GPU driver version + maxLength: 11 + cns_k8s: + type: boolean + description: Include Kubernetes with CNS? + cns_nvidia_driver: + type: boolean + description: Include NVIDIA driver with CNS? + cns_version: + type: + - string + - 'null' + description: NVIDIA Cloud Native Stack version + maxLength: 11 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + mig: + type: boolean + description: Include MIG support with CNS? + mig_profile: + type: + - string + - 'null' + description: MIG profile name + maxLength: 32 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: Human-readable name of the runtime + maxLength: 64 + url: + type: string + format: uri + description: URL of the runtime repository + maxLength: 200 + required: + - created + - id + - modified + - name + - url + StatusEnum: + enum: + - completed + - failed + - pending + - processing + - retrying + type: string + description: |- + * `completed` - completed + * `failed` - failed + * `pending` - pending + * `processing` - processing + * `retrying` - retrying + x-enum-varnames: + - StatusCompleted + - StatusFailed + - StatusPending + - StatusProcessing + - StatusRetrying + SystemArchEnum: + enum: + - amd64 + - arm64 + type: string + description: |- + * `amd64` - amd64 + * `arm64` - arm64 + x-enum-varnames: + - SystemArchAMD64 + - SystemArchARM64 + Tenant: + type: object + properties: + id: + type: string + format: uuid + writeOnly: true + required: + - id + TypeEnum: + enum: + - nvme + - ssd + type: string + description: |- + * `nvme` - NVMe + * `ssd` - ssd + x-enum-varnames: + - TypeNVMe + - TypeSSD + VGpuProfileChoice: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: integer + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + required: + - created + - id + - modified + - name + securitySchemes: + TokenAuthentication: + type: apiKey + in: header + name: Authorization + description: 'Authenticate with your user''s API token. Be sure to include a prefix of "Token" (ex: "Token xxxxx").' diff --git a/v1/providers/launchpad/swagger-v2.40.9.yaml b/v1/providers/launchpad/swagger-v2.40.9.yaml new file mode 100644 index 0000000..4a85aff --- /dev/null +++ b/v1/providers/launchpad/swagger-v2.40.9.yaml @@ -0,0 +1,14841 @@ +openapi: 3.1.0 +info: + title: NVIDIA LaunchPad API + version: 2.40.9 + description: RESTful API for interacting with the NVIDIA LaunchPad platform +paths: + /health/: + get: + operationId: health_retrieve + tags: + - health + security: + - TokenAuthentication: [] + - {} + responses: + '200': + content: + application/json: + schema: + type: object + properties: + status: + type: string + components: + type: object + properties: + application: + type: string + database: + type: string + examples: + HealthyResponse: + value: + status: healthy + components: + application: ok + database: ok + summary: Healthy Response + description: '' + '503': + content: + application/json: + schema: + type: object + properties: + status: + type: string + components: + type: object + properties: + application: + type: string + database: + type: string + examples: + UnhealthyResponse: + value: + status: unhealthy + components: + application: ok + database: connection failure + summary: Unhealthy Response + description: '' + /v1/auth/login/: + post: + operationId: v1_auth_login_create + description: Login with either an authorization code or username and password + (deprecated) to generate an API token that can be used with all other API + endpoints. + tags: + - auth + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AuthLogin' + multipart/form-data: + schema: + $ref: '#/components/schemas/AuthLogin' + application/json: + schema: + $ref: '#/components/schemas/AuthLogin' + examples: + AuthCode: + value: + auth_code: string + summary: Auth Code + Username&Password(deprecated): + value: + username: string + password: string + summary: Username & Password (deprecated) + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthToken' + description: '' + /v1/auth/logout/: + post: + operationId: v1_auth_logout_create + description: Logout from the current session. Your API token will no longer + be usable and must be regenerated via the login API. + tags: + - auth + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Logout' + description: '' + /v1/auth/password-change/: + post: + operationId: v1_auth_password_change_create + description: Change your current password + tags: + - auth + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PasswordChange' + multipart/form-data: + schema: + $ref: '#/components/schemas/PasswordChange' + application/json: + schema: + $ref: '#/components/schemas/PasswordChange' + required: true + security: + - TokenAuthentication: [] + deprecated: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordChange' + description: '' + /v1/auth/redirect/: + get: + operationId: v1_auth_redirect_retrieve + description: Get an HTTP redirect to begin an OAuth login flow. + parameters: + - in: query + name: as_json + schema: + type: boolean + description: If "false" or unset, receive an HTTP 302 with the OAuth URL returned + in the Location header. If "true", receive an HTTP 200 with the OAuth URL + returned in the JSON payload. + tags: + - auth + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthRedirect' + description: '' + '302': + description: No response body + /v1/catalog/deployments/: + get: + operationId: v1_catalog_deployments_list + parameters: + - in: query + name: bastion_operating_system + schema: + type: string + - in: query + name: cluster + schema: + type: string + format: uuid + - in: query + name: cluster_gpus_model + schema: + type: array + items: + type: string + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: collection_branch + schema: + type: string + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "cluster").' + - in: query + name: experience + schema: + type: string + format: uuid + - in: query + name: experience_branch + schema: + type: string + - in: query + name: expired + schema: + type: boolean + - in: query + name: expires_at + schema: + type: string + format: date + - in: query + name: expiring + schema: + type: string + description: Include deployments whose expires_at value is within the given + range (inclusive), specified as "today", "tomorrow", or "{start}[,end]". + Start and end times must be in ISO format. + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: flightcontrol_release + schema: + type: string + - in: query + name: garage_id + schema: + type: string + - in: query + name: gc_branch + schema: + type: string + - in: query + name: gpu_alias + schema: + type: string + - in: query + name: gpu_count + schema: + type: integer + - in: query + name: gpu_model + schema: + type: string + - in: query + name: gpu_os_name + schema: + type: string + - in: query + name: gpu_os_release + schema: + type: string + - in: query + name: gpu_os_version + schema: + type: string + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: node_count + schema: + type: integer + - in: query + name: oem_name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: org_name + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: persist_on_failure + schema: + type: boolean + - in: query + name: persona + schema: + type: string + - in: query + name: pipeline + schema: + type: integer + - in: query + name: pipeline_branch + schema: + type: string + - in: query + name: platform + schema: + type: string + - in: query + name: priority + schema: + type: string + enum: + - p0 + - p1 + - p2 + - p3 + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + - in: query + name: provider_name + schema: + type: string + - in: query + name: region + schema: + type: string + - in: query + name: request_id + schema: + type: string + - in: query + name: requester_email + schema: + type: string + - in: query + name: requester_name + schema: + type: string + - in: query + name: runtime_branch + schema: + type: string + - in: query + name: runtime_cns_addon_pack + schema: + type: boolean + - in: query + name: runtime_cns_docker + schema: + type: boolean + - in: query + name: runtime_cns_driver_version + schema: + type: string + - in: query + name: runtime_cns_k8s + schema: + type: boolean + - in: query + name: runtime_cns_nvidia_driver + schema: + type: boolean + - in: query + name: runtime_cns_version + schema: + type: string + - in: query + name: runtime_mig + schema: + type: boolean + - in: query + name: runtime_mig_profile + schema: + type: string + - in: query + name: sales_id + schema: + type: string + - in: query + name: sales_owner_email + schema: + type: string + - in: query + name: sales_owner_name + schema: + type: string + - name: search + required: false + in: query + description: Search for deployments by experience catalog_id, experience catalog_id_alias, + experience id, experience title, expires_at, id, org_name, provisioning_config + bastion_operating_system, provisioning_config collection_branch, provisioning_config + experience_branch, provisioning_config flightcontrol_release, provisioning_config + garage_id, provisioning_config gc_branch, provisioning_config gpu_alias, + provisioning_config gpu_model, provisioning_config gpu_os_name, provisioning_config + gpu_os_release, provisioning_config gpu_os_version, provisioning_config + oem_name, provisioning_config persona, provisioning_config pipeline_branch, + provisioning_config platform, provisioning_config provider_name, provisioning_config + region, provisioning_config runtime_branch, provisioning_config runtime_cns_driver_version, + provisioning_config runtime_cns_version, provisioning_config runtime_mig_profile, + provisioning_config runtime_url, provisioning_config workshop_id, provisioning_request + bastion_operating_system, provisioning_request collection_branch, provisioning_request + experience_branch, provisioning_request flightcontrol_release, provisioning_request + garage_id, provisioning_request gc_branch, provisioning_request gpu_alias, + provisioning_request gpu_model, provisioning_request gpu_os_name, provisioning_request + gpu_os_release, provisioning_request gpu_os_version, provisioning_request + oem_name, provisioning_request persona, provisioning_request pipeline_branch, + provisioning_request platform, provisioning_request provider_name, provisioning_request + region, provisioning_request runtime_branch, provisioning_request runtime_cns_driver_version, + provisioning_request runtime_cns_version, provisioning_request runtime_mig_profile, + provisioning_request runtime_url, provisioning_request workshop_id, request_id, + requester_email, requester_name, sales_id, sales_owner_email, sales_owner_name, + services url, state, tags + schema: + type: string + - in: query + name: state + schema: + type: array + items: + type: string + enum: + - destroyed + - destroying + - error + - failed + - paused + - ready + - retrying + - starting + - stopped + - stopping + - waiting + description: |- + Multiple values may be separated by commas. + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + explode: false + style: form + - in: query + name: state_not + schema: + type: array + items: + type: string + enum: + - destroyed + - destroying + - error + - failed + - paused + - ready + - retrying + - starting + - stopped + - stopping + - waiting + description: |- + Multiple values may be separated by commas. + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + explode: false + style: form + - in: query + name: workshop + schema: + type: boolean + - in: query + name: workshop_id + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + post: + operationId: v1_catalog_deployments_create + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "cluster").' + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Deployment' + examples: + DeploymentRequest(CatalogIDAlias): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id_alias: LP-15 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + startup_script: '#!/bin/bash echo "Hello world"' + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Request (Catalog ID Alias) + DeploymentRequest(ExperienceID): + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + startup_script: '#!/bin/bash echo "Hello world"' + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Request (Experience ID) + DeploymentRequest(CatalogID): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id: aBY3Z000000xBL4NCO + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + startup_script: '#!/bin/bash echo "Hello world"' + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Request (Catalog ID) + DeploymentRequest(MinimumRequiredFields): + value: + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + org_name: NVIDIA + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + summary: Deployment Request (Minimum Required Fields) + DeploymentRequest(MinimumRequiredFieldsW/CatalogID): + value: + catalog_id: aBY3Z000000xBL4NCO + org_name: NVIDIA + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + summary: Deployment Request (Minimum Required Fields w/ Catalog ID) + DeploymentRequest(MinimumRequiredFieldsW/CatalogIDAlias): + value: + catalog_id_alias: LP-15 + org_name: NVIDIA + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + summary: Deployment Request (Minimum Required Fields w/ Catalog ID + Alias) + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Deployment' + multipart/form-data: + schema: + $ref: '#/components/schemas/Deployment' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Deployment' + examples: + SuccessfulResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + /v1/catalog/deployments/{deployment_id}/instances/: + get: + operationId: v1_catalog_deployments_instances_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: instance_id + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-instances by id, instance_id, name, state, + tags + schema: + type: string + - in: query + name: state + schema: + type: string + enum: + - running + - starting + - stopped + - stopping + - unknown + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentInstanceList' + examples: + DeploymentInstanceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: DeploymentInstance Response + description: '' + /v1/catalog/deployments/{deployment_id}/notes/: + get: + operationId: v1_catalog_deployments_notes_list + parameters: + - in: query + name: created_by + schema: + type: integer + - in: query + name: deployment + schema: + type: string + format: uuid + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: modified_by + schema: + type: integer + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-notes by content + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentNoteList' + examples: + DeploymentNoteResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + post: + operationId: v1_catalog_deployments_notes_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteRequest: + value: + content: Hello world + summary: DeploymentNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentNote' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + /v1/catalog/deployments/{deployment_id}/notes/{id}/: + get: + operationId: v1_catalog_deployments_notes_retrieve + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + put: + operationId: v1_catalog_deployments_notes_update + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteRequest: + value: + content: Hello world + summary: DeploymentNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + patch: + operationId: v1_catalog_deployments_notes_partial_update + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteRequest: + value: + content: Hello world + summary: DeploymentNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentNote' + examples: + DeploymentNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: bb3ade1b-dffa-46f2-bf1d-52dfc7b1c331 + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: DeploymentNote Response + description: '' + delete: + operationId: v1_catalog_deployments_notes_destroy + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/deployments/{deployment_id}/pipelines/: + get: + operationId: v1_catalog_deployments_pipelines_list + parameters: + - in: query + name: action + schema: + type: string + enum: + - apply + - destroy + - notify + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: pipeline_id + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-pipelines by action, id, pipeline_id, url + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentPipelineList' + examples: + DeploymentPipelineResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - action: apply + created: '2024-04-01T06:14:32.602Z' + deployment: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + id: 4b9fab90-b441-4896-bb1f-c765fd846307 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124134 + url: https://gitlab.com/my-project/-/pipelines/5316124134 + summary: DeploymentPipeline Response + description: '' + post: + operationId: v1_catalog_deployments_pipelines_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + examples: + DeploymentPipelineRequest: + value: + action: apply + pipeline_id: 5316124134 + url: https://gitlab.com/my-project/-/pipelines/5316124134 + summary: DeploymentPipeline Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipeline' + examples: + DeploymentPipelineResponse: + value: + action: apply + created: '2024-04-01T06:14:32.602Z' + deployment: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + id: 4b9fab90-b441-4896-bb1f-c765fd846307 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124134 + url: https://gitlab.com/my-project/-/pipelines/5316124134 + summary: DeploymentPipeline Response + description: '' + /v1/catalog/deployments/{deployment_id}/services/: + get: + operationId: v1_catalog_deployments_services_list + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-services by id, name, url + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentServiceList' + examples: + DeploymentServiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: deb28859-d04e-4976-88d2-9488d9616bcf + modified: '2024-05-03T17:03:45.380Z' + name: root + url: https://a169edac-202c-46b9-8c61-47191000aca6.nvidialaunchpad.com + summary: DeploymentService Response + description: '' + post: + operationId: v1_catalog_deployments_services_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentService' + examples: + DeploymentServiceRequest: + value: + name: root + url: https://a169edac-202c-46b9-8c61-47191000aca6.nvidialaunchpad.com + summary: DeploymentService Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentService' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentService' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentService' + examples: + DeploymentServiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: deb28859-d04e-4976-88d2-9488d9616bcf + modified: '2024-05-03T17:03:45.380Z' + name: root + url: https://a169edac-202c-46b9-8c61-47191000aca6.nvidialaunchpad.com + summary: DeploymentService Response + description: '' + /v1/catalog/deployments/{deployment_id}/ssh-keys/: + get: + operationId: v1_catalog_deployments_ssh_keys_list + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-keys by name + schema: + type: string + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentKeyList' + examples: + DeploymentKeyResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 597f6c78-6195-4bc7-9db2-f344f71e8b47 + modified: '2024-05-03T17:03:45.380Z' + name: My Key + summary: DeploymentKey Response + description: '' + post: + operationId: v1_catalog_deployments_ssh_keys_create + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentKey' + examples: + DeploymentKeyRequest: + value: + name: My Key + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + summary: DeploymentKey Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentKey' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentKey' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentKey' + examples: + DeploymentKeyResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 597f6c78-6195-4bc7-9db2-f344f71e8b47 + modified: '2024-05-03T17:03:45.380Z' + name: My Key + summary: DeploymentKey Response + description: '' + /v1/catalog/deployments/{deployment_id}/ssh-keys/{id}/: + delete: + operationId: v1_catalog_deployments_ssh_keys_destroy + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/deployments/{deployment_id}/tasks/: + get: + operationId: v1_catalog_deployments_tasks_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: query + name: action + schema: + type: string + enum: + - start_instances + - stop_instances + description: |- + The action the task will perform + + * `start_instances` - Start all instances in the deployment + * `stop_instances` - Stop all instances in the deployment + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for deployment-tasks by action, id, status, status_text + schema: + type: string + - in: query + name: status + schema: + type: string + enum: + - completed + - failed + - pending + - processing + - retrying + description: |- + Current status of the task + + * `completed` - completed + * `failed` - failed + * `pending` - pending + * `processing` - processing + * `retrying` - retrying + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeploymentTaskList' + examples: + DeploymentTaskResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - action: start_instances + created: '2024-04-01T06:14:32.602Z' + id: 1001d637-f16a-4b42-b540-ef58fcfaaef8 + modified: '2024-05-03T17:03:45.380Z' + retries: 0 + status: pending + status_text: '' + summary: DeploymentTask Response + description: '' + post: + operationId: v1_catalog_deployments_tasks_create + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentTask' + examples: + DeploymentTaskRequest: + value: + action: start_instances + summary: DeploymentTask Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentTask' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentTask' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentTask' + examples: + DeploymentTaskResponse: + value: + action: start_instances + created: '2024-04-01T06:14:32.602Z' + id: 1001d637-f16a-4b42-b540-ef58fcfaaef8 + modified: '2024-05-03T17:03:45.380Z' + retries: 0 + status: pending + status_text: '' + summary: DeploymentTask Response + description: '' + /v1/catalog/deployments/{deployment_id}/tasks/{id}/: + get: + operationId: v1_catalog_deployments_tasks_retrieve + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: deployment_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentTask' + examples: + DeploymentTaskResponse: + value: + action: start_instances + created: '2024-04-01T06:14:32.602Z' + id: 1001d637-f16a-4b42-b540-ef58fcfaaef8 + modified: '2024-05-03T17:03:45.380Z' + retries: 0 + status: pending + status_text: '' + summary: DeploymentTask Response + description: '' + /v1/catalog/deployments/{id}/: + get: + operationId: v1_catalog_deployments_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "cluster").' + - in: query + name: expiring + schema: + type: string + description: Include deployments whose expires_at value is within the given + range (inclusive), specified as "today", "tomorrow", or "{start}[,end]". + Start and end times must be in ISO format. + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Deployment' + examples: + SuccessfulResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + put: + operationId: v1_catalog_deployments_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentRequest: + value: + collection_branch: my-branch + experience_branch: main + expires_at: 2026-01-11 16:07:02.677916+00:00 + flightcontrol_release: latest + gc_branch: main + ip_allowlist: + - 192.0.2.1 + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + state: retrying + tags: + sample: test + summary: Deployment Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Response + description: '' + patch: + operationId: v1_catalog_deployments_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentRequest: + value: + collection_branch: my-branch + experience_branch: main + expires_at: 2026-01-11 16:07:02.677916+00:00 + flightcontrol_release: latest + gc_branch: main + ip_allowlist: + - 192.0.2.1 + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + state: retrying + tags: + sample: test + summary: Deployment Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentUpdate' + examples: + DeploymentResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: waiting + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Deployment Response + description: '' + delete: + operationId: v1_catalog_deployments_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this deployment. + required: true + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DocDeploymentDelete' + examples: + SuccessfulDestroyingResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + created: '2024-04-01T06:14:32.602Z' + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + experience_branch: main + expires_at: 2025-12-15 16:07:02.677687+00:00 + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + id: 5330c898-f3e7-4972-bfd0-1d438e3774d7 + ip_allowlist: + - 192.0.2.1 + lifetime: 3 + min_gpu_count: 2 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem_name: NVIDIA + org_name: NVIDIA + overrides: + collection_branch: my-branch + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + pipelines: + - 4b9fab90-b441-4896-bb1f-c765fd846307 + platform: flight_deck + priority: p3 + provider_name: dmz + public_key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBdptDTzJ2cOmdyryG1B7yb1YssiCQs6SWu4HlbZXGE + region: pdx + request_id: TRY-123 + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + sales_created_date: '2025-04-10T15:08:47.381700Z' + sales_id: a6ZYx000001234 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + services: + - ae85193a-2927-4a6e-84dc-f954b9c03f73 + ssh_port: 2222 + ssh_user: nvidia + state: destroying + tags: + sample: test + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Destroying Response + description: '' + '204': + description: No response body + /v1/catalog/deployments/{id}/history/: + get: + operationId: v1_catalog_deployments_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/catalog/deployments/{id}/pipelines/trigger/: + post: + operationId: v1_catalog_deployments_pipelines_trigger_create + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + examples: + DeploymentPipelineTriggerRequest: + value: + action: apply + summary: DeploymentPipelineTrigger Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentPipelineTrigger' + examples: + DeploymentPipelineTriggerResponse: + value: + action: apply + created: '2024-04-01T06:14:32.602Z' + id: 05971347-30d6-410c-aff5-fa3513771d77 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 2101675389 + url: https://gitlab.com/my-project/-/pipelines/2101675389 + summary: DeploymentPipelineTrigger Response + description: '' + /v1/catalog/deployments/bulk/: + patch: + operationId: v1_catalog_deployments_bulk_partial_update + tags: + - catalog/deployments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + examples: + DeploymentBulkUpdateRequest: + value: + collection_branch: my-branch + experience_branch: main + expires_at: 2026-01-11 16:07:02.677916+00:00 + flightcontrol_release: latest + gc_branch: main + ids: + - 5330c898-f3e7-4972-bfd0-1d438e3774d7 + - b29d13e5-5894-4614-af2a-ea3f9be93fc5 + ip_allowlist: + - 192.0.2.1 + org_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + requester_email: jane.doe@nvidia.com + requester_name: Jane Doe + retry_count: 0 + sales_owner_email: john.smith@nvidia.com + sales_owner_name: John Smith + state: retrying + tags: + sample: test + summary: Deployment Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentBulkUpdate' + examples: + DeploymentBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Deployment Bulk Update Response + description: '' + /v1/catalog/deployments/stats/: + get: + operationId: v1_catalog_deployments_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - catalog/deployments + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/catalog/experiences/: + get: + operationId: v1_catalog_experiences_list + parameters: + - in: query + name: assignee + schema: + type: string + - in: query + name: autoapprove + schema: + type: boolean + - in: query + name: autoprovision + schema: + type: boolean + - in: query + name: bootstrap + schema: + type: boolean + - in: query + name: catalog_id + schema: + type: string + - in: query + name: catalog_id_alias + schema: + type: string + - in: query + name: category + schema: + type: array + items: + type: string + enum: + - 3D Design Collaboration and Simulation + - AI + - Clara + - Data Science + - Developer + - Infrastructure Optimization + description: |- + Multiple values may be separated by commas. + + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + explode: false + style: form + - in: query + name: collection_branch + schema: + type: string + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "required_gpus").' + - in: query + name: experience + schema: + type: string + - in: query + name: experience_branch + schema: + type: string + - in: query + name: featured + schema: + type: boolean + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: garage_id + schema: + type: string + - in: query + name: gc_branch + schema: + type: string + - in: query + name: gpu_count + schema: + type: integer + - in: query + name: gpu_os_name + schema: + type: string + - in: query + name: gpu_os_release + schema: + type: string + - in: query + name: gpu_os_version + schema: + type: string + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: node_count + schema: + type: integer + - in: query + name: oem + schema: + type: string + format: uuid + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: persona + schema: + type: string + - in: query + name: pipeline + schema: + type: integer + - in: query + name: platform + schema: + type: string + enum: + - air + - flight_deck + - kvm_bastion + - lp-vmware-platform + - minimal + - openshift + - proxmox + - vsphere + - vsphere7 + - vsphere8 + - vsphere_horizon + description: |- + Base platform that the experience will be provisioned onto + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: published + schema: + type: array + items: + type: string + enum: + - draft + - 'no' + - 'yes' + description: |- + Multiple values may be separated by commas. + + * `draft` - draft + * `no` - no + * `yes` - yes + explode: false + style: form + - in: query + name: requires_gpu + schema: + type: string + description: Only include experiences that require a given GPU ID or model + - in: query + name: runtime + schema: + type: string + format: uuid + - in: query + name: sa_lab + schema: + type: boolean + - name: search + required: false + in: query + description: Search for experiences by assignee, catalog_id, catalog_id_alias, + category, collection_branch, description, experience, experience_branch, + gc_branch, gpu_os_name, gpu_os_release, gpu_os_version, id, oem name, persona, + pipeline, platform, provider name, required_gpus model, runtime name, system_arch, + title, vgpu_profile + schema: + type: string + - in: query + name: system_arch + schema: + type: string + enum: + - amd64 + - arm64 + description: |- + Required CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + - in: query + name: vgpu_profile + schema: + type: string + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedExperienceList' + examples: + ExperienceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + post: + operationId: v1_catalog_experiences_create + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Experience' + multipart/form-data: + schema: + $ref: '#/components/schemas/Experience' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + /v1/catalog/experiences/{experience_id}/notes/: + get: + operationId: v1_catalog_experiences_notes_list + parameters: + - in: query + name: created_by + schema: + type: integer + - in: query + name: experience + schema: + type: string + format: uuid + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: modified_by + schema: + type: integer + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for experience-notes by content + schema: + type: string + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedExperienceNoteList' + examples: + ExperiencetNoteResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + post: + operationId: v1_catalog_experiences_notes_create + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteRequest: + value: + content: Hello world + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + summary: ExperiencetNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExperienceNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExperienceNote' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + /v1/catalog/experiences/{experience_id}/notes/{id}/: + get: + operationId: v1_catalog_experiences_notes_retrieve + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + put: + operationId: v1_catalog_experiences_notes_update + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteRequest: + value: + content: Hello world + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + summary: ExperiencetNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExperienceNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExperienceNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + patch: + operationId: v1_catalog_experiences_notes_partial_update + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteRequest: + value: + content: Hello world + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + summary: ExperiencetNote Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ExperienceNote' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExperienceNote' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceNote' + examples: + ExperiencetNoteResponse: + value: + content: Hello world + created: '2024-04-01T06:14:32.602Z' + created_by: john.smith@nvidia.com + id: de618bfc-17b6-4acd-a089-fbff9c3a8c3e + modified: '2024-05-03T17:03:45.380Z' + modified_by: jane.doe@nvidia.com + summary: ExperiencetNote Response + description: '' + delete: + operationId: v1_catalog_experiences_notes_destroy + parameters: + - in: path + name: experience_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/experiences/{id}/: + get: + operationId: v1_catalog_experiences_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "required_gpus").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + put: + operationId: v1_catalog_experiences_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Experience' + multipart/form-data: + schema: + $ref: '#/components/schemas/Experience' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + patch: + operationId: v1_catalog_experiences_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Experience' + multipart/form-data: + schema: + $ref: '#/components/schemas/Experience' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Experience' + examples: + ExperienceResponse: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + catalog_id: aBY3Z000000xBL4NCO + catalog_id_alias: LP-15 + category: Developer + collection_branch: main + created: '2024-04-01T06:14:32.602Z' + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + inactivity_max: 3 + lifetime: 3 + modified: '2024-05-03T17:03:45.380Z' + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Response + description: '' + delete: + operationId: v1_catalog_experiences_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this experience. + required: true + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/experiences/{id}/history/: + get: + operationId: v1_catalog_experiences_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/catalog/experiences/bulk/: + post: + operationId: v1_catalog_experiences_bulk_create + description: Create experiences in bulk via CSV file upload + tags: + - catalog/experiences + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + csv_file: + type: string + format: binary + writeOnly: true + required: + - csv_file + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceBulk' + description: '' + patch: + operationId: v1_catalog_experiences_bulk_partial_update + tags: + - catalog/experiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceBulkUpdate' + examples: + ExperienceBulkUpdateRequest: + value: + assignee: janedoe + autoapprove: true + autoprovision: true + bootstrap: false + category: Developer + collection_branch: main + description: An NVIDIA LaunchPad Experience + experience: example-exp + experience_branch: origin/main + garage_id: f97ab5af-266c-445f-a19a-9fbee6f7162b + gc_branch: main + gpu_count: 1 + gpu_os: + name: ubuntu + release: jammy + version: '22.04' + ids: + - c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + - 3587f151-b02a-46c7-80a4-ac61db6633ed + inactivity_max: 3 + lifetime: 3 + node_count: 1 + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + persona: developer + pipeline: 5443221 + platform: flight_deck + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + published: 'yes' + required_gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + sa_lab: false + system_arch: amd64 + title: My Experience + vgpu_profile: nvidia_a40-48q + summary: Experience Bulk Update Request + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExperienceBulkUpdate' + examples: + ExperienceBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Experience Bulk Update Response + description: '' + /v1/catalog/experiences/stats/: + get: + operationId: v1_catalog_experiences_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - catalog/experiences + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/catalog/gpu-os-choices/: + get: + operationId: v1_catalog_gpu_os_choices_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for gpuoschoices by id, name, release, version + schema: + type: string + tags: + - catalog/gpu-os-choices + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedGpuOsChoiceList' + examples: + GPUOSChoiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 22 + modified: '2024-05-03T17:03:45.380Z' + name: ubuntu + release: jammy + version: '22.04' + summary: GPU OS Choice Response + description: '' + post: + operationId: v1_catalog_gpu_os_choices_create + tags: + - catalog/gpu-os-choices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GpuOsChoice' + examples: + GPUOSChoiceRequest: + value: + name: ubuntu + release: jammy + version: '22.04' + summary: GPU OS Choice Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GpuOsChoice' + multipart/form-data: + schema: + $ref: '#/components/schemas/GpuOsChoice' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/GpuOsChoice' + examples: + GPUOSChoiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 22 + modified: '2024-05-03T17:03:45.380Z' + name: ubuntu + release: jammy + version: '22.04' + summary: GPU OS Choice Response + description: '' + /v1/catalog/instance-types/: + get: + operationId: v1_catalog_instance_types_list + parameters: + - in: query + name: delivery + schema: + type: string + enum: + - fast + - slow + description: Limit results to instance types that can meet the given delivery + timelines. + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/instance-types + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInstanceTypeList' + examples: + InstanceTypeResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - capacity: + us-tx-1: 10 + cloud: oci + cpu: 16 + gpu: + count: 1 + family: A100 + interconnection_type: SXM + manufacturer: NVIDIA + memory_gb: 80 + model: A100-80GB + memory_gb: 120 + price: + currency: USD + on_demand_per_hour: 2.5 + regions: + - us-tx-1 + storage: + - size_gb: 1024 + type: ssd + - size_gb: 2048 + type: ssd + system_arch: amd64 + workshop_id: January training + summary: Instance Type Response + description: '' + /v1/catalog/persona-choices/: + get: + operationId: v1_catalog_persona_choices_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for personachoices by id, name + schema: + type: string + tags: + - catalog/persona-choices + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPersonaChoiceList' + examples: + PersonaChoiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: developer + summary: Persona Choice Response + description: '' + post: + operationId: v1_catalog_persona_choices_create + tags: + - catalog/persona-choices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PersonaChoice' + examples: + PersonaChoiceRequest: + value: + name: developer + summary: Persona Choice Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PersonaChoice' + multipart/form-data: + schema: + $ref: '#/components/schemas/PersonaChoice' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PersonaChoice' + examples: + PersonaChoiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: developer + summary: Persona Choice Response + description: '' + /v1/catalog/runtimes/: + get: + operationId: v1_catalog_runtimes_list + parameters: + - in: query + name: branch + schema: + type: string + - in: query + name: cns_addon_pack + schema: + type: boolean + - in: query + name: cns_docker + schema: + type: boolean + - in: query + name: cns_driver_version + schema: + type: string + - in: query + name: cns_k8s + schema: + type: boolean + - in: query + name: cns_nvidia_driver + schema: + type: boolean + - in: query + name: cns_version + schema: + type: string + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: mig + schema: + type: boolean + - in: query + name: mig_profile + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for runtimes by branch, cns_driver_version, cns_version, + mig_profile, id, name, url + schema: + type: string + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRuntimeList' + examples: + RuntimeResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + post: + operationId: v1_catalog_runtimes_create + tags: + - catalog/runtimes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeRequest: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + mig: true + mig_profile: all-2g.20gb + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Runtime' + multipart/form-data: + schema: + $ref: '#/components/schemas/Runtime' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + /v1/catalog/runtimes/{id}/: + get: + operationId: v1_catalog_runtimes_retrieve + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + put: + operationId: v1_catalog_runtimes_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + tags: + - catalog/runtimes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeRequest: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + mig: true + mig_profile: all-2g.20gb + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Runtime' + multipart/form-data: + schema: + $ref: '#/components/schemas/Runtime' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + patch: + operationId: v1_catalog_runtimes_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + tags: + - catalog/runtimes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeRequest: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + mig: true + mig_profile: all-2g.20gb + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Runtime' + multipart/form-data: + schema: + $ref: '#/components/schemas/Runtime' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Runtime' + examples: + RuntimeResponse: + value: + branch: main + cns_addon_pack: false + cns_docker: true + cns_driver_version: 580.65.06 + cns_k8s: true + cns_nvidia_driver: true + cns_version: '16.0' + created: '2024-04-01T06:14:32.602Z' + id: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + mig: true + mig_profile: all-2g.20gb + modified: '2024-05-03T17:03:45.380Z' + name: CNS with Docker and Kubernetes + url: https://gitlab.com/my-project/platform-cns-docker.git + summary: Runtime Response + description: '' + delete: + operationId: v1_catalog_runtimes_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this runtime. + required: true + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/catalog/runtimes/{id}/history/: + get: + operationId: v1_catalog_runtimes_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - catalog/runtimes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/catalog/vgpu-profile-choices/: + get: + operationId: v1_catalog_vgpu_profile_choices_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for vgpuprofilechoices by id, name + schema: + type: string + tags: + - catalog/vgpu-profile-choices + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVGpuProfileChoiceList' + examples: + VGPUProfileChoiceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: flight_deck + summary: vGPU Profile Choice Response + description: '' + post: + operationId: v1_catalog_vgpu_profile_choices_create + tags: + - catalog/vgpu-profile-choices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + examples: + VGPUProfileChoiceRequest: + value: + name: flight_deck + summary: vGPU Profile Choice Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + multipart/form-data: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VGpuProfileChoice' + examples: + VGPUProfileChoiceResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 15 + modified: '2024-05-03T17:03:45.380Z' + name: flight_deck + summary: vGPU Profile Choice Response + description: '' + /v1/identity/profile/: + get: + operationId: v1_identity_profile_retrieve + tags: + - identity/profile + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Profile' + examples: + ProfileResponse: + value: + created: '2024-10-01T07:24:42.702Z' + display_name: John Doe + groups: + - Reporters + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + modified: '2024-11-03T18:04:55.480Z' + preferred_theme: dark + preferred_view_settings: + view_name: + ordering: -column_name + page_size: 50 + username: jdoe@nvidia.com + summary: Profile Response + description: '' + patch: + operationId: v1_identity_profile_partial_update + tags: + - identity/profile + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Profile' + examples: + ProfileRequest: + value: + preferred_theme: dark + preferred_view_settings: + view_name: + ordering: -column_name + page_size: 50 + summary: Profile Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Profile' + multipart/form-data: + schema: + $ref: '#/components/schemas/Profile' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Profile' + examples: + ProfileResponse: + value: + created: '2024-10-01T07:24:42.702Z' + display_name: John Doe + groups: + - Reporters + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + modified: '2024-11-03T18:04:55.480Z' + preferred_theme: dark + preferred_view_settings: + view_name: + ordering: -column_name + page_size: 50 + username: jdoe@nvidia.com + summary: Profile Response + description: '' + /v1/inventory/clusters/: + get: + operationId: v1_inventory_clusters_list + parameters: + - in: query + name: available + schema: + type: boolean + description: Is the cluster currently available for provisioning? + - in: query + name: bastion_name + schema: + type: string + - in: query + name: deployment + schema: + type: string + format: uuid + - in: query + name: enabled + schema: + type: boolean + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate + nested relationships with a period (ex: "nodes.location"). Separate multiple + fields with a comma (ex: "gpus,nodes")' + - in: query + name: experience + schema: + type: string + format: uuid + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: garage_id + schema: + type: string + description: Only include clusters whose nodes have the given garage ID + - in: query + name: gpu + schema: + type: array + items: + type: string + format: uuid + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: gpu_alias + schema: + type: string + description: Alias for GPU plan (i.e. installed GPU type and count) + - in: query + name: gpu_count + schema: + type: number + description: Only include clusters with a physical GPU count equal to this + value + - in: query + name: gpu_model + schema: + type: string + description: Only include clusters with the given GPU model name + - in: query + name: has_deployment + schema: + type: boolean + - in: query + name: has_request_id + schema: + type: boolean + - in: query + name: has_workshop_id + schema: + type: boolean + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: location + schema: + type: string + format: uuid + - in: query + name: location_name + schema: + type: string + description: Only include clusters whose nodes are in the location with the + given name + - in: query + name: location_region + schema: + type: string + description: Only include clusters whose nodes are in the location in the + given region + - in: query + name: maintenance + schema: + type: boolean + - in: query + name: mgmt_ip + schema: + type: string + - in: query + name: mgmt_mac + schema: + type: string + - in: query + name: min_gpu_count + schema: + type: number + description: Only include clusters that have a gpu_count greater than or equal + to this value + - in: query + name: min_node_count + schema: + type: number + description: Only include clusters that have a node_count greater than or + equal to this value + - in: query + name: min_provisioning_attempts + schema: + type: integer + description: Only include clusters that have a provisioning_attempts value + greater than or equal to this value + - in: query + name: min_tenant_count + schema: + type: number + description: Only include clusters whose number of tenant_ids is greater than + or equal to this value + - in: query + name: netmask + schema: + type: integer + - in: query + name: node_count + schema: + type: number + description: Only include clusters with a node count equal to this value + - in: query + name: oem + schema: + type: string + format: uuid + description: Only include clusters with nodes that have the given OEM ID + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: persist + schema: + type: boolean + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: provider_capacity + schema: + type: boolean + - in: query + name: provider_name + schema: + type: string + description: Only include clusters whose nodes are from the provider with + the given name + - in: query + name: provider_node_id + schema: + type: string + format: uuid + - in: query + name: provision_user + schema: + type: string + - in: query + name: provisioning_attempts + schema: + type: integer + - in: query + name: provisioning_state + schema: + type: array + items: + type: string + enum: + - deployed + - deploying + - destroying + - pending + - ready + - reserved + - unprovisioned + description: |- + Multiple values may be separated by commas. + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + explode: false + style: form + - in: query + name: provisioning_state_not + schema: + type: array + items: + type: string + enum: + - deployed + - deploying + - destroying + - pending + - ready + - reserved + - unprovisioned + description: |- + Multiple values may be separated by commas. + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + explode: false + style: form + - in: query + name: public_address + schema: + type: string + - in: query + name: rack + schema: + type: string + description: Only include clusters whose nodes are in the given rack + - in: query + name: request_id + schema: + type: string + - in: query + name: reservation + schema: + type: boolean + - name: search + required: false + in: query + description: Search for clusters by bastion_name, experience id, gpu_alias, + gpus model, id, mgmt_ip, mgmt_mac, netmask, nodes garage_id, nodes location + name, nodes location provider name, nodes oem name, nodes provider_node_id, + nodes rack, notes, provision_user, provisioning_state, public_address, request_id, + tenant_ids, workshop_id + schema: + type: string + - in: query + name: system_arch + schema: + type: string + description: Only include clusters whose nodes have the given CPU architecture + - in: query + name: vlan_id + schema: + type: integer + - in: query + name: workshop + schema: + type: boolean + - in: query + name: workshop_id + schema: + type: string + - in: query + name: workshop_id_not + schema: + type: string + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedClusterList' + examples: + ClusterResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + post: + operationId: v1_inventory_clusters_create + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Cluster' + multipart/form-data: + schema: + $ref: '#/components/schemas/Cluster' + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + /v1/inventory/clusters/{cluster_id}/pipelines/: + get: + operationId: v1_inventory_clusters_pipelines_list + parameters: + - in: query + name: action + schema: + type: string + enum: + - apply + - destroy + - notify + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + - in: path + name: cluster_id + schema: + type: string + format: uuid + required: true + - in: query + name: id + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: pipeline_id + schema: + type: integer + - in: query + name: request_id + schema: + type: string + - name: search + required: false + in: query + description: Search for cluster-pipelines by action, id, pipeline_id, request_id, + url + schema: + type: string + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedClusterPipelineList' + examples: + ClusterPipelineResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - action: apply + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 6d736f2c-d6b8-4e44-86a0-e6e2b7b9eaf4 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124135 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/5316124135 + summary: ClusterPipeline Response + description: '' + /v1/inventory/clusters/{cluster_id}/tenants/: + post: + operationId: v1_inventory_clusters_tenants_create + parameters: + - in: path + name: cluster_id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Tenant' + multipart/form-data: + schema: + $ref: '#/components/schemas/Tenant' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + /v1/inventory/clusters/{cluster_id}/tenants/{id}/: + delete: + operationId: v1_inventory_clusters_tenants_destroy + parameters: + - in: path + name: cluster_id + schema: + type: string + format: uuid + required: true + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/clusters/{id}/: + get: + operationId: v1_inventory_clusters_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate + nested relationships with a period (ex: "nodes.location"). Separate multiple + fields with a comma (ex: "gpus,nodes")' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + put: + operationId: v1_inventory_clusters_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Cluster' + multipart/form-data: + schema: + $ref: '#/components/schemas/Cluster' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + patch: + operationId: v1_inventory_clusters_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Cluster' + multipart/form-data: + schema: + $ref: '#/components/schemas/Cluster' + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + delete: + operationId: v1_inventory_clusters_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this cluster. + required: true + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/clusters/{id}/history/: + get: + operationId: v1_inventory_clusters_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/clusters/{id}/pipelines/trigger/: + post: + operationId: v1_inventory_clusters_pipelines_trigger_create + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + examples: + ClusterPipelineTriggerRequest: + value: + action: apply + summary: ClusterPipelineTrigger Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + multipart/form-data: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterPipelineTrigger' + examples: + ClusterPipelineTriggerResponse: + value: + action: apply + created: '2024-04-01T06:14:32.602Z' + id: 84d750af-fa43-4ff1-9198-39535584f83e + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 2101675388 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/2101675388 + summary: ClusterPipelineTrigger Response + description: '' + /v1/inventory/clusters/{id}/provision/: + patch: + operationId: v1_inventory_clusters_provision_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + examples: + ProvisioningRequest(CatalogIDAlias): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id_alias: LP-15 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID Alias) + ProvisioningRequest(ExperienceID): + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Experience ID) + ProvisioningRequest(CatalogID): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id: aBY3Z000000xBL4NCO + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID) + ProvisioningRequest(MinimumRequiredFields): + value: + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogID): + value: + catalog_id: aBY3Z000000xBL4NCO + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog + ID) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogIDAlias): + value: + catalog_id_alias: LP-15 + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog + ID Alias) + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + examples: + SuccessfulResponse: + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Successful Response + description: '' + delete: + operationId: v1_inventory_clusters_provision_destroy + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "cluster,experience").' + - in: path + name: id + schema: + type: string + format: uuid + required: true + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + examples: + ClusterResponse: + value: + available: true + bastion_name: jovial_bastion + created: '2024-04-01T06:14:32.602Z' + deployment: null + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + free_by: '2024-06-13T02:22:06.611Z' + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpus: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + id: 089324a5-708c-4386-9fdc-92dd9aa63d2b + last_provisioning_state_change: '2024-05-03T17:03:45.380Z' + last_used: '2024-05-03T15:04:44.410Z' + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + modified: '2024-05-03T17:03:45.380Z' + netmask: 24 + node_count: 1 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provider_capacity: true + provision_user: nvidia + provisioning_attempts: 1 + provisioning_config: de02399f-ca10-4095-b559-85d87362adb4 + provisioning_request: 91471375-dcfa-46ed-9fb7-57509a44aeec + provisioning_state: pending + public_address: 203.0.113.1 + request_id: TRY-1234 + reservation: false + tenant_ids: + - faf0669c-eec2-47a4-a881-5c568be65597 + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Response + description: '' + /v1/inventory/clusters/bulk/: + patch: + operationId: v1_inventory_clusters_bulk_partial_update + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + examples: + ClusterBulkUpdateRequest: + value: + bastion_name: jovial_bastion + enabled: true + experience: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + ids: + - 089324a5-708c-4386-9fdc-92dd9aa63d2b + - 3587f151-b02a-46c7-80a4-ac61db6633ed + maintenance: false + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + netmask: 24 + nodes: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + persist: false + provision_user: nvidia + provisioning_attempts: 1 + provisioning_state: pending + reservation: false + vlan_id: 1 + workshop: false + workshop_id: January training + summary: Cluster Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterBulkUpdate' + examples: + ClusterBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Cluster Bulk Update Response + description: '' + /v1/inventory/clusters/provision/: + post: + operationId: v1_inventory_clusters_provision_create + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "cluster,experience").' + tags: + - inventory/clusters + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + examples: + ProvisioningRequest(CatalogIDAlias): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id_alias: LP-15 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID Alias) + ProvisioningRequest(ExperienceID): + value: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Experience ID) + ProvisioningRequest(CatalogID): + value: + bastion_operating_system: ubuntu_22_04 + catalog_id: aBY3Z000000xBL4NCO + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: jammy + gpu_os_version: '22.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + runtime_url: https://gitlab.com/my-project/platform-cns-docker.git + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: Provisioning Request (Catalog ID) + ProvisioningRequest(MinimumRequiredFields): + value: + experience_id: c4b62bd4-6c4b-41f2-b4ec-5ad392f6afc + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogID): + value: + catalog_id: aBY3Z000000xBL4NCO + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog + ID) + ProvisioningRequest(MinimumRequiredFieldsW/CatalogIDAlias): + value: + catalog_id_alias: LP-15 + request_id: TRY-123 + summary: Provisioning Request (Minimum Required Fields w/ Catalog + ID Alias) + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProvisioningRequest' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterProvisionCreateResponse' + examples: + ClusterProvisionResponse: + value: + pipeline: + action: apply + created: '2024-04-01T06:14:32.602Z' + id: 6d736f2c-d6b8-4e44-86a0-e6e2b7b9eaf4 + modified: '2024-05-03T17:03:45.380Z' + pipeline_id: 5316124135 + request_id: TRY-1234 + url: https://gitlab.com/my-project/-/pipelines/5316124135 + provisioning_config: + bastion_operating_system: ubuntu_22_04 + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + collection_branch: my-branch + experience_branch: main + flightcontrol_release: latest + garage_id: f15b539b-8b64-46e8-95e3-c70f2f36aabd + gc_branch: main + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 4 + gpu_model: l40s + gpu_os_name: ubuntu + gpu_os_release: noble + gpu_os_version: '24.04' + min_gpu_count: 2 + node_count: 1 + oem_name: NVIDIA + persist_on_failure: false + persona: developer + pipeline: 5443221 + pipeline_branch: main + platform: flight_deck + provider_name: dmz + region: pdx + request_id: TRY-123 + runtime: 4e76b464-e3e4-4ed9-ba1d-ee14c5cf40a0 + runtime_branch: main + runtime_cns_addon_pack: false + runtime_cns_docker: true + runtime_cns_driver_version: 580.65.06 + runtime_cns_k8s: true + runtime_cns_nvidia_driver: true + runtime_cns_version: '16.0' + runtime_mig: true + runtime_mig_profile: all-2g.20gb + workshop: false + workshop_id: January training + workshop_override_password: nvidia + summary: ClusterProvision Response + description: '' + /v1/inventory/clusters/stats/: + get: + operationId: v1_inventory_clusters_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/clusters + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/inventory/gpus/: + get: + operationId: v1_inventory_gpus_list + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: form_factor + schema: + type: string + enum: + - pcie + - sxm + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: model + schema: + type: array + items: + type: string + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: priority + schema: + type: integer + - name: search + required: false + in: query + description: Search for gpus by form_factor, id, memory, model + schema: + type: string + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedGpuList' + examples: + GPUResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + post: + operationId: v1_inventory_gpus_create + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPURequest: + value: + form_factor: pcie + memory: 48 + model: l40s + priority: 60 + summary: GPU Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Gpu' + multipart/form-data: + schema: + $ref: '#/components/schemas/Gpu' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + /v1/inventory/gpus/{id}/: + get: + operationId: v1_inventory_gpus_retrieve + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + put: + operationId: v1_inventory_gpus_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPURequest: + value: + form_factor: pcie + memory: 48 + model: l40s + priority: 60 + summary: GPU Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Gpu' + multipart/form-data: + schema: + $ref: '#/components/schemas/Gpu' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + patch: + operationId: v1_inventory_gpus_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPURequest: + value: + form_factor: pcie + memory: 48 + model: l40s + priority: 60 + summary: GPU Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Gpu' + multipart/form-data: + schema: + $ref: '#/components/schemas/Gpu' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Gpu' + examples: + GPUResponse: + value: + created: '2024-04-01T06:14:32.602Z' + form_factor: pcie + id: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + memory: 48 + model: l40s + modified: '2024-05-03T17:03:45.380Z' + node_count: 22 + priority: 60 + summary: GPU Response + description: '' + delete: + operationId: v1_inventory_gpus_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this gpu. + required: true + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/gpus/{id}/history/: + get: + operationId: v1_inventory_gpus_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/gpus/bulk/: + patch: + operationId: v1_inventory_gpus_bulk_partial_update + tags: + - inventory/gpus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + examples: + GPUBulkUpdateRequest: + value: + form_factor: pcie + ids: + - c77f399a-8f69-4a07-b1f5-e35f8654cdfc + - d63c8b0d-acb9-4c87-b4f7-656ecea5b02a + memory: 48 + priority: 60 + summary: GPU Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GpuBulkUpdate' + examples: + GPUBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: GPU Bulk Update Response + description: '' + /v1/inventory/gpus/stats/: + get: + operationId: v1_inventory_gpus_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/gpus + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /v1/inventory/instances/: + get: + operationId: v1_inventory_instances_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: query + name: cluster + schema: + type: string + format: uuid + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "cluster").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: instance_id + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for instances by cluster, id, instance_id, name, state, + tags + schema: + type: string + - in: query + name: state + schema: + type: string + enum: + - running + - starting + - stopped + - stopping + - unknown + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInstanceList' + examples: + InstanceResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + post: + operationId: v1_inventory_instances_create + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + instance_id: instance-934ea164 + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Instance' + multipart/form-data: + schema: + $ref: '#/components/schemas/Instance' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + /v1/inventory/instances/{id}/: + get: + operationId: v1_inventory_instances_retrieve + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "cluster").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + put: + operationId: v1_inventory_instances_update + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + instance_id: instance-934ea164 + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Instance' + multipart/form-data: + schema: + $ref: '#/components/schemas/Instance' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + patch: + operationId: v1_inventory_instances_partial_update + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + instance_id: instance-934ea164 + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Instance' + multipart/form-data: + schema: + $ref: '#/components/schemas/Instance' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + examples: + InstanceResponse: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + created: '2024-04-01T06:14:32.602Z' + id: 899d8680-454a-41f3-af99-9e0497ac955d + instance_id: instance-934ea164 + modified: '2024-05-03T17:03:45.380Z' + name: My GPU Cluster + state: running + state_modified: '2024-05-03T17:03:45.380Z' + tags: + - gpu + summary: Instance Response + description: '' + delete: + operationId: v1_inventory_instances_destroy + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this instance. + required: true + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/instances/{id}/history/: + get: + operationId: v1_inventory_instances_history_list + summary: "\U0001F6A7 [Beta Feature]" + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/instances + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/instances/bulk/: + patch: + operationId: v1_inventory_instances_bulk_partial_update + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/instances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + examples: + InstanceBulkUpdateRequest: + value: + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + ids: + - 899d8680-454a-41f3-af99-9e0497ac955d + - 3280c16f-0e3e-4897-b8ba-7f66d40281bf + name: My GPU Cluster + state: running + tags: + - gpu + summary: Instance Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceBulkUpdate' + examples: + InstanceBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Instance Bulk Update Response + description: '' + /v1/inventory/locations/: + get: + operationId: v1_inventory_locations_list + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "provider").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: region + schema: + type: string + - name: search + required: false + in: query + description: Search for locations by id, name, provider name, region + schema: + type: string + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedLocationList' + examples: + LocationResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + post: + operationId: v1_inventory_locations_create + tags: + - inventory/locations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationRequest: + value: + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Location' + multipart/form-data: + schema: + $ref: '#/components/schemas/Location' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + /v1/inventory/locations/{id}/: + get: + operationId: v1_inventory_locations_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID (ex: + "provider").' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + put: + operationId: v1_inventory_locations_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + tags: + - inventory/locations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationRequest: + value: + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Location' + multipart/form-data: + schema: + $ref: '#/components/schemas/Location' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + patch: + operationId: v1_inventory_locations_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + tags: + - inventory/locations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationRequest: + value: + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Location' + multipart/form-data: + schema: + $ref: '#/components/schemas/Location' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + examples: + LocationResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: c325baef-d37f-4aca-a933-e35d68c0ce2b + modified: '2024-05-03T17:03:45.380Z' + name: Raleigh + provider: f8bd1b72-c213-43ec-82ad-a56a44757a11 + region: East + summary: Location Response + description: '' + delete: + operationId: v1_inventory_locations_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this location. + required: true + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/locations/{id}/history/: + get: + operationId: v1_inventory_locations_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/locations + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/nodes/: + get: + operationId: v1_inventory_nodes_list + parameters: + - in: query + name: bmc_ip + schema: + type: string + - in: query + name: bmc_mac + schema: + type: string + - in: query + name: cluster + schema: + type: string + format: uuid + - in: query + name: cpu + schema: + type: integer + - in: query + name: cpu_manufacturer + schema: + type: + - string + - 'null' + enum: + - amd + - arm + - intel + description: |- + Manufacturer of the node's CPU + + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + - in: query + name: cpu_model + schema: + type: string + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate + nested relationships with a period (ex: "location.provider"). Separate multiple + fields with a comma (ex: "location,oem")' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: garage_id + schema: + type: string + - in: query + name: gpu + schema: + type: array + items: + type: string + format: uuid + description: Multiple values may be separated by commas. + explode: false + style: form + - in: query + name: gpu_alias + schema: + type: string + description: Alias for GPU plan (i.e. installed GPU type and count) + - in: query + name: gpu_count + schema: + type: integer + - in: query + name: gpu_model + schema: + type: string + description: Model of GPU(s) installed + - in: query + name: gpu_vbios + schema: + type: string + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: location + schema: + type: string + format: uuid + - in: query + name: memory + schema: + type: integer + - in: query + name: mgmt_ip + schema: + type: string + - in: query + name: mgmt_mac + schema: + type: string + - in: query + name: min_gpu_count + schema: + type: integer + description: Only include nodes that have a gpu_count greater than or equal + to this value + - in: query + name: model + schema: + type: string + - in: query + name: network_type + schema: + type: string + enum: + - ethernet + - infiniband + description: |- + Type of networking technology used + + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + - in: query + name: oem + schema: + type: string + format: uuid + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: provider + schema: + type: string + format: uuid + - in: query + name: provider_node_id + schema: + type: string + - in: query + name: rack + schema: + type: string + - in: query + name: rack_unit + schema: + type: integer + - name: search + required: false + in: query + description: Search for nodes by bmc_ip, bmc_mac, cpu_manufacturer, cpu_model, + garage_id, gpu_alias, gpu model, gpu_vbios, id, location name, location + provider name, memory, mgmt_ip, mgmt_mac, model, network_type, nic_prefixes, + notes, oem name, provider_node_id, rack, rack_unit, serial_number, storage, + system_arch + schema: + type: string + - in: query + name: serial_number + schema: + type: string + - in: query + name: system_arch + schema: + type: string + enum: + - amd64 + - arm64 + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + - in: query + name: tee + schema: + type: boolean + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeList' + examples: + NodeResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + post: + operationId: v1_inventory_nodes_create + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + /v1/inventory/nodes/{id}/: + get: + operationId: v1_inventory_nodes_retrieve + parameters: + - in: query + name: expand + schema: + type: string + description: 'Expand related field(s) instead of only showing a UUID. Separate + nested relationships with a period (ex: "location.provider"). Separate multiple + fields with a comma (ex: "location,oem")' + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + put: + operationId: v1_inventory_nodes_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + patch: + operationId: v1_inventory_nodes_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + examples: + NodeResponse: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + created: '2024-04-01T06:14:32.602Z' + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_alias: nvidia3.l40sx2.medium + gpu_count: 2 + gpu_model: l40s + gpu_vbios: 92.00.81.00.01 + id: d66f5cc1-c861-4c79-8d36-d156e050cb07 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + modified: '2024-05-03T17:03:45.380Z' + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Response + description: '' + delete: + operationId: v1_inventory_nodes_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this node. + required: true + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/nodes/{id}/history/: + get: + operationId: v1_inventory_nodes_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/nodes + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/nodes/bulk/: + post: + operationId: v1_inventory_nodes_bulk_create + description: Create nodes in bulk via CSV file upload + tags: + - inventory/nodes + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + csv_file: + type: string + format: binary + writeOnly: true + required: + - csv_file + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeBulk' + description: '' + patch: + operationId: v1_inventory_nodes_bulk_partial_update + tags: + - inventory/nodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeBulkUpdate' + examples: + NodeBulkUpdateRequest: + value: + bmc_ip: 192.0.2.1 + bmc_mac: 00:53:00:00:00:01 + bmc_password: password + bmc_user: username + cluster: 089324a5-708c-4386-9fdc-92dd9aa63d2b + cpu: 1 + cpu_manufacturer: amd + cpu_model: EPYC 7571 + gpu: c77f399a-8f69-4a07-b1f5-e35f8654cdfc + gpu_count: 2 + gpu_vbios: 92.00.81.00.01 + ids: + - d66f5cc1-c861-4c79-8d36-d156e050cb07 + - 6fcf07f8-d821-48cf-b20e-b6eb65db9387 + location: c325baef-d37f-4aca-a933-e35d68c0ce2b + memory: 256 + mgmt_ip: 172.16.0.11 + mgmt_mac: 00:53:FF:00:00:01 + model: DGX H100 + network_type: ethernet + nic_prefixes: + - enp43 + - enp44 + notes: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + oem: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + rack: j01 + rack_unit: 8 + serial_number: S1234567890 + storage: + - size: 56000 + type: nvme + system_arch: amd64 + tee: false + summary: Node Bulk Update Request + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeBulkUpdate' + examples: + NodeBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Node Bulk Update Response + description: '' + /v1/inventory/oems/: + get: + operationId: v1_inventory_oems_list + parameters: + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: search + required: false + in: query + description: Search for oems by id, name + schema: + type: string + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedOEMList' + examples: + OEMResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + post: + operationId: v1_inventory_oems_create + tags: + - inventory/oems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMRequest: + value: + name: My OEM + summary: OEM Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/OEM' + multipart/form-data: + schema: + $ref: '#/components/schemas/OEM' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + /v1/inventory/oems/{id}/: + get: + operationId: v1_inventory_oems_retrieve + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + put: + operationId: v1_inventory_oems_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMRequest: + value: + name: My OEM + summary: OEM Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/OEM' + multipart/form-data: + schema: + $ref: '#/components/schemas/OEM' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + patch: + operationId: v1_inventory_oems_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMRequest: + value: + name: My OEM + summary: OEM Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/OEM' + multipart/form-data: + schema: + $ref: '#/components/schemas/OEM' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OEM' + examples: + OEMResponse: + value: + created: '2024-04-01T06:14:32.602Z' + id: 45ca2da7-2582-4b7f-91c1-c6c5ccc84a7e + modified: '2024-05-03T17:03:45.380Z' + name: My OEM + summary: OEM Response + description: '' + delete: + operationId: v1_inventory_oems_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this oem. + required: true + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/oems/{id}/history/: + get: + operationId: v1_inventory_oems_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/oems + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/providers/: + get: + operationId: v1_inventory_providers_list + parameters: + - in: query + name: display_name + schema: + type: string + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: query + name: id + schema: + type: string + format: uuid + - in: query + name: instance_limit + schema: + type: integer + - in: query + name: name + schema: + type: string + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + - in: query + name: on_demand_speed + schema: + type: string + enum: + - fast + - slow + description: |- + Speed of on-demand inventory provisioning + + * `fast` - fast + * `slow` - slow + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: priority + schema: + type: integer + - name: search + required: false + in: query + description: Search for providers by display_name, id, name, on_demand_speed + schema: + type: string + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedProviderList' + examples: + ProviderResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + post: + operationId: v1_inventory_providers_create + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderRequest: + value: + display_name: My Provider + instance_limit: 250 + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Provider' + multipart/form-data: + schema: + $ref: '#/components/schemas/Provider' + required: true + security: + - TokenAuthentication: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + /v1/inventory/providers/{id}/: + get: + operationId: v1_inventory_providers_retrieve + parameters: + - in: query + name: fields + schema: + type: string + description: Include only the specified fields in the response + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + - in: query + name: omit + schema: + type: string + description: Exclude the specified fields in the response + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + put: + operationId: v1_inventory_providers_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderRequest: + value: + display_name: My Provider + instance_limit: 250 + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Provider' + multipart/form-data: + schema: + $ref: '#/components/schemas/Provider' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + patch: + operationId: v1_inventory_providers_partial_update + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderRequest: + value: + display_name: My Provider + instance_limit: 250 + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Provider' + multipart/form-data: + schema: + $ref: '#/components/schemas/Provider' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + examples: + ProviderResponse: + value: + created: '2024-04-01T06:14:32.602Z' + display_name: My Provider + id: f8bd1b72-c213-43ec-82ad-a56a44757a11 + instance_limit: 250 + modified: '2024-05-03T17:03:45.380Z' + name: my_provider + on_demand_speed: slow + priority: 50 + summary: Provider Response + description: '' + delete: + operationId: v1_inventory_providers_destroy + parameters: + - in: path + name: id + schema: + type: string + format: uuid + description: A UUID string identifying this provider. + required: true + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '204': + description: No response body + /v1/inventory/providers/{id}/history/: + get: + operationId: v1_inventory_providers_history_list + parameters: + - in: path + name: id + schema: + type: string + format: uuid + required: true + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModelChangeList' + examples: + SuccessfulResponse: + value: + count: 123 + next: https://launchpad.api.nvidia.com/example/?page=4 + previous: https://launchpad.api.nvidia.com/example/?page=2 + results: + - change_type: changed + changes: + - field: notes + new_value: Sample note + old_value: null + created: '2025-01-29T13:20:39.821Z' + id: 123 + username: jane.doe@nvidia.com + summary: Successful Response + description: '' + /v1/inventory/providers/bulk/: + patch: + operationId: v1_inventory_providers_bulk_partial_update + tags: + - inventory/providers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + examples: + ProviderBulkUpdateRequest: + value: + display_name: My Provider + ids: + - f8bd1b72-c213-43ec-82ad-a56a44757a11 + - 5b528083-ab61-42dd-a6a1-90aa9babb014 + instance_limit: 250 + on_demand_speed: slow + priority: 50 + summary: Provider Bulk Update Request + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + required: true + security: + - TokenAuthentication: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderBulkUpdate' + examples: + ProviderBulkUpdateResponse: + value: + count: 2 + result: Records updated successfully + summary: Provider Bulk Update Response + description: '' + /v1/inventory/providers/stats/: + get: + operationId: v1_inventory_providers_stats_retrieve + summary: "\U0001F6A7 [Beta Feature]" + tags: + - inventory/providers + security: + - TokenAuthentication: [] + responses: + '200': + description: No response body + /version/: + get: + operationId: version_retrieve + tags: + - version + security: + - TokenAuthentication: [] + - {} + responses: + '200': + content: + application/json: + schema: + type: object + properties: + application_version: + type: string + examples: + ExampleResponse: + value: + application_version: 1.0.0 + summary: Example Response + description: '' +components: + schemas: + AuthLogin: + type: object + properties: + auth_code: + type: string + password: + type: string + username: + type: string + AuthRedirect: + type: object + properties: + redirect: + type: string + format: uri + required: + - redirect + AuthToken: + type: object + properties: + token: + type: string + readOnly: true + username: + type: string + readOnly: true + required: + - token + - username + BlankEnum: + enum: + - '' + CategoryEnum: + enum: + - AI + - Clara + - Data Science + - 3D Design Collaboration and Simulation + - Developer + - Infrastructure Optimization + type: string + description: |- + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + Cluster: + type: object + properties: + available: + type: boolean + readOnly: true + description: Is the cluster currently available for provisioning? + bastion_name: + type: + - string + - 'null' + description: Name of the bastion assigned to the cluster + maxLength: 32 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + type: string + format: uuid + readOnly: true + enabled: + type: boolean + description: Is the cluster administratively enabled? + experience: + type: + - string + - 'null' + format: uuid + description: Experience provisioned onto this cluster + free_by: + type: + - string + - 'null' + format: date-time + gpus: + type: array + items: + type: string + format: uuid + readOnly: true + gpu_alias: + type: string + readOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + readOnly: true + id: + type: string + format: uuid + readOnly: true + instances: + type: array + items: + type: string + format: uuid + readOnly: true + last_provisioning_state_change: + type: + - string + - 'null' + format: date-time + readOnly: true + description: Timestamp of the last time the cluster's provisioning_state + changed + last_used: + type: + - string + - 'null' + format: date-time + readOnly: true + description: Timestamp of when the cluster was last in use + maintenance: + type: boolean + description: Is the cluster in maintenance mode? + mgmt_ip: + type: string + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + description: Management MAC address + maxLength: 17 + minLength: 17 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + netmask: + type: + - integer + - 'null' + maximum: 32 + minimum: 0 + description: The subnet mask of the cluster's public IP address in CIDR + notation + node_count: + type: integer + readOnly: true + nodes: + type: array + items: + type: string + format: uuid + notes: + type: + - string + - 'null' + description: Administrative comments about the cluster + persist: + type: boolean + description: Is the cluster exempt from provisioning_state timeouts? Can + be used to ensure the cluster persists after a provisioning failure. + provider_capacity: + type: boolean + readOnly: true + description: Does the provider have capacity to provision this cluster? + provision_user: + type: + - string + - 'null' + description: Username used for provisioning this cluster + maxLength: 64 + provisioning_attempts: + type: integer + maximum: 2147483647 + minimum: 0 + description: The number of attempts that have been made to provision this + cluster. Automatically resets to 0 after successful provisioning. + provisioning_config: + type: + - string + - 'null' + format: uuid + description: Applied provisioning configuration for the cluster + provisioning_request: + type: + - string + - 'null' + format: uuid + description: Requested provisioning configuration for the cluster + provisioning_state: + allOf: + - $ref: '#/components/schemas/ProvisioningStateEnum' + description: |- + Is the cluster currently provisioned? + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + public_address: + type: + - string + - 'null' + description: Public IP address or fully-qualified domain name of this cluster + maxLength: 255 + request_id: + type: + - string + - 'null' + description: 'The request ID for the lab that is currently provisioned on + this cluster (ex: TRY-1234)' + maxLength: 32 + reservation: + type: boolean + description: Is the cluster a static reservation from its provider? + tenant_ids: + type: array + items: + type: string + format: uuid + readOnly: true + description: Tenant UUID(s) that have been generated for this cluster during + provisioning + vlan_id: + type: integer + maximum: 4094 + minimum: 1 + description: VLAN number + workshop: + type: boolean + description: Is the cluster set aside for use in a workshop? + workshop_id: + type: + - string + - 'null' + description: Identifier of the workshop this cluster is set aside for + maxLength: 64 + required: + - available + - created + - deployment + - gpu_alias + - gpu_count + - gpus + - id + - instances + - last_provisioning_state_change + - last_used + - modified + - node_count + - provider_capacity + - tenant_ids + ClusterBulkUpdate: + type: object + properties: + available: + type: boolean + readOnly: true + writeOnly: true + description: Is the cluster currently available for provisioning? + bastion_name: + type: + - string + - 'null' + writeOnly: true + description: Name of the bastion assigned to the cluster + maxLength: 32 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + deployment: + type: string + format: uuid + readOnly: true + writeOnly: true + enabled: + type: boolean + writeOnly: true + description: Is the cluster administratively enabled? + experience: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Experience provisioned onto this cluster + free_by: + type: + - string + - 'null' + format: date-time + writeOnly: true + gpus: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + gpu_alias: + type: string + readOnly: true + writeOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + readOnly: true + writeOnly: true + id: + type: string + format: uuid + readOnly: true + writeOnly: true + instances: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + last_provisioning_state_change: + type: + - string + - 'null' + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of the last time the cluster's provisioning_state + changed + last_used: + type: + - string + - 'null' + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the cluster was last in use + maintenance: + type: boolean + writeOnly: true + description: Is the cluster in maintenance mode? + mgmt_ip: + type: string + writeOnly: true + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + writeOnly: true + description: Management MAC address + maxLength: 17 + minLength: 17 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + netmask: + type: + - integer + - 'null' + maximum: 32 + minimum: 0 + writeOnly: true + description: The subnet mask of the cluster's public IP address in CIDR + notation + node_count: + type: integer + readOnly: true + writeOnly: true + nodes: + type: array + items: + type: string + format: uuid + writeOnly: true + notes: + type: + - string + - 'null' + writeOnly: true + description: Administrative comments about the cluster + persist: + type: boolean + writeOnly: true + description: Is the cluster exempt from provisioning_state timeouts? Can + be used to ensure the cluster persists after a provisioning failure. + provider_capacity: + type: boolean + readOnly: true + writeOnly: true + description: Does the provider have capacity to provision this cluster? + provision_user: + type: + - string + - 'null' + writeOnly: true + description: Username used for provisioning this cluster + maxLength: 64 + provisioning_attempts: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: The number of attempts that have been made to provision this + cluster. Automatically resets to 0 after successful provisioning. + provisioning_config: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Applied provisioning configuration for the cluster + provisioning_request: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Requested provisioning configuration for the cluster + provisioning_state: + allOf: + - $ref: '#/components/schemas/ProvisioningStateEnum' + writeOnly: true + description: |- + Is the cluster currently provisioned? + + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + public_address: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Public IP address or fully-qualified domain name of this cluster + maxLength: 255 + request_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: 'The request ID for the lab that is currently provisioned on + this cluster (ex: TRY-1234)' + maxLength: 32 + reservation: + type: boolean + writeOnly: true + description: Is the cluster a static reservation from its provider? + tenant_ids: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + description: Tenant UUID(s) that have been generated for this cluster during + provisioning + vlan_id: + type: integer + maximum: 4094 + minimum: 1 + writeOnly: true + description: VLAN number + workshop: + type: boolean + writeOnly: true + description: Is the cluster set aside for use in a workshop? + workshop_id: + type: + - string + - 'null' + writeOnly: true + description: Identifier of the workshop this cluster is set aside for + maxLength: 64 + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - available + - count + - created + - deployment + - gpu_alias + - gpu_count + - gpus + - id + - ids + - instances + - last_provisioning_state_change + - last_used + - modified + - node_count + - provider_capacity + - public_address + - request_id + - result + - tenant_ids + ClusterPipeline: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + readOnly: true + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + cluster: + type: string + format: uuid + writeOnly: true + description: The cluster that the pipeline was triggered for + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + readOnly: true + description: GitLab pipeline ID + request_id: + type: string + readOnly: true + description: Request ID that the pipeline was triggered for + url: + type: string + format: uri + readOnly: true + description: URL for the pipeline details + required: + - action + - cluster + - created + - id + - modified + - pipeline_id + - request_id + - url + ClusterPipelineTrigger: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + readOnly: true + description: GitLab pipeline ID + request_id: + type: string + readOnly: true + description: Request ID that the pipeline was triggered for + url: + type: string + format: uri + readOnly: true + description: URL for the pipeline details + required: + - action + - created + - id + - modified + - pipeline_id + - request_id + - url + ClusterProvisionCreateResponse: + type: object + properties: + pipeline: + allOf: + - $ref: '#/components/schemas/ClusterPipeline' + readOnly: true + provisioning_config: + allOf: + - $ref: '#/components/schemas/ProvisioningRequest' + readOnly: true + required: + - pipeline + - provisioning_config + CpuManufacturerEnum: + enum: + - amd + - arm + - intel + type: string + description: |- + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + Deployment: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured + by Liftoff + maxLength: 32 + catalog_id: + type: string + writeOnly: true + description: Catalog ID of the experience provisioned to the cluster + catalog_id_alias: + type: string + writeOnly: true + description: Catalog ID alias of the experience provisioned to the cluster + cluster: + type: string + format: uuid + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the + pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + experience_id: + type: string + format: uuid + writeOnly: true + description: UUID of the experience provisioned to the cluster + expires_at: + type: + - string + - 'null' + format: date-time + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + ip_allowlist: + type: array + items: + type: string + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + description: Set expires_at value to be a given number of days from the + current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster whose GPU count is greater than or equal + to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + default: false + description: Override the default cleanup/destroy behavior when a provisioning + failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + default: 0 + description: Override the pipeline ID that will be triggered for request + fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering + a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - $ref: '#/components/schemas/NullEnum' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + writeOnly: true + description: The initial or administrative public key used during deployment + creation. Additional keys can be authorized for access using the `ssh-keys` + endpoint. + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + format: email + description: Email address of the user requesting the experience + maxLength: 254 + requester_name: + type: string + description: Name of the user requesting the experience + maxLength: 255 + retry_count: + type: integer + readOnly: true + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this + experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + sales_id: + type: + - string + - 'null' + description: Unique identifier for the requester's sales relationship + maxLength: 32 + sales_owner_email: + type: + - string + - 'null' + format: email + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + ssh_port: + type: integer + readOnly: true + ssh_user: + type: string + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + readOnly: true + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static + password. This is useful for workshops when you'd like an identical password + associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - created + - experience + - id + - modified + - org_name + - overrides + - pipelines + - requester_email + - requester_name + - retry_count + - services + - ssh_port + - ssh_user + - state + DeploymentBulkUpdate: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override bastion operating system provisioned and/or configured + by Liftoff + maxLength: 32 + cluster: + type: + - string + - 'null' + format: uuid + readOnly: true + writeOnly: true + description: The cluster where the experience has been deployed + collection_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the Ansible collection branch initialized within the + pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + writeOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the experience branch + maxLength: 255 + expires_at: + type: + - string + - 'null' + format: date-time + writeOnly: true + flightcontrol_release: + type: + - string + - 'null' + writeOnly: true + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + writeOnly: true + ip_allowlist: + type: array + items: + type: string + writeOnly: true + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + description: Set expires_at value to be a given number of days from the + current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + default: 0 + description: Require a cluster whose GPU count is greater than or equal + to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + readOnly: true + writeOnly: true + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + writeOnly: true + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + writeOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + writeOnly: true + default: false + description: Override the default cleanup/destroy behavior when a provisioning + failure occurs + persona: + type: + - string + - 'null' + writeOnly: true + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + writeOnly: true + default: 0 + description: Override the pipeline ID that will be triggered for request + fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the default pipeline branch ref used when triggering + a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + platform: + writeOnly: true + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - $ref: '#/components/schemas/NullEnum' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + readOnly: true + writeOnly: true + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: The initial or administrative public key used during deployment + creation. Additional keys can be authorized for access using the `ssh-keys` + endpoint. + region: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + readOnly: true + writeOnly: true + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + writeOnly: true + description: Email address of the user requesting the experience + requester_name: + type: string + writeOnly: true + description: Name of the user requesting the experience + retry_count: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this + experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + readOnly: true + writeOnly: true + description: Timestamp when the requester's sales relationship was created + sales_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Unique identifier for the requester's sales relationship + sales_owner_email: + type: + - string + - 'null' + format: email + writeOnly: true + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + writeOnly: true + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + writeOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + writeOnly: true + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + writeOnly: true + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + readOnly: true + writeOnly: true + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Override the deployment's default authentication to use a static + password. This is useful for workshops when you'd like an identical password + associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - bastion_operating_system + - cluster + - count + - created + - experience + - garage_id + - gpu_alias + - gpu_count + - gpu_model + - gpu_os_name + - gpu_os_release + - gpu_os_version + - id + - ids + - lifetime + - min_gpu_count + - modified + - node_count + - oem_name + - overrides + - pipelines + - priority + - provider_name + - public_key + - region + - request_id + - result + - sales_created_date + - sales_id + - services + - workshop + - workshop_id + - workshop_override_password + DeploymentInstance: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + instance_id: + type: string + readOnly: true + description: Unique ID for this instance assigned by its provider + name: + type: + - string + - 'null' + readOnly: true + description: User-friendly name of this instance + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + state: + allOf: + - $ref: '#/components/schemas/InstanceState' + readOnly: true + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + state_modified: + type: string + format: date-time + readOnly: true + tags: + type: array + items: + type: string + maxLength: 64 + readOnly: true + description: Tags associated with this instance + required: + - created + - id + - instance_id + - modified + - name + - state + - state_modified + - tags + DeploymentKey: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + type: string + format: uuid + writeOnly: true + description: The deployment this key is authorized to access + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: Descriptive name for the SSH public key + maxLength: 64 + public_key: + type: string + writeOnly: true + description: An SSH public key that should be authorized to access the deployment + required: + - created + - deployment + - id + - modified + - name + - public_key + DeploymentNote: + type: object + properties: + content: + type: string + description: Text content of the note + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + created_by: + type: string + readOnly: true + deployment: + type: string + format: uuid + description: The deployment this note is applied to + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + modified_by: + type: string + readOnly: true + required: + - created + - created_by + - deployment + - id + - modified + - modified_by + DeploymentPipeline: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + type: string + format: uuid + writeOnly: true + description: The deployment that triggered the pipeline + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: GitLab pipeline ID + url: + type: string + format: uri + description: URL for the pipeline details + maxLength: 200 + required: + - action + - created + - deployment + - id + - modified + - pipeline_id + - url + DeploymentPipelineTrigger: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/PipelineAction' + description: |- + Action for the pipeline to run + + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + pipeline_id: + type: integer + readOnly: true + description: GitLab pipeline ID + url: + type: string + format: uri + readOnly: true + description: URL for the pipeline details + required: + - action + - created + - id + - modified + - pipeline_id + - url + DeploymentService: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + type: string + format: uuid + writeOnly: true + description: The deployment that exposes the service + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: Name of the service + maxLength: 32 + url: + type: string + format: uri + description: URL used to reach the service + maxLength: 200 + required: + - created + - deployment + - id + - modified + - name + - url + DeploymentState: + enum: + - destroyed + - destroying + - error + - failed + - paused + - ready + - retrying + - starting + - stopped + - stopping + - waiting + type: string + description: |- + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + DeploymentTask: + type: object + properties: + action: + allOf: + - $ref: '#/components/schemas/DeploymentTaskActionEnum' + description: |- + The action the task will perform + + * `start_instances` - Start all instances in the deployment + * `stop_instances` - Stop all instances in the deployment + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + deployment: + type: string + format: uuid + writeOnly: true + description: The deployment where the task is being executed + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + retries: + type: integer + readOnly: true + description: Number of times the task has been retried + status: + allOf: + - $ref: '#/components/schemas/StatusEnum' + readOnly: true + description: |- + Current status of the task + + * `completed` - completed + * `failed` - failed + * `pending` - pending + * `processing` - processing + * `retrying` - retrying + status_text: + type: string + readOnly: true + description: Messages related to the current task status + required: + - action + - created + - deployment + - id + - modified + - retries + - status + - status_text + DeploymentTaskActionEnum: + enum: + - start_instances + - stop_instances + type: string + description: |- + * `start_instances` - Start all instances in the deployment + * `stop_instances` - Stop all instances in the deployment + DeploymentUpdate: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + readOnly: true + description: Override bastion operating system provisioned and/or configured + by Liftoff + maxLength: 32 + cluster: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The cluster where the experience has been deployed + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the + pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + expires_at: + type: + - string + - 'null' + format: date-time + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + readOnly: true + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + readOnly: true + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + readOnly: true + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + readOnly: true + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + ip_allowlist: + type: array + items: + type: string + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + readOnly: true + description: Set expires_at value to be a given number of days from the + current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + readOnly: true + default: 0 + description: Require a cluster whose GPU count is greater than or equal + to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + readOnly: true + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + readOnly: true + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + default: false + description: Override the default cleanup/destroy behavior when a provisioning + failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + default: 0 + description: Override the pipeline ID that will be triggered for request + fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering + a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - $ref: '#/components/schemas/NullEnum' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + readOnly: true + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + readOnly: true + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + readOnly: true + description: The initial or administrative public key used during deployment + creation. Additional keys can be authorized for access using the `ssh-keys` + endpoint. + region: + type: + - string + - 'null' + readOnly: true + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + readOnly: true + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + description: Email address of the user requesting the experience + requester_name: + type: string + description: Name of the user requesting the experience + retry_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this + experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + readOnly: true + description: Timestamp when the requester's sales relationship was created + sales_id: + type: + - string + - 'null' + readOnly: true + description: Unique identifier for the requester's sales relationship + sales_owner_email: + type: + - string + - 'null' + format: email + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + readOnly: true + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + readOnly: true + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + readOnly: true + description: Override the deployment's default authentication to use a static + password. This is useful for workshops when you'd like an identical password + associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - bastion_operating_system + - cluster + - created + - experience + - garage_id + - gpu_alias + - gpu_count + - gpu_model + - gpu_os_name + - gpu_os_release + - gpu_os_version + - id + - lifetime + - min_gpu_count + - modified + - node_count + - oem_name + - overrides + - pipelines + - priority + - provider_name + - public_key + - region + - request_id + - sales_created_date + - sales_id + - services + - workshop + - workshop_id + - workshop_override_password + DocDeploymentDelete: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured + by Liftoff + maxLength: 32 + catalog_id: + type: string + writeOnly: true + description: Catalog ID of the experience provisioned to the cluster + catalog_id_alias: + type: string + writeOnly: true + description: Catalog ID alias of the experience provisioned to the cluster + cluster: + type: string + format: uuid + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the + pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + experience_id: + type: string + format: uuid + writeOnly: true + description: UUID of the experience provisioned to the cluster + expires_at: + type: + - string + - 'null' + format: date-time + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of GPUs + maximum: 512 + minimum: 0 + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + id: + type: string + format: uuid + readOnly: true + ip_allowlist: + type: array + items: + type: string + description: Host IP addresses that should be allowed to access the deployment + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + description: Set expires_at value to be a given number of days from the + current time. A value of 0 will cause a deployment to remain active indefinitely. + min_gpu_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster whose GPU count is greater than or equal + to the given number + maximum: 512 + minimum: 0 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: + - integer + - 'null' + default: 0 + description: Require a cluster with the given number of nodes + minimum: 0 + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + org_name: + type: string + description: Requester's organization name + overrides: + allOf: + - $ref: '#/components/schemas/Overrides' + readOnly: true + description: Overriden values from the original deployment request + persist_on_failure: + type: + - boolean + - 'null' + default: false + description: Override the default cleanup/destroy behavior when a provisioning + failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: + - integer + - 'null' + default: 0 + description: Override the pipeline ID that will be triggered for request + fulfillment + minimum: 0 + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering + a Fuselage pipeline + maxLength: 255 + pipelines: + type: array + items: + type: string + format: uuid + readOnly: true + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - $ref: '#/components/schemas/NullEnum' + priority: + allOf: + - $ref: '#/components/schemas/PriorityEnum' + description: |- + Priority level for the request + + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + public_key: + type: + - string + - 'null' + writeOnly: true + description: The initial or administrative public key used during deployment + creation. Additional keys can be authorized for access using the `ssh-keys` + endpoint. + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + description: 'Trial request ID (ex: TRY-1234)' + requester_email: + type: string + format: email + description: Email address of the user requesting the experience + maxLength: 254 + requester_name: + type: string + description: Name of the user requesting the experience + maxLength: 255 + retry_count: + type: integer + readOnly: true + description: Number of times the deployment has been retried + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: Use the presets of the given runtime when provisioning this + experience + runtime_branch: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + writeOnly: true + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + writeOnly: true + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + writeOnly: true + description: Override the URL of the runtime repository + sales_created_date: + type: + - string + - 'null' + format: date-time + sales_id: + type: + - string + - 'null' + description: Unique identifier for the requester's sales relationship + maxLength: 32 + sales_owner_email: + type: + - string + - 'null' + format: email + description: Email address of the sales contact associated with the requester + maxLength: 254 + sales_owner_name: + type: + - string + - 'null' + description: Name of the sales contact associated with the requester + maxLength: 255 + services: + type: array + items: + type: string + format: uuid + readOnly: true + ssh_port: + type: integer + readOnly: true + ssh_user: + type: string + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/DeploymentState' + readOnly: true + description: |- + Current state of the deployment + + * `destroyed` - Deployment has been fully destroyed + * `destroying` - Deployment is being destroyed + * `error` - Deployment has encountered a fatal error and will not be retried + * `failed` - Deployment has failed but may be retried + * `paused` - Deployment is paused but may be retried later + * `ready` - Deployment is ready and all instances are running + * `retrying` - Deployment is retrying + * `starting` - Deployment instances are starting + * `stopped` - Deployment instances are stopped + * `stopping` - Deployment instances are stopping + * `waiting` - Waiting for deployment to be ready + tags: + description: User-defined tags as key/value pairs + workshop: + type: + - boolean + - 'null' + default: false + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static + password. This is useful for workshops when you'd like an identical password + associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - created + - experience + - id + - modified + - org_name + - overrides + - pipelines + - requester_email + - requester_name + - retry_count + - services + - ssh_port + - ssh_user + - state + Experience: + type: object + properties: + assignee: + type: + - string + - 'null' + description: User ID who is responsible for manual provisioning + maxLength: 32 + autoapprove: + type: boolean + description: Can the experience be provisioned without human approval? + autoprovision: + type: boolean + description: Can the experience be provisioned without human intervention? + bootstrap: + type: boolean + description: Can this experience be used to bootstrap another compatible + experience? + catalog_id: + type: string + description: Unique ID for this experience in the sales catalog. Must be + unique. + maxLength: 32 + catalog_id_alias: + type: + - string + - 'null' + description: 'Human-readable identifier for the experience in the sales + catalog (ex: LP-15). Must be unique.' + maxLength: 8 + category: + allOf: + - $ref: '#/components/schemas/CategoryEnum' + description: |- + Functional group that this experience is targetting + + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + collection_branch: + type: string + description: Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + description: + type: + - string + - 'null' + experience: + type: string + description: Experience name slug + maxLength: 64 + experience_branch: + type: string + description: 'Experience branch name used during deployment (default: origin/main)' + maxLength: 255 + fc_platform: + writeOnly: true + description: |- + Fleet Command platform type + + * `docker` - docker + * `k8s` - k8s + oneOf: + - $ref: '#/components/schemas/FcPlatformEnum' + - $ref: '#/components/schemas/NullEnum' + fc_support: + type: boolean + writeOnly: true + description: Does the experience support Flight Control? + featured: + type: boolean + readOnly: true + description: Is the experience featured in the catalog? + garage_id: + type: + - string + - 'null' + description: ID of the garage where nodes for this experience should be + selected from + maxLength: 64 + gc_branch: + type: string + description: 'Ground Control branch name (default: main)' + maxLength: 255 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Number of GPUs used + gpu_os: + $ref: '#/components/schemas/GpuOs' + id: + type: string + format: uuid + readOnly: true + inactivity_max: + type: integer + maximum: 2147483647 + minimum: 0 + description: 'Number of days without user interaction before the experience + is torn down (default: 3)' + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + description: 'Default number of days a provisioned experience should remain + active (default: 3). A null lifetime will cause a deployment to remain + active indefinitely.' + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Number of Nodes used + oem: + type: + - string + - 'null' + format: uuid + description: If set, the experience must be provisioned to hardware manufactured + by the given OEM + persona: + type: string + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: Pipeline ID used for provisioning + platform: + allOf: + - $ref: '#/components/schemas/PlatformEnum' + description: |- + Base platform that the experience will be provisioned onto + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + provider: + type: + - string + - 'null' + format: uuid + description: If set, the experience must be provisioned to the given provider + published: + allOf: + - $ref: '#/components/schemas/PublishedEnum' + description: |- + Is the experience published for use? + + * `draft` - draft + * `no` - no + * `yes` - yes + repo: + type: + - string + - 'null' + format: uri + writeOnly: true + description: URL of the repository for provisioning automation + maxLength: 200 + required_gpus: + type: array + items: + type: string + format: uuid + description: 'If set, the experience must be provisioned using one of the + given GPU types. GPU requirements are evaluated in the order they are + set (ex: ["{l40s_gpu_uuid}", "{a100_gpu_uuid}"] will prefer an l40s).' + runtime: + type: + - string + - 'null' + format: uuid + description: The default runtime to use when provisioning this experience + sa_lab: + type: boolean + description: Is this a persistent experience for SAs? + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + description: |- + Required CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + title: + type: string + vgpu_profile: + type: + - string + - 'null' + required: + - catalog_id + - category + - created + - experience + - featured + - gpu_os + - id + - modified + - persona + - pipeline + - platform + - system_arch + - title + ExperienceBulk: + type: object + properties: + csv_file: + type: string + format: uri + writeOnly: true + experiences: + type: array + items: + $ref: '#/components/schemas/Experience' + readOnly: true + required: + - csv_file + - experiences + ExperienceBulkUpdate: + type: object + properties: + assignee: + type: + - string + - 'null' + writeOnly: true + description: User ID who is responsible for manual provisioning + maxLength: 32 + autoapprove: + type: boolean + writeOnly: true + description: Can the experience be provisioned without human approval? + autoprovision: + type: boolean + writeOnly: true + description: Can the experience be provisioned without human intervention? + bootstrap: + type: boolean + writeOnly: true + description: Can this experience be used to bootstrap another compatible + experience? + catalog_id: + type: string + readOnly: true + writeOnly: true + description: Unique ID for this experience in the sales catalog. Must be + unique. + maxLength: 32 + catalog_id_alias: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: 'Human-readable identifier for the experience in the sales + catalog (ex: LP-15). Must be unique.' + maxLength: 8 + category: + allOf: + - $ref: '#/components/schemas/CategoryEnum' + writeOnly: true + description: |- + Functional group that this experience is targetting + + * `AI` - AI + * `Clara` - Clara + * `Data Science` - Data Science + * `3D Design Collaboration and Simulation` - 3D Design Collaboration and Simulation + * `Developer` - Developer + * `Infrastructure Optimization` - Infrastructure Optimization + collection_branch: + type: string + writeOnly: true + description: Ansible collection branch initialized within the pipeline + maxLength: 255 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + description: + type: + - string + - 'null' + writeOnly: true + experience: + type: string + writeOnly: true + description: Experience name slug + maxLength: 64 + experience_branch: + type: string + writeOnly: true + description: 'Experience branch name used during deployment (default: origin/main)' + maxLength: 255 + fc_platform: + writeOnly: true + description: |- + Fleet Command platform type + + * `docker` - docker + * `k8s` - k8s + oneOf: + - $ref: '#/components/schemas/FcPlatformEnum' + - $ref: '#/components/schemas/NullEnum' + fc_support: + type: boolean + writeOnly: true + description: Does the experience support Flight Control? + featured: + type: boolean + readOnly: true + writeOnly: true + description: Is the experience featured in the catalog? + garage_id: + type: + - string + - 'null' + writeOnly: true + description: ID of the garage where nodes for this experience should be + selected from + maxLength: 64 + gc_branch: + type: string + writeOnly: true + description: 'Ground Control branch name (default: main)' + maxLength: 255 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + writeOnly: true + description: Number of GPUs used + gpu_os: + allOf: + - $ref: '#/components/schemas/GpuOs' + writeOnly: true + id: + type: string + format: uuid + readOnly: true + writeOnly: true + inactivity_max: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: 'Number of days without user interaction before the experience + is torn down (default: 3)' + lifetime: + type: + - integer + - 'null' + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: 'Default number of days a provisioned experience should remain + active (default: 3). A null lifetime will cause a deployment to remain + active indefinitely.' + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: Number of Nodes used + oem: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: If set, the experience must be provisioned to hardware manufactured + by the given OEM + persona: + type: string + writeOnly: true + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + writeOnly: true + description: Pipeline ID used for provisioning + platform: + allOf: + - $ref: '#/components/schemas/PlatformEnum' + writeOnly: true + description: |- + Base platform that the experience will be provisioned onto + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + provider: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: If set, the experience must be provisioned to the given provider + published: + allOf: + - $ref: '#/components/schemas/PublishedEnum' + writeOnly: true + description: |- + Is the experience published for use? + + * `draft` - draft + * `no` - no + * `yes` - yes + repo: + type: + - string + - 'null' + format: uri + writeOnly: true + description: URL of the repository for provisioning automation + maxLength: 200 + required_gpus: + type: array + items: + type: string + format: uuid + writeOnly: true + description: 'If set, the experience must be provisioned using one of the + given GPU types. GPU requirements are evaluated in the order they are + set (ex: ["{l40s_gpu_uuid}", "{a100_gpu_uuid}"] will prefer an l40s).' + runtime: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: The default runtime to use when provisioning this experience + sa_lab: + type: boolean + writeOnly: true + description: Is this a persistent experience for SAs? + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + writeOnly: true + description: |- + Required CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + title: + type: string + writeOnly: true + vgpu_profile: + type: + - string + - 'null' + writeOnly: true + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - catalog_id + - catalog_id_alias + - category + - count + - created + - experience + - featured + - gpu_os + - id + - ids + - modified + - persona + - pipeline + - platform + - result + - system_arch + - title + ExperienceNote: + type: object + properties: + content: + type: string + description: Text content of the note + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + created_by: + type: string + readOnly: true + experience: + type: string + format: uuid + description: The experience this note is applied to + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + modified_by: + type: string + readOnly: true + required: + - created + - created_by + - experience + - id + - modified + - modified_by + FcPlatformEnum: + enum: + - docker + - k8s + type: string + description: |- + * `docker` - docker + * `k8s` - k8s + Gpu: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + form_factor: + allOf: + - $ref: '#/components/schemas/InterconnectionTypeEnum' + default: pcie + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + id: + type: string + format: uuid + readOnly: true + memory: + type: integer + maximum: 32768 + minimum: 0 + default: 0 + description: Total GPU memory (in GB) + model: + type: string + description: GPU model name + maxLength: 32 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + readOnly: true + priority: + type: integer + maximum: 100 + minimum: 0 + description: Weighted preference to use in selecting a GPU for a deployment. + A higher priority means the GPU is in higher demand. Lower priority values + will be preferred over higher ones during cluster selection. + required: + - created + - id + - model + - modified + - node_count + GpuBulkUpdate: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + form_factor: + allOf: + - $ref: '#/components/schemas/InterconnectionTypeEnum' + writeOnly: true + default: pcie + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + id: + type: string + format: uuid + readOnly: true + writeOnly: true + memory: + type: integer + maximum: 32768 + minimum: 0 + writeOnly: true + default: 0 + description: Total GPU memory (in GB) + model: + type: string + writeOnly: true + description: GPU model name + maxLength: 32 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + node_count: + type: integer + readOnly: true + writeOnly: true + priority: + type: integer + maximum: 100 + minimum: 0 + writeOnly: true + description: Weighted preference to use in selecting a GPU for a deployment. + A higher priority means the GPU is in higher demand. Lower priority values + will be preferred over higher ones during cluster selection. + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - count + - created + - id + - ids + - model + - modified + - node_count + - result + GpuOs: + type: object + properties: + name: + type: string + release: + type: string + version: + type: string + required: + - name + - release + - version + GpuOsChoice: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: integer + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: 'Name of the OS to be provisioned onto GPU Node(s) (ex: ubuntu)' + maxLength: 16 + release: + type: string + description: 'Release name of the OS to be provisioned onto GPU Node(s) + (ex: jammy)' + maxLength: 16 + version: + type: string + description: 'Version number of the OS to be provisioned onto GPU Node(s) + (ex: 22.04)' + maxLength: 8 + required: + - created + - id + - modified + - name + - release + - version + Instance: + type: object + properties: + cluster: + type: string + format: uuid + description: UUID of the associated cluster for this instance + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + instance_id: + type: string + description: Unique ID for this instance assigned by its provider + maxLength: 128 + name: + type: + - string + - 'null' + description: User-friendly name of this instance + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + state: + allOf: + - $ref: '#/components/schemas/InstanceState' + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + state_modified: + type: string + format: date-time + readOnly: true + tags: + type: array + items: + type: string + maxLength: 64 + description: Tags associated with this instance + required: + - cluster + - created + - id + - instance_id + - modified + - state_modified + InstanceBulkUpdate: + type: object + properties: + cluster: + type: string + format: uuid + writeOnly: true + description: UUID of the associated cluster for this instance + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + writeOnly: true + instance_id: + type: string + readOnly: true + writeOnly: true + description: Unique ID for this instance assigned by its provider + maxLength: 128 + name: + type: + - string + - 'null' + writeOnly: true + description: User-friendly name of this instance + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + state: + allOf: + - $ref: '#/components/schemas/InstanceState' + writeOnly: true + description: |- + Current lifecycle state of this instance + + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + state_modified: + type: string + format: date-time + readOnly: true + writeOnly: true + tags: + type: array + items: + type: string + maxLength: 64 + writeOnly: true + description: Tags associated with this instance + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - cluster + - count + - created + - id + - ids + - instance_id + - modified + - result + - state_modified + InstanceState: + enum: + - running + - starting + - stopped + - stopping + - unknown + type: string + description: |- + * `running` - Instance is running + * `starting` - Instance is starting + * `stopped` - Instance is stopped + * `stopping` - Instance is stopping + * `unknown` - Instance state is currently unknown + InstanceType: + type: object + properties: + capacity: + type: object + additionalProperties: + type: integer + description: Key/value pairs of region name and total available capacity + for the instance type + cloud: + type: string + description: Cloud provider name + cpu: + type: integer + description: Total number of CPUs/vCPUs available + gpu: + $ref: '#/components/schemas/InstanceTypeGpu' + memory_gb: + type: integer + description: Total system memory (in GB) + price: + $ref: '#/components/schemas/InstanceTypePrice' + regions: + type: array + items: + type: string + description: List of regions names that have available capacity for the + instance type + storage: + type: array + items: + $ref: '#/components/schemas/InstanceTypeStorage' + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + workshop_id: + type: string + description: ID of the workshop this instance type is reserved for + required: + - capacity + - cloud + - cpu + - gpu + - memory_gb + - price + - regions + - storage + - system_arch + - workshop_id + InstanceTypeGpu: + type: object + properties: + count: + type: integer + description: Total number of GPUs + family: + type: string + description: GPU family name + interconnection_type: + allOf: + - $ref: '#/components/schemas/InterconnectionTypeEnum' + description: |- + GPU form factor + + * `pcie` - PCIe + * `sxm` - SXM + manufacturer: + type: string + description: GPU manufacturer name + memory_gb: + type: integer + description: Total GPU memory (in GB) + model: + type: string + description: GPU model name + required: + - count + - family + - interconnection_type + - manufacturer + - memory_gb + - model + InstanceTypePrice: + type: object + properties: + currency: + type: string + description: Currency code + on_demand_per_hour: + type: number + format: double + description: Price per hour + required: + - currency + - on_demand_per_hour + InstanceTypeStorage: + type: object + properties: + size_gb: + type: integer + description: System storage size (in GB) + type: + allOf: + - $ref: '#/components/schemas/TypeEnum' + description: |- + Disk type + + * `nvme` - NVMe + * `ssd` - ssd + required: + - size_gb + - type + InterconnectionTypeEnum: + enum: + - pcie + - sxm + type: string + description: |- + * `pcie` - PCIe + * `sxm` - SXM + Location: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + provider: + type: string + format: uuid + description: UUID of the provider for this location + region: + type: + - string + - 'null' + description: Name of the region the location is in + maxLength: 64 + required: + - created + - id + - modified + - name + - provider + Logout: + type: object + properties: + result: + type: string + readOnly: true + default: Successfully logged out. + required: + - result + ModelChange: + type: object + properties: + change_type: + type: string + readOnly: true + changes: + type: array + items: + type: object + properties: + field: + type: string + new_value: + oneOf: + - type: string + - type: boolean + - type: integer + nullable: true + old_value: + oneOf: + - type: string + - type: boolean + - type: integer + nullable: true + required: + - field + - new_value + - old_value + readOnly: true + created: + type: string + format: date-time + id: + type: integer + username: + type: string + required: + - change_type + - changes + - created + - id + - username + NetworkTypeEnum: + enum: + - ethernet + - infiniband + type: string + description: |- + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + Node: + type: object + properties: + bmc_ip: + type: + - string + - 'null' + description: IP address of the BMC + bmc_mac: + type: + - string + - 'null' + description: MAC address of the BMC + maxLength: 17 + minLength: 17 + bmc_password: + type: + - string + - 'null' + description: Password for the BMC + maxLength: 32 + bmc_user: + type: + - string + - 'null' + description: Username for the BMC + maxLength: 64 + cluster: + type: + - string + - 'null' + format: uuid + description: UUID of the node's parent cluster + cpu: + type: integer + maximum: 1024 + minimum: 0 + description: Number of CPU cores installed + cpu_manufacturer: + description: |- + Manufacturer of the node's CPU + + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + oneOf: + - $ref: '#/components/schemas/CpuManufacturerEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + cpu_model: + type: + - string + - 'null' + description: Model information for the node's CPU + maxLength: 64 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + garage_id: + type: + - string + - 'null' + description: ID for the garage where a node is parked when unprovisioned + maxLength: 128 + gpu: + type: string + format: uuid + description: Type of GPU(s) installed + gpu_alias: + type: string + readOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Number of GPUs installed + gpu_model: + type: string + readOnly: true + description: Model of GPU(s) installed + gpu_vbios: + type: + - string + - 'null' + description: VBIOS version used by installed GPU(s) + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + location: + type: string + format: uuid + description: UUID of the node's location + memory: + type: integer + maximum: 32768 + minimum: 0 + description: Amount of RAM installed (in GB) + mgmt_ip: + type: string + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + description: Management MAC address + maxLength: 17 + minLength: 17 + model: + type: + - string + - 'null' + description: Hardware model of the node + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + network_type: + allOf: + - $ref: '#/components/schemas/NetworkTypeEnum' + description: |- + Type of networking technology used + + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + nic_prefixes: + type: array + items: + type: string + maxLength: 15 + description: Prefixes for the node's network interface(s) + notes: + type: + - string + - 'null' + description: Administrative comments about the node + oem: + type: + - string + - 'null' + format: uuid + description: UUID of the node's OEM + provider_node_id: + type: + - string + - 'null' + description: Unique ID for this node assigned by its provider + maxLength: 128 + rack: + type: + - string + - 'null' + description: Physical rack identifier + maxLength: 32 + rack_unit: + type: + - integer + - 'null' + maximum: 52 + minimum: 0 + description: The rack unit (RU) within the rack where the node is installed + serial_number: + type: + - string + - 'null' + description: Serial number of the node + maxLength: 32 + storage: + type: array + items: + $ref: '#/components/schemas/NodeStorage' + minItems: 1 + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + tee: + type: boolean + description: Does the node support Trusted Execution Environment (TEE)? + required: + - created + - gpu + - gpu_alias + - gpu_model + - id + - location + - modified + - storage + - system_arch + NodeBulk: + type: object + properties: + csv_file: + type: string + format: uri + writeOnly: true + nodes: + type: array + items: + $ref: '#/components/schemas/Node' + readOnly: true + required: + - csv_file + - nodes + NodeBulkUpdate: + type: object + properties: + bmc_ip: + type: + - string + - 'null' + writeOnly: true + description: IP address of the BMC + bmc_mac: + type: + - string + - 'null' + writeOnly: true + description: MAC address of the BMC + maxLength: 17 + minLength: 17 + bmc_password: + type: + - string + - 'null' + writeOnly: true + description: Password for the BMC + maxLength: 32 + bmc_user: + type: + - string + - 'null' + writeOnly: true + description: Username for the BMC + maxLength: 64 + cluster: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: UUID of the node's parent cluster + cpu: + type: integer + maximum: 1024 + minimum: 0 + writeOnly: true + description: Number of CPU cores installed + cpu_manufacturer: + writeOnly: true + description: |- + Manufacturer of the node's CPU + + * `amd` - AMD + * `arm` - ARM + * `intel` - Intel + oneOf: + - $ref: '#/components/schemas/CpuManufacturerEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + cpu_model: + type: + - string + - 'null' + writeOnly: true + description: Model information for the node's CPU + maxLength: 64 + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + garage_id: + type: + - string + - 'null' + writeOnly: true + description: ID for the garage where a node is parked when unprovisioned + maxLength: 128 + gpu: + type: string + format: uuid + writeOnly: true + description: Type of GPU(s) installed + gpu_alias: + type: string + readOnly: true + writeOnly: true + description: Alias for GPU plan (i.e. installed GPU type and count) + gpu_count: + type: integer + maximum: 512 + minimum: 0 + writeOnly: true + description: Number of GPUs installed + gpu_model: + type: string + readOnly: true + writeOnly: true + description: Model of GPU(s) installed + gpu_vbios: + type: + - string + - 'null' + writeOnly: true + description: VBIOS version used by installed GPU(s) + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + writeOnly: true + location: + type: string + format: uuid + writeOnly: true + description: UUID of the node's location + memory: + type: integer + maximum: 32768 + minimum: 0 + writeOnly: true + description: Amount of RAM installed (in GB) + mgmt_ip: + type: string + writeOnly: true + description: Management IP address + mgmt_mac: + type: + - string + - 'null' + writeOnly: true + description: Management MAC address + maxLength: 17 + minLength: 17 + model: + type: + - string + - 'null' + writeOnly: true + description: Hardware model of the node + maxLength: 64 + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + network_type: + allOf: + - $ref: '#/components/schemas/NetworkTypeEnum' + writeOnly: true + description: |- + Type of networking technology used + + * `ethernet` - Ethernet + * `infiniband` - InfiniBand + nic_prefixes: + type: array + items: + type: string + maxLength: 15 + writeOnly: true + description: Prefixes for the node's network interface(s) + notes: + type: + - string + - 'null' + writeOnly: true + description: Administrative comments about the node + oem: + type: + - string + - 'null' + format: uuid + writeOnly: true + description: UUID of the node's OEM + provider_node_id: + type: + - string + - 'null' + writeOnly: true + description: Unique ID for this node assigned by its provider + maxLength: 128 + rack: + type: + - string + - 'null' + writeOnly: true + description: Physical rack identifier + maxLength: 32 + rack_unit: + type: + - integer + - 'null' + maximum: 52 + minimum: 0 + writeOnly: true + description: The rack unit (RU) within the rack where the node is installed + serial_number: + type: + - string + - 'null' + readOnly: true + writeOnly: true + description: Serial number of the node + maxLength: 32 + storage: + type: array + items: + $ref: '#/components/schemas/NodeStorage' + writeOnly: true + minItems: 1 + system_arch: + allOf: + - $ref: '#/components/schemas/SystemArchEnum' + writeOnly: true + description: |- + CPU architecture + + * `amd64` - amd64 + * `arm64` - arm64 + tee: + type: boolean + writeOnly: true + description: Does the node support Trusted Execution Environment (TEE)? + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - count + - created + - gpu + - gpu_alias + - gpu_model + - id + - ids + - location + - modified + - result + - serial_number + - storage + - system_arch + NodeStorage: + type: object + properties: + size: + type: integer + default: 0 + description: Disk size (in GB) + maximum: 1000000 + minimum: 0 + type: + allOf: + - $ref: '#/components/schemas/TypeEnum' + description: |- + Disk type + + * `nvme` - NVMe + * `ssd` - ssd + required: + - type + NullEnum: + type: 'null' + OEM: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + required: + - created + - id + - modified + - name + OnDemandSpeedEnum: + enum: + - fast + - slow + type: string + description: |- + * `fast` - fast + * `slow` - slow + Overrides: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured + by Liftoff + maxLength: 32 + cluster: + type: + - string + - 'null' + format: uuid + description: Target a specific cluster for provisioning + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the + pipeline + maxLength: 255 + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster with the given number of GPUs + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + min_gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster whose GPU count is greater than or equal + to the given number + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Require a cluster with the given number of nodes + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + persist_on_failure: + type: + - boolean + - 'null' + description: Override the default cleanup/destroy behavior when a provisioning + failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: Override the pipeline ID that will be triggered for request + fulfillment + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering + a Fuselage pipeline + maxLength: 255 + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + runtime: + type: + - string + - 'null' + format: uuid + description: Use the presets of the given runtime when provisioning this + experience + runtime_branch: + type: + - string + - 'null' + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + description: Override the URL of the runtime repository + maxLength: 200 + workshop: + type: + - boolean + - 'null' + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static + password. This is useful for workshops when you'd like an identical password + associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + PaginatedClusterList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Cluster' + PaginatedClusterPipelineList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ClusterPipeline' + PaginatedDeploymentInstanceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentInstance' + PaginatedDeploymentKeyList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentKey' + PaginatedDeploymentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Deployment' + PaginatedDeploymentNoteList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentNote' + PaginatedDeploymentPipelineList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentPipeline' + PaginatedDeploymentServiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentService' + PaginatedDeploymentTaskList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/DeploymentTask' + PaginatedExperienceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Experience' + PaginatedExperienceNoteList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ExperienceNote' + PaginatedGpuList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Gpu' + PaginatedGpuOsChoiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/GpuOsChoice' + PaginatedInstanceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Instance' + PaginatedInstanceTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/InstanceType' + PaginatedLocationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Location' + PaginatedModelChangeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ModelChange' + PaginatedNodeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Node' + PaginatedOEMList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/OEM' + PaginatedPersonaChoiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/PersonaChoice' + PaginatedProviderList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Provider' + PaginatedRuntimeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Runtime' + PaginatedVGpuProfileChoiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=4 + previous: + type: string + nullable: true + format: uri + example: https://launchpad.api.nvidia.com/example/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/VGpuProfileChoice' + PasswordChange: + type: object + properties: + username: + type: string + writeOnly: true + password: + type: string + writeOnly: true + new_password: + type: string + writeOnly: true + result: + type: string + readOnly: true + default: Password changed successfully. + required: + - new_password + - password + - result + - username + PersonaChoice: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: integer + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 32 + required: + - created + - id + - modified + - name + PipelineAction: + enum: + - apply + - destroy + - notify + type: string + description: |- + * `apply` - apply + * `destroy` - destroy + * `notify` - notify + PlatformEnum: + enum: + - air + - flight_deck + - kvm_bastion + - lp-vmware-platform + - minimal + - openshift + - proxmox + - vsphere + - vsphere_horizon + - vsphere7 + - vsphere8 + type: string + description: |- + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + PreferredThemeEnum: + enum: + - light + - dark + type: string + description: |- + * `light` - light + * `dark` - dark + PriorityEnum: + enum: + - p0 + - p1 + - p2 + - p3 + type: string + description: |- + * `p0` - p0 + * `p1` - p1 + * `p2` - p2 + * `p3` - p3 + Profile: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + display_name: + type: + - string + - 'null' + readOnly: true + description: Display name of the user + groups: + type: array + items: + type: string + readOnly: true + id: + type: string + format: uuid + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + preferred_theme: + description: |- + Preferred user interface theme + + * `light` - light + * `dark` - dark + oneOf: + - $ref: '#/components/schemas/PreferredThemeEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + preferred_view_settings: + description: Preferred user view settings + username: + type: string + required: + - created + - display_name + - groups + - id + - modified + - username + Provider: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + display_name: + type: + - string + - 'null' + description: Human-friendly version of name. Used for display purposes. + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + instance_limit: + type: integer + maximum: 2147483647 + minimum: 0 + description: The maximum number of provisionined instances allowed globally + for the provider (0 = unlimited) + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + on_demand_speed: + allOf: + - $ref: '#/components/schemas/OnDemandSpeedEnum' + description: |- + Speed of on-demand inventory provisioning + + * `fast` - fast + * `slow` - slow + priority: + type: integer + maximum: 100 + minimum: 0 + description: Weighted preference to use in selecting a provider for a deployment. + Higher priority values will be preferred over lower ones. + required: + - created + - id + - modified + - name + ProviderBulkUpdate: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was created + display_name: + type: + - string + - 'null' + writeOnly: true + description: Human-friendly version of name. Used for display purposes. + maxLength: 64 + id: + type: string + format: uuid + readOnly: true + writeOnly: true + instance_limit: + type: integer + maximum: 2147483647 + minimum: 0 + writeOnly: true + description: The maximum number of provisionined instances allowed globally + for the provider (0 = unlimited) + modified: + type: string + format: date-time + readOnly: true + writeOnly: true + description: Timestamp of when the object was last modified + name: + type: string + readOnly: true + writeOnly: true + maxLength: 64 + on_demand_speed: + allOf: + - $ref: '#/components/schemas/OnDemandSpeedEnum' + writeOnly: true + description: |- + Speed of on-demand inventory provisioning + + * `fast` - fast + * `slow` - slow + priority: + type: integer + maximum: 100 + minimum: 0 + writeOnly: true + description: Weighted preference to use in selecting a provider for a deployment. + Higher priority values will be preferred over lower ones. + count: + type: integer + readOnly: true + ids: + type: array + items: + type: string + format: uuid + writeOnly: true + result: + type: string + readOnly: true + required: + - count + - created + - id + - ids + - modified + - name + - result + ProvisioningRequest: + type: object + properties: + bastion_operating_system: + type: + - string + - 'null' + description: Override bastion operating system provisioned and/or configured + by Liftoff + maxLength: 32 + catalog_id: + type: string + writeOnly: true + description: Catalog ID of the experience provisioned to the cluster + catalog_id_alias: + type: string + writeOnly: true + description: Catalog ID alias of the experience provisioned to the cluster + cluster: + type: + - string + - 'null' + format: uuid + description: Target a specific cluster for provisioning + collection_branch: + type: + - string + - 'null' + description: Override the Ansible collection branch initialized within the + pipeline + maxLength: 255 + experience: + type: + - string + - 'null' + format: uuid + readOnly: true + description: The experience being deployed for use + experience_branch: + type: + - string + - 'null' + description: Override the experience branch + maxLength: 255 + experience_id: + type: string + format: uuid + writeOnly: true + description: UUID of the experience provisioned to the cluster + flightcontrol_release: + type: + - string + - 'null' + description: Override the image tag used for Flight Control + maxLength: 64 + garage_id: + type: + - string + - 'null' + description: Require a cluster with nodes in the given garage + maxLength: 128 + gc_branch: + type: + - string + - 'null' + description: Override the default Ground Control branch + maxLength: 255 + gpu_alias: + type: + - string + - 'null' + description: Require a cluster with the given GPU alias + maxLength: 64 + gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster with the given number of GPUs + gpu_model: + type: + - string + - 'null' + description: Require a cluster with the given GPU model + maxLength: 32 + gpu_os_name: + type: + - string + - 'null' + description: Override the GPU node operating system name + maxLength: 16 + gpu_os_release: + type: + - string + - 'null' + description: Override the GPU node operating system release + maxLength: 16 + gpu_os_version: + type: + - string + - 'null' + description: Override the GPU node operating system version + maxLength: 8 + min_gpu_count: + type: integer + maximum: 512 + minimum: 0 + description: Require a cluster whose GPU count is greater than or equal + to the given number + node_count: + type: integer + maximum: 2147483647 + minimum: 0 + description: Require a cluster with the given number of nodes + oem_name: + type: + - string + - 'null' + description: Require a cluster manufactured by the given OEM name + maxLength: 64 + persist_on_failure: + type: + - boolean + - 'null' + description: Override the default cleanup/destroy behavior when a provisioning + failure occurs + persona: + type: + - string + - 'null' + description: Override the defined persona in the experience + maxLength: 32 + pipeline: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + description: Override the pipeline ID that will be triggered for request + fulfillment + pipeline_branch: + type: + - string + - 'null' + description: Override the default pipeline branch ref used when triggering + a Fuselage pipeline + maxLength: 255 + platform: + description: |- + Override the default platform selection + + * `air` - NVIDIA Air + * `flight_deck` - Flight Deck + * `kvm_bastion` - KVM Bastion + * `lp-vmware-platform` - lp-vmware-platform + * `minimal` - minimal + * `openshift` - OpenShift + * `proxmox` - Proxmox + * `vsphere` - vSphere + * `vsphere_horizon` - VMware Horizon + * `vsphere7` - vSphere 7 + * `vsphere8` - vSphere 8 + oneOf: + - $ref: '#/components/schemas/PlatformEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + provider_name: + type: + - string + - 'null' + description: Require a cluster from the given provider name + maxLength: 64 + region: + type: + - string + - 'null' + description: Require a cluster located in the given region + maxLength: 64 + request_id: + type: string + description: 'Trial request ID (ex: TRY-1234)' + maxLength: 32 + runtime: + type: + - string + - 'null' + format: uuid + description: Use the presets of the given runtime when provisioning this + experience + runtime_branch: + type: + - string + - 'null' + description: Override the runtime repository branch + maxLength: 255 + runtime_cns_addon_pack: + type: + - boolean + - 'null' + description: Override the runtime's CNS add-ons flag + runtime_cns_docker: + type: + - boolean + - 'null' + description: Override the runtime's Docker with CNS flag + runtime_cns_driver_version: + type: + - string + - 'null' + description: Override the runtime's GPU driver version + maxLength: 11 + runtime_cns_k8s: + type: + - boolean + - 'null' + description: Override the runtime's Kubernetes with CNS flag + runtime_cns_nvidia_driver: + type: + - boolean + - 'null' + description: Override the runtime's NVIDIA driver with CNS flag + runtime_cns_version: + type: + - string + - 'null' + description: Override the runtime's Cloud Native Stack version + maxLength: 11 + runtime_mig: + type: + - boolean + - 'null' + description: Override the runtime's MIG support with CNS flag + runtime_mig_profile: + type: + - string + - 'null' + description: Override the runtime's MIG profile name + maxLength: 32 + runtime_url: + type: + - string + - 'null' + format: uri + description: Override the URL of the runtime repository + maxLength: 200 + workshop: + type: + - boolean + - 'null' + description: Require a cluster whose workshop flag is set + workshop_id: + type: + - string + - 'null' + description: Require a cluster with the given workshop ID + maxLength: 64 + workshop_override_password: + type: + - string + - 'null' + description: Override the deployment's default authentication to use a static + password. This is useful for workshops when you'd like an identical password + associated with a collection of environments. (LaunchPad Team only) + maxLength: 64 + required: + - experience + - request_id + ProvisioningStateEnum: + enum: + - deployed + - deploying + - destroying + - pending + - ready + - reserved + - unprovisioned + type: string + description: |- + * `deployed` - Cluster is in use by a deployment + * `deploying` - Provisioning is in progress + * `destroying` - Cluster is being destroyed + * `pending` - Provisioning will begin soon + * `ready` - Provisioning has completed and is ready for a deployment + * `reserved` - Cluster is unprovisioned but reserved for later use + * `unprovisioned` - Cluster has not yet been provisioned + PublishedEnum: + enum: + - draft + - 'no' + - 'yes' + type: string + description: |- + * `draft` - draft + * `no` - no + * `yes` - yes + Runtime: + type: object + properties: + branch: + type: string + description: Runtime repository branch + maxLength: 255 + cns_addon_pack: + type: boolean + description: Include CNS add-ons? + cns_docker: + type: boolean + description: Include Docker with CNS? + cns_driver_version: + type: + - string + - 'null' + description: GPU driver version + maxLength: 11 + cns_k8s: + type: boolean + description: Include Kubernetes with CNS? + cns_nvidia_driver: + type: boolean + description: Include NVIDIA driver with CNS? + cns_version: + type: + - string + - 'null' + description: NVIDIA Cloud Native Stack version + maxLength: 11 + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: string + format: uuid + readOnly: true + mig: + type: boolean + description: Include MIG support with CNS? + mig_profile: + type: + - string + - 'null' + description: MIG profile name + maxLength: 32 + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + description: Human-readable name of the runtime + maxLength: 64 + url: + type: string + format: uri + description: URL of the runtime repository + maxLength: 200 + required: + - created + - id + - modified + - name + - url + StatusEnum: + enum: + - completed + - failed + - pending + - processing + - retrying + type: string + description: |- + * `completed` - completed + * `failed` - failed + * `pending` - pending + * `processing` - processing + * `retrying` - retrying + SystemArchEnum: + enum: + - amd64 + - arm64 + type: string + description: |- + * `amd64` - amd64 + * `arm64` - arm64 + Tenant: + type: object + properties: + id: + type: string + format: uuid + writeOnly: true + required: + - id + TypeEnum: + enum: + - nvme + - ssd + type: string + description: |- + * `nvme` - NVMe + * `ssd` - ssd + VGpuProfileChoice: + type: object + properties: + created: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was created + id: + type: integer + readOnly: true + modified: + type: string + format: date-time + readOnly: true + description: Timestamp of when the object was last modified + name: + type: string + maxLength: 64 + required: + - created + - id + - modified + - name + securitySchemes: + TokenAuthentication: + type: apiKey + in: header + name: Authorization + description: 'Authenticate with your user''s API token. Be sure to include a + prefix of "Token" (ex: "Token xxxxx").'