Skip to content

Commit ebaf9ed

Browse files
rushtehranirushtehrani
authored
Merge pull request #29 from onepanelio/update/0.17.0
feat: Update to v0.170.0
2 parents fb5726a + 3eaecc5 commit ebaf9ed

105 files changed

Lines changed: 1355 additions & 460 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# onepanel-sdk
2-
Onepanel API
2+
Onepanel Python SDK
33

44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

6-
- API version: 0.16.0
7-
- Package version: 0.16.0
6+
- API version: 0.17.0
7+
- Package version: 0.17.0
88
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
99
For more information, please visit [https://github.com/onepanelio/core](https://github.com/onepanelio/core)
1010

1111
## Requirements.
1212

13-
Python 2.7 and 3.4+
13+
Python 3.6+
1414

1515
## Installation & Usage
1616
### pip install
1717

18-
If the python package is hosted on a repository, you can install directly using:
18+
To install from PyPI:
1919

2020
```sh
2121
pip install onepanel-sdk
@@ -68,11 +68,10 @@ configuration = onepanel.core.api.Configuration(
6868
configuration = onepanel.core.api.Configuration(
6969
host = "http://localhost:8888",
7070
api_key = {
71-
'authorization': 'YOUR_API_KEY'
71+
'authorization': 'YOUR_ACCESS_TOKEN'
7272
}
7373
)
74-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
75-
# configuration.api_key_prefix['authorization'] = 'Bearer'
74+
configuration.api_key_prefix['authorization'] = 'Bearer'
7675

7776

7877
# Enter a context with an instance of the API client
@@ -103,11 +102,11 @@ Class | Method | HTTP request | Description
103102
*CronWorkflowServiceApi* | [**delete_cron_workflow**](docs/CronWorkflowServiceApi.md#delete_cron_workflow) | **DELETE** /apis/v1beta1/{namespace}/cron_workflows/{uid} |
104103
*CronWorkflowServiceApi* | [**get_cron_workflow**](docs/CronWorkflowServiceApi.md#get_cron_workflow) | **GET** /apis/v1beta1/{namespace}/cron_workflow/{uid} |
105104
*CronWorkflowServiceApi* | [**list_cron_workflows**](docs/CronWorkflowServiceApi.md#list_cron_workflows) | **GET** /apis/v1beta1/{namespace}/cron_workflows |
106-
*CronWorkflowServiceApi* | [**list_cron_workflows2**](docs/CronWorkflowServiceApi.md#list_cron_workflows2) | **GET** /apis/v1beta1/{namespace}/cron_workflows/{workflow_template_name} |
105+
*CronWorkflowServiceApi* | [**list_cron_workflows2**](docs/CronWorkflowServiceApi.md#list_cron_workflows2) | **GET** /apis/v1beta1/{namespace}/cron_workflows/{workflowTemplateName} |
107106
*CronWorkflowServiceApi* | [**update_cron_workflow**](docs/CronWorkflowServiceApi.md#update_cron_workflow) | **PUT** /apis/v1beta1/{namespace}/cron_workflow/{uid} |
108107
*LabelServiceApi* | [**add_labels**](docs/LabelServiceApi.md#add_labels) | **POST** /apis/v1beta1/{namespace}/{resource}/{uid}/labels |
109108
*LabelServiceApi* | [**delete_label**](docs/LabelServiceApi.md#delete_label) | **DELETE** /apis/v1beta1/{namespace}/{resource}/{uid}/labels/{key} |
110-
*LabelServiceApi* | [**get_available_labels**](docs/LabelServiceApi.md#get_available_labels) | **GET** /apis/v1beta1/labels/{namespace}/{resource}/labels |
109+
*LabelServiceApi* | [**get_available_labels**](docs/LabelServiceApi.md#get_available_labels) | **GET** /apis/v1beta1/{namespace}/{resource}/labels |
111110
*LabelServiceApi* | [**get_labels**](docs/LabelServiceApi.md#get_labels) | **GET** /apis/v1beta1/{namespace}/{resource}/{uid}/labels |
112111
*LabelServiceApi* | [**replace_labels**](docs/LabelServiceApi.md#replace_labels) | **PUT** /apis/v1beta1/{namespace}/{resource}/{uid}/labels |
113112
*NamespaceServiceApi* | [**create_namespace**](docs/NamespaceServiceApi.md#create_namespace) | **POST** /apis/v1beta1/namespaces |
@@ -124,14 +123,14 @@ Class | Method | HTTP request | Description
124123
*ServiceServiceApi* | [**list_services**](docs/ServiceServiceApi.md#list_services) | **GET** /apis/v1beta1/{namespace}/service |
125124
*WorkflowServiceApi* | [**add_workflow_execution_metrics**](docs/WorkflowServiceApi.md#add_workflow_execution_metrics) | **POST** /apis/v1beta1/{namespace}/workflow_executions/{uid}/metric |
126125
*WorkflowServiceApi* | [**add_workflow_execution_statistics**](docs/WorkflowServiceApi.md#add_workflow_execution_statistics) | **POST** /apis/v1beta1/{namespace}/workflow_executions/{uid}/statistics |
127-
*WorkflowServiceApi* | [**clone_workflow_execution**](docs/WorkflowServiceApi.md#clone_workflow_execution) | **POST** /apis/v1beta1/{namespace}/workflow_executions/{uid} |
128-
*WorkflowServiceApi* | [**create_workflow_execution**](docs/WorkflowServiceApi.md#create_workflow_execution) | **POST** /apis/v1beta1/{namespace}/workflow_executions |
126+
*WorkflowServiceApi* | [**clone_workflow_execution**](docs/WorkflowServiceApi.md#clone_workflow_execution) | **POST** /apis/v1beta1/{namespace}/workflow_executions/{uid} | Clone a Workflow. This is the same as running it again.
127+
*WorkflowServiceApi* | [**create_workflow_execution**](docs/WorkflowServiceApi.md#create_workflow_execution) | **POST** /apis/v1beta1/{namespace}/workflow_executions | Creates a Workflow
129128
*WorkflowServiceApi* | [**cron_start_workflow_execution_statistic**](docs/WorkflowServiceApi.md#cron_start_workflow_execution_statistic) | **POST** /apis/v1beta1/{namespace}/workflow_executions/{uid}/cron_start_statistics |
130129
*WorkflowServiceApi* | [**get_artifact**](docs/WorkflowServiceApi.md#get_artifact) | **GET** /apis/v1beta1/{namespace}/workflow_executions/{uid}/artifacts/{key} |
131130
*WorkflowServiceApi* | [**get_workflow_execution**](docs/WorkflowServiceApi.md#get_workflow_execution) | **GET** /apis/v1beta1/{namespace}/workflow_executions/{uid} |
132131
*WorkflowServiceApi* | [**get_workflow_execution_logs**](docs/WorkflowServiceApi.md#get_workflow_execution_logs) | **GET** /apis/v1beta1/{namespace}/workflow_executions/{uid}/pods/{podName}/containers/{containerName}/logs |
133132
*WorkflowServiceApi* | [**get_workflow_execution_metrics**](docs/WorkflowServiceApi.md#get_workflow_execution_metrics) | **GET** /apis/v1beta1/{namespace}/workflow_executions/{uid}/pods/{podName}/metrics |
134-
*WorkflowServiceApi* | [**get_workflow_execution_statistics_for_namespace**](docs/WorkflowServiceApi.md#get_workflow_execution_statistics_for_namespace) | **GET** /apis/v1beta1/{namespace}/workflow_executions/statistics |
133+
*WorkflowServiceApi* | [**get_workflow_execution_statistics_for_namespace**](docs/WorkflowServiceApi.md#get_workflow_execution_statistics_for_namespace) | **GET** /apis/v1beta1/{namespace}/workflow_execution/statistics |
135134
*WorkflowServiceApi* | [**list_files**](docs/WorkflowServiceApi.md#list_files) | **GET** /apis/v1beta1/{namespace}/workflow_executions/{uid}/files/{path} |
136135
*WorkflowServiceApi* | [**list_workflow_executions**](docs/WorkflowServiceApi.md#list_workflow_executions) | **GET** /apis/v1beta1/{namespace}/workflow_executions |
137136
*WorkflowServiceApi* | [**resubmit_workflow_execution**](docs/WorkflowServiceApi.md#resubmit_workflow_execution) | **PUT** /apis/v1beta1/{namespace}/workflow_executions/{uid}/resubmit |
@@ -144,6 +143,7 @@ Class | Method | HTTP request | Description
144143
*WorkflowTemplateServiceApi* | [**clone_workflow_template2**](docs/WorkflowTemplateServiceApi.md#clone_workflow_template2) | **GET** /apis/v1beta1/{namespace}/workflow_templates/{uid}/clone/{name}/{version} |
145144
*WorkflowTemplateServiceApi* | [**create_workflow_template**](docs/WorkflowTemplateServiceApi.md#create_workflow_template) | **POST** /apis/v1beta1/{namespace}/workflow_templates |
146145
*WorkflowTemplateServiceApi* | [**create_workflow_template_version**](docs/WorkflowTemplateServiceApi.md#create_workflow_template_version) | **POST** /apis/v1beta1/{namespace}/workflow_templates/{workflowTemplate.uid}/versions |
146+
*WorkflowTemplateServiceApi* | [**generate_workflow_template**](docs/WorkflowTemplateServiceApi.md#generate_workflow_template) | **POST** /apis/v1beta1/{namespace}/workflow_templates/{uid}/generate | Get the generated WorkflowTemplate, applying any modifications based on the content
147147
*WorkflowTemplateServiceApi* | [**get_workflow_template**](docs/WorkflowTemplateServiceApi.md#get_workflow_template) | **GET** /apis/v1beta1/{namespace}/workflow_templates/{uid} |
148148
*WorkflowTemplateServiceApi* | [**get_workflow_template2**](docs/WorkflowTemplateServiceApi.md#get_workflow_template2) | **GET** /apis/v1beta1/{namespace}/workflow_templates/{uid}/versions/{version} |
149149
*WorkflowTemplateServiceApi* | [**list_workflow_template_versions**](docs/WorkflowTemplateServiceApi.md#list_workflow_template_versions) | **GET** /apis/v1beta1/{namespace}/workflow_templates/{uid}/versions |
@@ -158,13 +158,13 @@ Class | Method | HTTP request | Description
158158
*WorkspaceServiceApi* | [**retry_last_workspace_action**](docs/WorkspaceServiceApi.md#retry_last_workspace_action) | **PUT** /apis/v1beta1/{namespace}/workspaces/{uid}/retry |
159159
*WorkspaceServiceApi* | [**update_workspace**](docs/WorkspaceServiceApi.md#update_workspace) | **PUT** /apis/v1beta1/{namespace}/workspaces/{uid} |
160160
*WorkspaceServiceApi* | [**update_workspace_status**](docs/WorkspaceServiceApi.md#update_workspace_status) | **PUT** /apis/v1beta1/{namespace}/workspaces/{uid}/status |
161-
*WorkspaceTemplateServiceApi* | [**archive_workspace_template**](docs/WorkspaceTemplateServiceApi.md#archive_workspace_template) | **PUT** /apis/v1beta1/{namespace}/workspace_templates/{uid}/archive |
162-
*WorkspaceTemplateServiceApi* | [**create_workspace_template**](docs/WorkspaceTemplateServiceApi.md#create_workspace_template) | **POST** /apis/v1beta1/{namespace}/workspace_templates |
163-
*WorkspaceTemplateServiceApi* | [**generate_workspace_template_workflow_template**](docs/WorkspaceTemplateServiceApi.md#generate_workspace_template_workflow_template) | **POST** /apis/v1beta1/{namespace}/workspace_templates/{uid}/workflow_template |
164-
*WorkspaceTemplateServiceApi* | [**get_workspace_template**](docs/WorkspaceTemplateServiceApi.md#get_workspace_template) | **GET** /apis/v1beta1/{namespace}/workspace_templates/{uid} |
161+
*WorkspaceTemplateServiceApi* | [**archive_workspace_template**](docs/WorkspaceTemplateServiceApi.md#archive_workspace_template) | **PUT** /apis/v1beta1/{namespace}/workspace_templates/{uid}/archive | Archives a WorkspaceTemplate
162+
*WorkspaceTemplateServiceApi* | [**create_workspace_template**](docs/WorkspaceTemplateServiceApi.md#create_workspace_template) | **POST** /apis/v1beta1/{namespace}/workspace_templates | Creates a WorkspaceTemplate
163+
*WorkspaceTemplateServiceApi* | [**generate_workspace_template_workflow_template**](docs/WorkspaceTemplateServiceApi.md#generate_workspace_template_workflow_template) | **POST** /apis/v1beta1/{namespace}/workspace_templates/{uid}/workflow_template | Get the generated WorkflowTemplate for a WorkspaceTemplate
164+
*WorkspaceTemplateServiceApi* | [**get_workspace_template**](docs/WorkspaceTemplateServiceApi.md#get_workspace_template) | **GET** /apis/v1beta1/{namespace}/workspace_templates/{uid} | Get a WorkspaceTemplate
165165
*WorkspaceTemplateServiceApi* | [**list_workspace_template_versions**](docs/WorkspaceTemplateServiceApi.md#list_workspace_template_versions) | **GET** /apis/v1beta1/{namespace}/workspace_templates/{uid}/versions |
166166
*WorkspaceTemplateServiceApi* | [**list_workspace_templates**](docs/WorkspaceTemplateServiceApi.md#list_workspace_templates) | **GET** /apis/v1beta1/{namespace}/workspace_templates |
167-
*WorkspaceTemplateServiceApi* | [**update_workspace_template**](docs/WorkspaceTemplateServiceApi.md#update_workspace_template) | **PUT** /apis/v1beta1/{namespace}/workspace_templates/{uid} |
167+
*WorkspaceTemplateServiceApi* | [**update_workspace_template**](docs/WorkspaceTemplateServiceApi.md#update_workspace_template) | **PUT** /apis/v1beta1/{namespace}/workspace_templates/{uid} | Updates a WorkspaceTemplate
168168

169169

170170
## Documentation For Models
@@ -188,8 +188,7 @@ Class | Method | HTTP request | Description
188188
- [GetWorkflowExecutionStatisticsForNamespaceResponse](docs/GetWorkflowExecutionStatisticsForNamespaceResponse.md)
189189
- [GetWorkspaceStatisticsForNamespaceResponse](docs/GetWorkspaceStatisticsForNamespaceResponse.md)
190190
- [GoogleProtobufAny](docs/GoogleProtobufAny.md)
191-
- [GrpcGatewayRuntimeError](docs/GrpcGatewayRuntimeError.md)
192-
- [GrpcGatewayRuntimeStreamError](docs/GrpcGatewayRuntimeStreamError.md)
191+
- [GoogleRpcStatus](docs/GoogleRpcStatus.md)
193192
- [IsAuthorized](docs/IsAuthorized.md)
194193
- [IsAuthorizedResponse](docs/IsAuthorizedResponse.md)
195194
- [IsValidTokenRequest](docs/IsValidTokenRequest.md)
@@ -208,6 +207,7 @@ Class | Method | HTTP request | Description
208207
- [ListWorkspaceTemplateVersionsResponse](docs/ListWorkspaceTemplateVersionsResponse.md)
209208
- [ListWorkspaceTemplatesResponse](docs/ListWorkspaceTemplatesResponse.md)
210209
- [LogEntry](docs/LogEntry.md)
210+
- [LogStreamResponse](docs/LogStreamResponse.md)
211211
- [Metric](docs/Metric.md)
212212
- [Namespace](docs/Namespace.md)
213213
- [NodePool](docs/NodePool.md)
@@ -218,7 +218,7 @@ Class | Method | HTTP request | Description
218218
- [SecretExistsResponse](docs/SecretExistsResponse.md)
219219
- [Service](docs/Service.md)
220220
- [Statistics](docs/Statistics.md)
221-
- [StreamResultOfLogEntry](docs/StreamResultOfLogEntry.md)
221+
- [StreamResultOfLogStreamResponse](docs/StreamResultOfLogStreamResponse.md)
222222
- [StreamResultOfWorkflowExecution](docs/StreamResultOfWorkflowExecution.md)
223223
- [UpdateSecretKeyValueResponse](docs/UpdateSecretKeyValueResponse.md)
224224
- [UpdateWorkflowExecutionsMetricsRequest](docs/UpdateWorkflowExecutionsMetricsRequest.md)
@@ -249,4 +249,3 @@ Class | Method | HTTP request | Description
249249

250250

251251

252-

‎docs/AuthServiceApi.md‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,10 @@ configuration = onepanel.core.api.Configuration(
3838
configuration = onepanel.core.api.Configuration(
3939
host = "http://localhost:8888",
4040
api_key = {
41-
'authorization': 'YOUR_API_KEY'
41+
'authorization': 'YOUR_ACCESS_TOKEN'
4242
}
4343
)
44-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
45-
# configuration.api_key_prefix['authorization'] = 'Bearer'
44+
configuration.api_key_prefix['authorization'] = 'Bearer'
4645

4746
# Enter a context with an instance of the API client
4847
with onepanel.core.api.ApiClient(configuration) as api_client:
@@ -80,7 +79,7 @@ Name | Type | Description | Notes
8079
| Status code | Description | Response headers |
8180
|-------------|-------------|------------------|
8281
**200** | A successful response. | - |
83-
**0** | An unexpected error response | - |
82+
**0** | An unexpected error response. | - |
8483

8584
[[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)
8685

@@ -113,11 +112,10 @@ configuration = onepanel.core.api.Configuration(
113112
configuration = onepanel.core.api.Configuration(
114113
host = "http://localhost:8888",
115114
api_key = {
116-
'authorization': 'YOUR_API_KEY'
115+
'authorization': 'YOUR_ACCESS_TOKEN'
117116
}
118117
)
119-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
120-
# configuration.api_key_prefix['authorization'] = 'Bearer'
118+
configuration.api_key_prefix['authorization'] = 'Bearer'
121119

122120
# Enter a context with an instance of the API client
123121
with onepanel.core.api.ApiClient(configuration) as api_client:
@@ -155,7 +153,7 @@ Name | Type | Description | Notes
155153
| Status code | Description | Response headers |
156154
|-------------|-------------|------------------|
157155
**200** | A successful response. | - |
158-
**0** | An unexpected error response | - |
156+
**0** | An unexpected error response. | - |
159157

160158
[[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)
161159

@@ -188,11 +186,10 @@ configuration = onepanel.core.api.Configuration(
188186
configuration = onepanel.core.api.Configuration(
189187
host = "http://localhost:8888",
190188
api_key = {
191-
'authorization': 'YOUR_API_KEY'
189+
'authorization': 'YOUR_ACCESS_TOKEN'
192190
}
193191
)
194-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
195-
# configuration.api_key_prefix['authorization'] = 'Bearer'
192+
configuration.api_key_prefix['authorization'] = 'Bearer'
196193

197194
# Enter a context with an instance of the API client
198195
with onepanel.core.api.ApiClient(configuration) as api_client:
@@ -230,7 +227,7 @@ Name | Type | Description | Notes
230227
| Status code | Description | Response headers |
231228
|-------------|-------------|------------------|
232229
**200** | A successful response. | - |
233-
**0** | An unexpected error response | - |
230+
**0** | An unexpected error response. | - |
234231

235232
[[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)
236233

‎docs/ConfigServiceApi.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,10 @@ configuration = onepanel.core.api.Configuration(
3636
configuration = onepanel.core.api.Configuration(
3737
host = "http://localhost:8888",
3838
api_key = {
39-
'authorization': 'YOUR_API_KEY'
39+
'authorization': 'YOUR_ACCESS_TOKEN'
4040
}
4141
)
42-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
43-
# configuration.api_key_prefix['authorization'] = 'Bearer'
42+
configuration.api_key_prefix['authorization'] = 'Bearer'
4443

4544
# Enter a context with an instance of the API client
4645
with onepanel.core.api.ApiClient(configuration) as api_client:
@@ -74,7 +73,7 @@ This endpoint does not need any parameter.
7473
| Status code | Description | Response headers |
7574
|-------------|-------------|------------------|
7675
**200** | A successful response. | - |
77-
**0** | An unexpected error response | - |
76+
**0** | An unexpected error response. | - |
7877

7978
[[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)
8079

0 commit comments

Comments
 (0)