Skip to content

Commit f64e7a3

Browse files
committed
updates to desktop api endpoints
1 parent be2cd85 commit f64e7a3

28 files changed

+191
-1379
lines changed

docs/BatchApplicationList.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**product** | [**ProductName**](ProductName.md) | |
88
**versions** | [**list[BatchApplicationVersionDetails]**](BatchApplicationVersionDetails.md) | | [optional] [readonly]
99
**permission_to_use** | **bool** | Does your account have permission to use this application? | [optional] [readonly]
10+
**supports_cases** | **bool** | | [optional]
1011

1112
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1213

docs/CatalogApi.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Method | HTTP request | Description
99
[**catalog_clusters_list**](CatalogApi.md#catalog_clusters_list) | **GET** /catalog/clusters/ |
1010
[**catalog_clusters_read**](CatalogApi.md#catalog_clusters_read) | **GET** /catalog/clusters/{queue_code}/ |
1111
[**catalog_desktop_list**](CatalogApi.md#catalog_desktop_list) | **GET** /catalog/desktop/ |
12-
[**catalog_desktop_read**](CatalogApi.md#catalog_desktop_read) | **GET** /catalog/desktop/{id}/ |
12+
[**catalog_desktop_read**](CatalogApi.md#catalog_desktop_read) | **GET** /catalog/desktop/{node_code}/ |
1313

1414

1515
# **catalog_applications_list**
@@ -333,6 +333,8 @@ Name | Type | Description | Notes
333333
334334

335335

336+
List the available node types for desktop instances
337+
336338
### Example
337339

338340
* Api Key Authentication (Bearer):
@@ -405,9 +407,11 @@ Name | Type | Description | Notes
405407
[[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)
406408

407409
# **catalog_desktop_read**
408-
> DesktopNodeApp catalog_desktop_read(id)
410+
> DesktopNodeType catalog_desktop_read(node_code)
411+
409412

410413

414+
Get the details of the desktop node type with code node_code
411415

412416
### Example
413417

@@ -443,10 +447,10 @@ configuration = epiccore.Configuration(
443447
with epiccore.ApiClient(configuration) as api_client:
444448
# Create an instance of the API class
445449
api_instance = epiccore.CatalogApi(api_client)
446-
id = 'id_example' # str |
450+
node_code = 'node_code_example' # str |
447451

448452
try:
449-
api_response = api_instance.catalog_desktop_read(id)
453+
api_response = api_instance.catalog_desktop_read(node_code)
450454
pprint(api_response)
451455
except ApiException as e:
452456
print("Exception when calling CatalogApi->catalog_desktop_read: %s\n" % e)
@@ -456,11 +460,11 @@ with epiccore.ApiClient(configuration) as api_client:
456460

457461
Name | Type | Description | Notes
458462
------------- | ------------- | ------------- | -------------
459-
**id** | **str**| |
463+
**node_code** | **str**| |
460464

461465
### Return type
462466

463-
[**DesktopNodeApp**](DesktopNodeApp.md)
467+
[**DesktopNodeType**](DesktopNodeType.md)
464468

465469
### Authorization
466470

docs/DesktopInstance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**id** | **int** | | [optional] [readonly]
77
**status** | **str** | Current desktop status | [optional] [readonly]
8-
**connection_type** | [**DesktopNodeConnectionType**](DesktopNodeConnectionType.md) | |
98
**connection_string** | **str** | The URL or hostname of the desktop | [optional] [readonly]
10-
**application** | [**DesktopNodeApplicationVersionSummary**](DesktopNodeApplicationVersionSummary.md) | | [optional]
9+
**node_type** | [**DesktopNodeType**](DesktopNodeType.md) | | [optional]
1110
**launched_by** | **str** | Full name of user that launched the desktop | [optional] [readonly]
1211
**team** | **str** | ID of the active Team for the desktop | [optional] [readonly]
1312
**created** | **datetime** | | [optional] [readonly]
13+
**runtime** | **str** | The requested runtime in hours | [optional] [readonly]
1414

1515
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1616

docs/DesktopNodeApp.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/DesktopNodeAppSummary.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/DesktopNodeApplicationVersion.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/DesktopNodeApplicationVersionSummary.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/DesktopNodeConnectionType.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/DesktopNodeLaunchSpec.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**application_version** | **int** | ID of the application_version to launch. Valid values are obtained from the catalog/desktop/ endpoint |
7-
**node_type** | **int** | ID of the node_type. Valid values are obtained from the catalog/desktop/ endpoint |
8-
**connection_type** | **int** | The connection type to use for the Desktop |
6+
**node_code** | **str** | node_code of the node type to launch. Valid values are obtained from the catalog/desktop/ endpoint |
97
**runtime** | **int** | Runtime in hours to run this desktop node for. This is the maximum runtime as the viz node can be stopped earlier and you will only be charged for the elapsed time |
108
**secure_ip** | **bool** | Should we restrict which IPs can connect to this node? | [optional] [default to False]
119
**ip_address** | **str** | IPv4 Address to restrict connections to this node from | [optional]

docs/DesktopNodeQuote.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**application_version** | **int** | ID of the application_version to launch. Valid values are obtained from the catalog/desktop/ endpoint |
7-
**node_type** | **int** | ID of the node_type. Valid values are obtained from the catalog/desktop/ endpoint |
8-
**connection_type** | **int** | The connection type to use for the Desktop |
6+
**node_code** | **str** | node_code of the node type to launch. Valid values are obtained from the catalog/desktop/ endpoint |
97
**runtime** | **int** | Runtime in hours to run this desktop node for. This is the maximum runtime as the viz node can be stopped earlier and you will only be charged for the elapsed time |
108

119
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)