cosmotech-api 3.2.0.post1__py3-none-any.whl → 5.0.0rc3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- cosmotech_api/__init__.py +180 -130
- cosmotech_api/api/__init__.py +1 -4
- cosmotech_api/api/connector_api.py +31 -27
- cosmotech_api/api/dataset_api.py +1762 -3918
- cosmotech_api/api/meta_api.py +281 -0
- cosmotech_api/api/organization_api.py +654 -1460
- cosmotech_api/api/run_api.py +170 -817
- cosmotech_api/api/runner_api.py +688 -631
- cosmotech_api/api/scenario_api.py +141 -121
- cosmotech_api/api/scenariorun_api.py +76 -66
- cosmotech_api/api/scenariorunresult_api.py +341 -659
- cosmotech_api/api/solution_api.py +2504 -956
- cosmotech_api/api/twingraph_api.py +83 -72
- cosmotech_api/api/validator_api.py +1249 -2501
- cosmotech_api/api/workspace_api.py +835 -1658
- cosmotech_api/api_client.py +79 -33
- cosmotech_api/configuration.py +185 -48
- cosmotech_api/exceptions.py +18 -1
- cosmotech_api/model/component_role_permissions.py +1 -1
- cosmotech_api/model/connector.py +1 -1
- cosmotech_api/model/connector_parameter.py +1 -1
- cosmotech_api/model/connector_parameter_group.py +1 -1
- cosmotech_api/model/container_resource_size_info.py +1 -1
- cosmotech_api/model/container_resource_sizing.py +1 -1
- cosmotech_api/model/dataset.py +1 -1
- cosmotech_api/model/dataset_access_control.py +1 -1
- cosmotech_api/model/dataset_compatibility.py +1 -1
- cosmotech_api/model/dataset_connector.py +1 -1
- cosmotech_api/model/dataset_copy_parameters.py +1 -1
- cosmotech_api/model/dataset_role.py +1 -1
- cosmotech_api/model/dataset_search.py +1 -1
- cosmotech_api/model/dataset_security.py +1 -1
- cosmotech_api/model/dataset_source_type.py +1 -1
- cosmotech_api/model/dataset_twin_graph_hash.py +1 -1
- cosmotech_api/model/dataset_twin_graph_info.py +1 -1
- cosmotech_api/model/dataset_twin_graph_query.py +1 -1
- cosmotech_api/model/delete_historical_data.py +1 -1
- cosmotech_api/model/file_upload_metadata.py +1 -1
- cosmotech_api/model/file_upload_validation.py +1 -1
- cosmotech_api/model/graph_properties.py +1 -1
- cosmotech_api/model/organization.py +1 -1
- cosmotech_api/model/organization_access_control.py +1 -1
- cosmotech_api/model/organization_role.py +1 -1
- cosmotech_api/model/organization_security.py +1 -1
- cosmotech_api/model/organization_service.py +1 -1
- cosmotech_api/model/organization_services.py +1 -1
- cosmotech_api/model/resource_size_info.py +1 -1
- cosmotech_api/model/run.py +1 -1
- cosmotech_api/model/run_container.py +1 -1
- cosmotech_api/model/run_container_artifact.py +1 -1
- cosmotech_api/model/run_container_logs.py +1 -1
- cosmotech_api/model/run_logs.py +1 -1
- cosmotech_api/model/run_resource_requested.py +1 -1
- cosmotech_api/model/run_search.py +1 -1
- cosmotech_api/model/run_start_containers.py +1 -1
- cosmotech_api/model/run_state.py +1 -1
- cosmotech_api/model/run_status.py +1 -1
- cosmotech_api/model/run_status_node.py +1 -1
- cosmotech_api/model/run_template.py +1 -1
- cosmotech_api/model/run_template_handler_id.py +1 -1
- cosmotech_api/model/run_template_orchestrator.py +1 -1
- cosmotech_api/model/run_template_parameter.py +1 -1
- cosmotech_api/model/run_template_parameter_group.py +1 -1
- cosmotech_api/model/run_template_parameter_value.py +1 -1
- cosmotech_api/model/run_template_resource_sizing.py +1 -1
- cosmotech_api/model/run_template_step_source.py +1 -1
- cosmotech_api/model/runner.py +1 -1
- cosmotech_api/model/runner_access_control.py +1 -1
- cosmotech_api/model/runner_changed_parameter_value.py +1 -1
- cosmotech_api/model/runner_comparison_result.py +1 -1
- cosmotech_api/model/runner_data_download_info.py +1 -1
- cosmotech_api/model/runner_data_download_job.py +1 -1
- cosmotech_api/model/runner_job_state.py +1 -1
- cosmotech_api/model/runner_last_run.py +1 -1
- cosmotech_api/model/runner_resource_sizing.py +1 -1
- cosmotech_api/model/runner_role.py +1 -1
- cosmotech_api/model/runner_run_template_parameter_value.py +1 -1
- cosmotech_api/model/runner_security.py +1 -1
- cosmotech_api/model/runner_validation_status.py +1 -1
- cosmotech_api/model/scenario.py +1 -1
- cosmotech_api/model/scenario_access_control.py +1 -1
- cosmotech_api/model/scenario_changed_parameter_value.py +1 -1
- cosmotech_api/model/scenario_comparison_result.py +1 -1
- cosmotech_api/model/scenario_data_download_info.py +1 -1
- cosmotech_api/model/scenario_data_download_job.py +1 -1
- cosmotech_api/model/scenario_job_state.py +1 -1
- cosmotech_api/model/scenario_last_run.py +1 -1
- cosmotech_api/model/scenario_resource_sizing.py +1 -1
- cosmotech_api/model/scenario_role.py +1 -1
- cosmotech_api/model/scenario_run.py +1 -1
- cosmotech_api/model/scenario_run_container.py +1 -1
- cosmotech_api/model/scenario_run_container_artifact.py +1 -1
- cosmotech_api/model/scenario_run_container_logs.py +1 -1
- cosmotech_api/model/scenario_run_logs.py +1 -1
- cosmotech_api/model/scenario_run_resource_requested.py +1 -1
- cosmotech_api/model/scenario_run_result.py +1 -1
- cosmotech_api/model/scenario_run_search.py +1 -1
- cosmotech_api/model/scenario_run_start_containers.py +1 -1
- cosmotech_api/model/scenario_run_state.py +1 -1
- cosmotech_api/model/scenario_run_status.py +1 -1
- cosmotech_api/model/scenario_run_status_node.py +1 -1
- cosmotech_api/model/scenario_run_template_parameter_value.py +1 -1
- cosmotech_api/model/scenario_security.py +1 -1
- cosmotech_api/model/scenario_validation_status.py +1 -1
- cosmotech_api/model/solution.py +1 -1
- cosmotech_api/model/solution_access_control.py +1 -1
- cosmotech_api/model/solution_role.py +1 -1
- cosmotech_api/model/solution_security.py +1 -1
- cosmotech_api/model/source_info.py +1 -1
- cosmotech_api/model/sub_dataset_graph_query.py +1 -1
- cosmotech_api/model/translated_labels.py +1 -1
- cosmotech_api/model/twin_graph_batch_result.py +1 -1
- cosmotech_api/model/twin_graph_hash.py +1 -1
- cosmotech_api/model/twin_graph_query.py +1 -1
- cosmotech_api/model/validator.py +1 -1
- cosmotech_api/model/validator_run.py +1 -1
- cosmotech_api/model/workspace.py +1 -1
- cosmotech_api/model/workspace_access_control.py +1 -1
- cosmotech_api/model/workspace_file.py +1 -1
- cosmotech_api/model/workspace_role.py +1 -1
- cosmotech_api/model/workspace_secret.py +1 -1
- cosmotech_api/model/workspace_security.py +1 -1
- cosmotech_api/model/workspace_solution.py +1 -1
- cosmotech_api/model/workspace_web_app.py +1 -1
- cosmotech_api/model_utils.py +1 -1
- cosmotech_api/models/__init__.py +33 -72
- cosmotech_api/models/about_info.py +92 -0
- cosmotech_api/models/about_info_version.py +100 -0
- cosmotech_api/models/component_role_permissions.py +11 -11
- cosmotech_api/models/connector.py +12 -22
- cosmotech_api/models/connector_parameter.py +7 -7
- cosmotech_api/models/connector_parameter_group.py +10 -10
- cosmotech_api/models/container_resource_size_info.py +7 -7
- cosmotech_api/models/container_resource_sizing.py +7 -7
- cosmotech_api/models/create_info.py +103 -0
- cosmotech_api/models/created_run.py +88 -0
- cosmotech_api/models/dataset.py +47 -103
- cosmotech_api/models/dataset_access_control.py +7 -7
- cosmotech_api/models/dataset_compatibility.py +7 -7
- cosmotech_api/models/dataset_connector.py +7 -7
- cosmotech_api/models/dataset_copy_parameters.py +7 -7
- cosmotech_api/models/dataset_create_info.py +103 -0
- cosmotech_api/models/dataset_create_request.py +111 -0
- cosmotech_api/models/dataset_edit_info.py +90 -0
- cosmotech_api/models/dataset_part.py +132 -0
- cosmotech_api/models/dataset_part_create_request.py +100 -0
- cosmotech_api/models/dataset_part_type_enum.py +38 -0
- cosmotech_api/models/dataset_part_update_request.py +95 -0
- cosmotech_api/models/dataset_role.py +7 -7
- cosmotech_api/models/dataset_search.py +7 -7
- cosmotech_api/models/dataset_security.py +10 -10
- cosmotech_api/models/dataset_source_type.py +1 -1
- cosmotech_api/models/dataset_twin_graph_hash.py +7 -7
- cosmotech_api/models/dataset_twin_graph_info.py +7 -7
- cosmotech_api/models/dataset_twin_graph_query.py +7 -7
- cosmotech_api/models/dataset_update_request.py +105 -0
- cosmotech_api/models/delete_historical_data.py +7 -7
- cosmotech_api/models/edit_info.py +90 -0
- cosmotech_api/models/file_upload_metadata.py +7 -7
- cosmotech_api/models/file_upload_validation.py +13 -13
- cosmotech_api/models/graph_properties.py +7 -7
- cosmotech_api/models/ingestion_status_enum.py +40 -0
- cosmotech_api/models/io_types_enum.py +38 -0
- cosmotech_api/models/last_run_info.py +100 -0
- cosmotech_api/models/organization.py +24 -23
- cosmotech_api/models/organization_access_control.py +10 -10
- cosmotech_api/models/organization_create_request.py +95 -0
- cosmotech_api/models/organization_edit_info.py +90 -0
- cosmotech_api/models/organization_role.py +9 -9
- cosmotech_api/models/organization_security.py +13 -13
- cosmotech_api/models/organization_service.py +7 -7
- cosmotech_api/models/organization_services.py +7 -7
- cosmotech_api/models/organization_update_request.py +89 -0
- cosmotech_api/models/query_result.py +7 -7
- cosmotech_api/models/resource_size_info.py +7 -7
- cosmotech_api/models/run.py +20 -22
- cosmotech_api/models/run_container.py +9 -19
- cosmotech_api/models/run_container_artifact.py +7 -7
- cosmotech_api/models/run_container_logs.py +7 -7
- cosmotech_api/models/run_data.py +7 -7
- cosmotech_api/models/run_data_query.py +7 -7
- cosmotech_api/models/run_edit_info.py +90 -0
- cosmotech_api/models/run_logs.py +10 -10
- cosmotech_api/models/run_logs_entry.py +88 -0
- cosmotech_api/models/run_resource_requested.py +7 -7
- cosmotech_api/models/run_search.py +9 -18
- cosmotech_api/models/run_search_state.py +46 -0
- cosmotech_api/models/run_start_containers.py +10 -10
- cosmotech_api/models/run_state.py +2 -1
- cosmotech_api/models/run_status.py +17 -11
- cosmotech_api/models/run_status_node.py +7 -7
- cosmotech_api/models/run_template.py +20 -75
- cosmotech_api/models/run_template_create_request.py +109 -0
- cosmotech_api/models/run_template_handler_id.py +1 -1
- cosmotech_api/models/run_template_orchestrator.py +1 -1
- cosmotech_api/models/run_template_parameter.py +21 -20
- cosmotech_api/models/run_template_parameter_create_request.py +103 -0
- cosmotech_api/models/run_template_parameter_group.py +17 -18
- cosmotech_api/models/run_template_parameter_group_create_request.py +97 -0
- cosmotech_api/models/run_template_parameter_group_update_request.py +94 -0
- cosmotech_api/models/run_template_parameter_update_request.py +101 -0
- cosmotech_api/models/run_template_parameter_value.py +7 -7
- cosmotech_api/models/run_template_resource_sizing.py +8 -8
- cosmotech_api/models/run_template_step_source.py +1 -1
- cosmotech_api/models/run_template_update_request.py +107 -0
- cosmotech_api/models/runner.py +48 -62
- cosmotech_api/models/runner_access_control.py +7 -7
- cosmotech_api/models/runner_changed_parameter_value.py +7 -7
- cosmotech_api/models/runner_comparison_result.py +10 -10
- cosmotech_api/models/runner_create_request.py +146 -0
- cosmotech_api/models/runner_data_download_info.py +7 -7
- cosmotech_api/models/runner_data_download_job.py +7 -7
- cosmotech_api/models/runner_datasets.py +92 -0
- cosmotech_api/models/runner_edit_info.py +90 -0
- cosmotech_api/models/runner_job_state.py +1 -1
- cosmotech_api/models/runner_last_run.py +7 -7
- cosmotech_api/models/runner_parent_last_run.py +7 -7
- cosmotech_api/models/runner_resource_sizing.py +7 -7
- cosmotech_api/models/runner_role.py +7 -7
- cosmotech_api/models/runner_root_last_run.py +7 -7
- cosmotech_api/models/runner_run_template_parameter_value.py +7 -9
- cosmotech_api/models/runner_security.py +10 -10
- cosmotech_api/models/runner_update_request.py +119 -0
- cosmotech_api/models/runner_validation_status.py +1 -1
- cosmotech_api/models/scenario.py +10 -10
- cosmotech_api/models/scenario_access_control.py +7 -7
- cosmotech_api/models/scenario_changed_parameter_value.py +7 -7
- cosmotech_api/models/scenario_comparison_result.py +10 -10
- cosmotech_api/models/scenario_data_download_info.py +7 -7
- cosmotech_api/models/scenario_data_download_job.py +7 -7
- cosmotech_api/models/scenario_job_state.py +1 -1
- cosmotech_api/models/scenario_last_run.py +7 -7
- cosmotech_api/models/scenario_resource_sizing.py +7 -7
- cosmotech_api/models/scenario_role.py +7 -7
- cosmotech_api/models/scenario_run.py +13 -13
- cosmotech_api/models/scenario_run_container.py +10 -10
- cosmotech_api/models/scenario_run_container_artifact.py +7 -7
- cosmotech_api/models/scenario_run_container_logs.py +7 -7
- cosmotech_api/models/scenario_run_logs.py +10 -10
- cosmotech_api/models/scenario_run_resource_requested.py +7 -7
- cosmotech_api/models/scenario_run_search.py +9 -18
- cosmotech_api/models/scenario_run_search_state.py +46 -0
- cosmotech_api/models/scenario_run_start_containers.py +10 -10
- cosmotech_api/models/scenario_run_state.py +1 -1
- cosmotech_api/models/scenario_run_status.py +10 -10
- cosmotech_api/models/scenario_run_status_node.py +7 -7
- cosmotech_api/models/scenario_run_template_parameter_value.py +7 -7
- cosmotech_api/models/scenario_security.py +10 -10
- cosmotech_api/models/scenario_validation_status.py +1 -1
- cosmotech_api/models/send_run_data_request.py +7 -7
- cosmotech_api/models/solution.py +60 -44
- cosmotech_api/models/solution_access_control.py +10 -10
- cosmotech_api/models/solution_create_request.py +139 -0
- cosmotech_api/models/solution_edit_info.py +90 -0
- cosmotech_api/models/solution_file.py +88 -0
- cosmotech_api/models/solution_role.py +9 -9
- cosmotech_api/models/solution_security.py +13 -13
- cosmotech_api/models/solution_update_request.py +133 -0
- cosmotech_api/models/source_info.py +7 -7
- cosmotech_api/models/sub_dataset_graph_query.py +7 -7
- cosmotech_api/models/twin_graph_batch_result.py +7 -7
- cosmotech_api/models/twin_graph_hash.py +7 -7
- cosmotech_api/models/twin_graph_query.py +7 -7
- cosmotech_api/models/twincache_status_enum.py +38 -0
- cosmotech_api/models/validator.py +7 -7
- cosmotech_api/models/workspace.py +46 -42
- cosmotech_api/models/workspace_access_control.py +10 -10
- cosmotech_api/models/workspace_create_request.py +113 -0
- cosmotech_api/models/workspace_edit_info.py +90 -0
- cosmotech_api/models/workspace_file.py +10 -10
- cosmotech_api/models/workspace_role.py +9 -9
- cosmotech_api/models/workspace_secret.py +7 -7
- cosmotech_api/models/workspace_security.py +13 -13
- cosmotech_api/models/workspace_solution.py +33 -15
- cosmotech_api/models/workspace_update_request.py +105 -0
- cosmotech_api/models/workspace_web_app.py +7 -7
- cosmotech_api/rest.py +5 -2
- cosmotech_api-5.0.0rc3.dist-info/METADATA +314 -0
- cosmotech_api-5.0.0rc3.dist-info/RECORD +297 -0
- {cosmotech_api-3.2.0.post1.dist-info → cosmotech_api-5.0.0rc3.dist-info}/WHEEL +1 -1
- {cosmotech_api-3.2.0.post1.dist-info → cosmotech_api-5.0.0rc3.dist-info/licenses}/LICENSE +1 -1
- cosmotech_api-3.2.0.post1.dist-info/METADATA +0 -18
- cosmotech_api-3.2.0.post1.dist-info/RECORD +0 -255
- {cosmotech_api-3.2.0.post1.dist-info → cosmotech_api-5.0.0rc3.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Cosmo Tech Platform API
|
|
5
|
+
|
|
6
|
+
Cosmo Tech Platform API
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 5.0.0-rc3
|
|
9
|
+
Contact: platform@cosmotech.com
|
|
10
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
|
+
|
|
12
|
+
Do not edit the class manually.
|
|
13
|
+
""" # noqa: E501
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
from __future__ import annotations
|
|
17
|
+
import pprint
|
|
18
|
+
import re # noqa: F401
|
|
19
|
+
import json
|
|
20
|
+
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
|
|
22
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
|
+
from typing_extensions import Annotated
|
|
24
|
+
from cosmotech_api.models.workspace_solution import WorkspaceSolution
|
|
25
|
+
from typing import Optional, Set
|
|
26
|
+
from typing_extensions import Self
|
|
27
|
+
|
|
28
|
+
class WorkspaceUpdateRequest(BaseModel):
|
|
29
|
+
"""
|
|
30
|
+
Request object for updating a workspace
|
|
31
|
+
""" # noqa: E501
|
|
32
|
+
key: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="Technical key for resource name convention and version grouping. Must be unique")
|
|
33
|
+
name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="Workspace name")
|
|
34
|
+
description: Optional[StrictStr] = Field(default=None, description="The Workspace description")
|
|
35
|
+
tags: Optional[List[StrictStr]] = Field(default=None, description="The list of tags")
|
|
36
|
+
solution: Optional[WorkspaceSolution] = None
|
|
37
|
+
additional_data: Optional[Dict[str, Any]] = Field(default=None, description="Free form additional data", alias="additionalData")
|
|
38
|
+
dataset_copy: Optional[StrictBool] = Field(default=None, description="Activate the copy of dataset on scenario creation", alias="datasetCopy")
|
|
39
|
+
__properties: ClassVar[List[str]] = ["key", "name", "description", "tags", "solution", "additionalData", "datasetCopy"]
|
|
40
|
+
|
|
41
|
+
model_config = ConfigDict(
|
|
42
|
+
populate_by_name=True,
|
|
43
|
+
validate_assignment=True,
|
|
44
|
+
protected_namespaces=(),
|
|
45
|
+
)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def to_str(self) -> str:
|
|
49
|
+
"""Returns the string representation of the model using alias"""
|
|
50
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
51
|
+
|
|
52
|
+
def to_json(self) -> str:
|
|
53
|
+
"""Returns the JSON representation of the model using alias"""
|
|
54
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
55
|
+
return json.dumps(self.to_dict())
|
|
56
|
+
|
|
57
|
+
@classmethod
|
|
58
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
59
|
+
"""Create an instance of WorkspaceUpdateRequest from a JSON string"""
|
|
60
|
+
return cls.from_dict(json.loads(json_str))
|
|
61
|
+
|
|
62
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
63
|
+
"""Return the dictionary representation of the model using alias.
|
|
64
|
+
|
|
65
|
+
This has the following differences from calling pydantic's
|
|
66
|
+
`self.model_dump(by_alias=True)`:
|
|
67
|
+
|
|
68
|
+
* `None` is only added to the output dict for nullable fields that
|
|
69
|
+
were set at model initialization. Other fields with value `None`
|
|
70
|
+
are ignored.
|
|
71
|
+
"""
|
|
72
|
+
excluded_fields: Set[str] = set([
|
|
73
|
+
])
|
|
74
|
+
|
|
75
|
+
_dict = self.model_dump(
|
|
76
|
+
by_alias=True,
|
|
77
|
+
exclude=excluded_fields,
|
|
78
|
+
exclude_none=True,
|
|
79
|
+
)
|
|
80
|
+
# override the default output from pydantic by calling `to_dict()` of solution
|
|
81
|
+
if self.solution:
|
|
82
|
+
_dict['solution'] = self.solution.to_dict()
|
|
83
|
+
return _dict
|
|
84
|
+
|
|
85
|
+
@classmethod
|
|
86
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
87
|
+
"""Create an instance of WorkspaceUpdateRequest from a dict"""
|
|
88
|
+
if obj is None:
|
|
89
|
+
return None
|
|
90
|
+
|
|
91
|
+
if not isinstance(obj, dict):
|
|
92
|
+
return cls.model_validate(obj)
|
|
93
|
+
|
|
94
|
+
_obj = cls.model_validate({
|
|
95
|
+
"key": obj.get("key"),
|
|
96
|
+
"name": obj.get("name"),
|
|
97
|
+
"description": obj.get("description"),
|
|
98
|
+
"tags": obj.get("tags"),
|
|
99
|
+
"solution": WorkspaceSolution.from_dict(obj["solution"]) if obj.get("solution") is not None else None,
|
|
100
|
+
"additionalData": obj.get("additionalData"),
|
|
101
|
+
"datasetCopy": obj.get("datasetCopy")
|
|
102
|
+
})
|
|
103
|
+
return _obj
|
|
104
|
+
|
|
105
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Cosmo Tech Platform API
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 3.
|
|
8
|
+
The version of the OpenAPI document: 3.3.6
|
|
9
9
|
Contact: platform@cosmotech.com
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -18,7 +18,7 @@ import pprint
|
|
|
18
18
|
import re # noqa: F401
|
|
19
19
|
import json
|
|
20
20
|
|
|
21
|
-
from pydantic import BaseModel, Field, StrictStr
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictStr
|
|
22
22
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
23
23
|
from typing import Optional, Set
|
|
24
24
|
from typing_extensions import Self
|
|
@@ -32,11 +32,11 @@ class WorkspaceWebApp(BaseModel):
|
|
|
32
32
|
options: Optional[Dict[str, Any]] = Field(default=None, description="free form options for Web Application")
|
|
33
33
|
__properties: ClassVar[List[str]] = ["url", "iframes", "options"]
|
|
34
34
|
|
|
35
|
-
model_config =
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
35
|
+
model_config = ConfigDict(
|
|
36
|
+
populate_by_name=True,
|
|
37
|
+
validate_assignment=True,
|
|
38
|
+
protected_namespaces=(),
|
|
39
|
+
)
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
def to_str(self) -> str:
|
cosmotech_api/rest.py
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Cosmo Tech Platform API
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document:
|
|
8
|
+
The version of the OpenAPI document: 5.0.0-rc3
|
|
9
9
|
Contact: platform@cosmotech.com
|
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
11
|
|
|
@@ -77,6 +77,7 @@ class RESTClientObject:
|
|
|
77
77
|
"ca_certs": configuration.ssl_ca_cert,
|
|
78
78
|
"cert_file": configuration.cert_file,
|
|
79
79
|
"key_file": configuration.key_file,
|
|
80
|
+
"ca_cert_data": configuration.ca_cert_data,
|
|
80
81
|
}
|
|
81
82
|
if configuration.assert_hostname is not None:
|
|
82
83
|
pool_args['assert_hostname'] = (
|
|
@@ -203,6 +204,8 @@ class RESTClientObject:
|
|
|
203
204
|
# Content-Type which generated by urllib3 will be
|
|
204
205
|
# overwritten.
|
|
205
206
|
del headers['Content-Type']
|
|
207
|
+
# Ensures that dict objects are serialized
|
|
208
|
+
post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
|
|
206
209
|
r = self.pool_manager.request(
|
|
207
210
|
method,
|
|
208
211
|
url,
|
|
@@ -224,7 +227,7 @@ class RESTClientObject:
|
|
|
224
227
|
headers=headers,
|
|
225
228
|
preload_content=False
|
|
226
229
|
)
|
|
227
|
-
elif headers['Content-Type']
|
|
230
|
+
elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
|
|
228
231
|
request_body = "true" if body else "false"
|
|
229
232
|
r = self.pool_manager.request(
|
|
230
233
|
method,
|
|
@@ -0,0 +1,314 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: cosmotech_api
|
|
3
|
+
Version: 5.0.0rc3
|
|
4
|
+
Summary: Cosmo Tech Platform API
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: Repository
|
|
7
|
+
Author-email: Repository <platform@cosmotech.com>
|
|
8
|
+
License: MIT License
|
|
9
|
+
Project-URL: Repository, https://github.com/Cosmo-Tech/cosmotech-api-python-client
|
|
10
|
+
Keywords: OpenAPI,OpenAPI-Generator,Cosmo Tech Platform API
|
|
11
|
+
Requires-Python: >=3.9
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: urllib3<3.0.0,>=2.1.0
|
|
15
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
16
|
+
Requires-Dist: pydantic>=2
|
|
17
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
18
|
+
Dynamic: author
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# cosmotech-api
|
|
22
|
+
Cosmo Tech Platform API
|
|
23
|
+
|
|
24
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
25
|
+
|
|
26
|
+
- API version: 5.0.0-rc3
|
|
27
|
+
- Package version: 1.0.0
|
|
28
|
+
- Generator version: 7.17.0
|
|
29
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
30
|
+
For more information, please visit [https://github.com/Cosmo-Tech/cosmotech-api](https://github.com/Cosmo-Tech/cosmotech-api)
|
|
31
|
+
|
|
32
|
+
## Requirements.
|
|
33
|
+
|
|
34
|
+
Python 3.9+
|
|
35
|
+
|
|
36
|
+
## Installation & Usage
|
|
37
|
+
### pip install
|
|
38
|
+
|
|
39
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
pip install git+https://github.com/Cosmo-Tech/cosmotech-api-python-client.git
|
|
43
|
+
```
|
|
44
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/Cosmo-Tech/cosmotech-api-python-client.git`)
|
|
45
|
+
|
|
46
|
+
Then import the package:
|
|
47
|
+
```python
|
|
48
|
+
import cosmotech_api
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Setuptools
|
|
52
|
+
|
|
53
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
python setup.py install --user
|
|
57
|
+
```
|
|
58
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
59
|
+
|
|
60
|
+
Then import the package:
|
|
61
|
+
```python
|
|
62
|
+
import cosmotech_api
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Tests
|
|
66
|
+
|
|
67
|
+
Execute `pytest` to run the tests.
|
|
68
|
+
|
|
69
|
+
## Getting Started
|
|
70
|
+
|
|
71
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
72
|
+
|
|
73
|
+
```python
|
|
74
|
+
|
|
75
|
+
import cosmotech_api
|
|
76
|
+
from cosmotech_api.rest import ApiException
|
|
77
|
+
from pprint import pprint
|
|
78
|
+
|
|
79
|
+
# Defining the host is optional and defaults to http://localhost:8080
|
|
80
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
81
|
+
configuration = cosmotech_api.Configuration(
|
|
82
|
+
host = "http://localhost:8080"
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
# The client must configure the authentication and authorization parameters
|
|
86
|
+
# in accordance with the API server security policy.
|
|
87
|
+
# Examples for each auth method are provided below, use the example that
|
|
88
|
+
# satisfies your auth use case.
|
|
89
|
+
|
|
90
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
# Enter a context with an instance of the API client
|
|
94
|
+
with cosmotech_api.ApiClient(configuration) as api_client:
|
|
95
|
+
# Create an instance of the API class
|
|
96
|
+
api_instance = cosmotech_api.DatasetApi(api_client)
|
|
97
|
+
organization_id = 'organization_id_example' # str | the Organization identifier
|
|
98
|
+
workspace_id = 'workspace_id_example' # str | the Workspace identifier
|
|
99
|
+
dataset_create_request = cosmotech_api.DatasetCreateRequest() # DatasetCreateRequest |
|
|
100
|
+
files = None # List[bytearray] | Notes: - Each parts defined in dataset should have a file defined in this list - Please ensure that upload files order match with data parts list defined - First file uploaded will match with first dataset parts and so on (optional)
|
|
101
|
+
|
|
102
|
+
try:
|
|
103
|
+
# Create a Dataset
|
|
104
|
+
api_response = api_instance.create_dataset(organization_id, workspace_id, dataset_create_request, files=files)
|
|
105
|
+
print("The response of DatasetApi->create_dataset:\n")
|
|
106
|
+
pprint(api_response)
|
|
107
|
+
except ApiException as e:
|
|
108
|
+
print("Exception when calling DatasetApi->create_dataset: %s\n" % e)
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Documentation for API Endpoints
|
|
113
|
+
|
|
114
|
+
All URIs are relative to *http://localhost:8080*
|
|
115
|
+
|
|
116
|
+
Class | Method | HTTP request | Description
|
|
117
|
+
------------ | ------------- | ------------- | -------------
|
|
118
|
+
*DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Create a Dataset
|
|
119
|
+
*DatasetApi* | [**create_dataset_access_control**](docs/DatasetApi.md#create_dataset_access_control) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access | Add a control access to the Dataset
|
|
120
|
+
*DatasetApi* | [**create_dataset_part**](docs/DatasetApi.md#create_dataset_part) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Create a data part of a Dataset
|
|
121
|
+
*DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Delete a Dataset
|
|
122
|
+
*DatasetApi* | [**delete_dataset_access_control**](docs/DatasetApi.md#delete_dataset_access_control) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Remove the specified access from the given Dataset
|
|
123
|
+
*DatasetApi* | [**delete_dataset_part**](docs/DatasetApi.md#delete_dataset_part) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Delete a Dataset part
|
|
124
|
+
*DatasetApi* | [**download_dataset_part**](docs/DatasetApi.md#download_dataset_part) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/download | Download data from a dataset part
|
|
125
|
+
*DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Retrieve a Dataset
|
|
126
|
+
*DatasetApi* | [**get_dataset_access_control**](docs/DatasetApi.md#get_dataset_access_control) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset
|
|
127
|
+
*DatasetApi* | [**get_dataset_part**](docs/DatasetApi.md#get_dataset_part) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Retrieve a data part of a Dataset
|
|
128
|
+
*DatasetApi* | [**list_dataset_parts**](docs/DatasetApi.md#list_dataset_parts) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset
|
|
129
|
+
*DatasetApi* | [**list_dataset_security_users**](docs/DatasetApi.md#list_dataset_security_users) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list
|
|
130
|
+
*DatasetApi* | [**list_datasets**](docs/DatasetApi.md#list_datasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Retrieve a list of defined Dataset
|
|
131
|
+
*DatasetApi* | [**query_data**](docs/DatasetApi.md#query_data) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
|
|
132
|
+
*DatasetApi* | [**replace_dataset_part**](docs/DatasetApi.md#replace_dataset_part) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Replace existing dataset parts of a Dataset
|
|
133
|
+
*DatasetApi* | [**search_dataset_parts**](docs/DatasetApi.md#search_dataset_parts) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/search | Search Dataset parts by tags
|
|
134
|
+
*DatasetApi* | [**search_datasets**](docs/DatasetApi.md#search_datasets) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/search | Search Datasets by tags
|
|
135
|
+
*DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a Dataset
|
|
136
|
+
*DatasetApi* | [**update_dataset_access_control**](docs/DatasetApi.md#update_dataset_access_control) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset
|
|
137
|
+
*DatasetApi* | [**update_dataset_default_security**](docs/DatasetApi.md#update_dataset_default_security) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/default | Set the Dataset default security
|
|
138
|
+
*DatasetApi* | [**update_dataset_part**](docs/DatasetApi.md#update_dataset_part) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Update existing dataset parts information of a Dataset
|
|
139
|
+
*MetaApi* | [**about**](docs/MetaApi.md#about) | **GET** /about | Get various information about the API
|
|
140
|
+
*OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /organizations | Create a new organization
|
|
141
|
+
*OrganizationApi* | [**create_organization_access_control**](docs/OrganizationApi.md#create_organization_access_control) | **POST** /organizations/{organization_id}/security/access | Add a control access to the Organization
|
|
142
|
+
*OrganizationApi* | [**delete_organization**](docs/OrganizationApi.md#delete_organization) | **DELETE** /organizations/{organization_id} | Delete an organization
|
|
143
|
+
*OrganizationApi* | [**delete_organization_access_control**](docs/OrganizationApi.md#delete_organization_access_control) | **DELETE** /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization
|
|
144
|
+
*OrganizationApi* | [**get_organization**](docs/OrganizationApi.md#get_organization) | **GET** /organizations/{organization_id} | Get the details of an Organization
|
|
145
|
+
*OrganizationApi* | [**get_organization_access_control**](docs/OrganizationApi.md#get_organization_access_control) | **GET** /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization
|
|
146
|
+
*OrganizationApi* | [**get_organization_permissions**](docs/OrganizationApi.md#get_organization_permissions) | **GET** /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role
|
|
147
|
+
*OrganizationApi* | [**get_organization_security**](docs/OrganizationApi.md#get_organization_security) | **GET** /organizations/{organization_id}/security | Get the Organization security information
|
|
148
|
+
*OrganizationApi* | [**list_organization_security_users**](docs/OrganizationApi.md#list_organization_security_users) | **GET** /organizations/{organization_id}/security/users | Get the Organization security users list
|
|
149
|
+
*OrganizationApi* | [**list_organizations**](docs/OrganizationApi.md#list_organizations) | **GET** /organizations | List all Organizations
|
|
150
|
+
*OrganizationApi* | [**list_permissions**](docs/OrganizationApi.md#list_permissions) | **GET** /organizations/permissions | Get all permissions per components
|
|
151
|
+
*OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PATCH** /organizations/{organization_id} | Update an Organization
|
|
152
|
+
*OrganizationApi* | [**update_organization_access_control**](docs/OrganizationApi.md#update_organization_access_control) | **PATCH** /organizations/{organization_id}/security/access/{identity_id} | Update the specified access to User for an Organization
|
|
153
|
+
*OrganizationApi* | [**update_organization_default_security**](docs/OrganizationApi.md#update_organization_default_security) | **PATCH** /organizations/{organization_id}/security/default | Update the Organization default security
|
|
154
|
+
*RunApi* | [**delete_run**](docs/RunApi.md#delete_run) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run
|
|
155
|
+
*RunApi* | [**get_run**](docs/RunApi.md#get_run) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run
|
|
156
|
+
*RunApi* | [**get_run_logs**](docs/RunApi.md#get_run_logs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run
|
|
157
|
+
*RunApi* | [**get_run_status**](docs/RunApi.md#get_run_status) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run
|
|
158
|
+
*RunApi* | [**list_runs**](docs/RunApi.md#list_runs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner
|
|
159
|
+
*RunnerApi* | [**create_runner**](docs/RunnerApi.md#create_runner) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner
|
|
160
|
+
*RunnerApi* | [**create_runner_access_control**](docs/RunnerApi.md#create_runner_access_control) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner
|
|
161
|
+
*RunnerApi* | [**delete_runner**](docs/RunnerApi.md#delete_runner) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner
|
|
162
|
+
*RunnerApi* | [**delete_runner_access_control**](docs/RunnerApi.md#delete_runner_access_control) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Remove the specified access from the given Runner
|
|
163
|
+
*RunnerApi* | [**get_runner**](docs/RunnerApi.md#get_runner) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of a runner
|
|
164
|
+
*RunnerApi* | [**get_runner_access_control**](docs/RunnerApi.md#get_runner_access_control) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner
|
|
165
|
+
*RunnerApi* | [**get_runner_security**](docs/RunnerApi.md#get_runner_security) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information
|
|
166
|
+
*RunnerApi* | [**list_runner_permissions**](docs/RunnerApi.md#list_runner_permissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role
|
|
167
|
+
*RunnerApi* | [**list_runner_security_users**](docs/RunnerApi.md#list_runner_security_users) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list
|
|
168
|
+
*RunnerApi* | [**list_runners**](docs/RunnerApi.md#list_runners) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners | List all Runners
|
|
169
|
+
*RunnerApi* | [**start_run**](docs/RunnerApi.md#start_run) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start | Start a run with runner parameters
|
|
170
|
+
*RunnerApi* | [**stop_run**](docs/RunnerApi.md#stop_run) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop | Stop the last run
|
|
171
|
+
*RunnerApi* | [**update_runner**](docs/RunnerApi.md#update_runner) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update a runner
|
|
172
|
+
*RunnerApi* | [**update_runner_access_control**](docs/RunnerApi.md#update_runner_access_control) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Update the specified access to User for a Runner
|
|
173
|
+
*RunnerApi* | [**update_runner_default_security**](docs/RunnerApi.md#update_runner_default_security) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security
|
|
174
|
+
*SolutionApi* | [**create_solution**](docs/SolutionApi.md#create_solution) | **POST** /organizations/{organization_id}/solutions | Create a new solution
|
|
175
|
+
*SolutionApi* | [**create_solution_access_control**](docs/SolutionApi.md#create_solution_access_control) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/access | Create solution access control
|
|
176
|
+
*SolutionApi* | [**create_solution_parameter**](docs/SolutionApi.md#create_solution_parameter) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution
|
|
177
|
+
*SolutionApi* | [**create_solution_parameter_group**](docs/SolutionApi.md#create_solution_parameter_group) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group
|
|
178
|
+
*SolutionApi* | [**create_solution_run_template**](docs/SolutionApi.md#create_solution_run_template) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template
|
|
179
|
+
*SolutionApi* | [**delete_solution**](docs/SolutionApi.md#delete_solution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution
|
|
180
|
+
*SolutionApi* | [**delete_solution_access_control**](docs/SolutionApi.md#delete_solution_access_control) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Delete solution access control
|
|
181
|
+
*SolutionApi* | [**delete_solution_parameter**](docs/SolutionApi.md#delete_solution_parameter) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution
|
|
182
|
+
*SolutionApi* | [**delete_solution_parameter_group**](docs/SolutionApi.md#delete_solution_parameter_group) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Delete a parameter group from the solution
|
|
183
|
+
*SolutionApi* | [**delete_solution_run_template**](docs/SolutionApi.md#delete_solution_run_template) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template
|
|
184
|
+
*SolutionApi* | [**get_run_template**](docs/SolutionApi.md#get_run_template) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates
|
|
185
|
+
*SolutionApi* | [**get_solution**](docs/SolutionApi.md#get_solution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution
|
|
186
|
+
*SolutionApi* | [**get_solution_access_control**](docs/SolutionApi.md#get_solution_access_control) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control
|
|
187
|
+
*SolutionApi* | [**get_solution_parameter**](docs/SolutionApi.md#get_solution_parameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter
|
|
188
|
+
*SolutionApi* | [**get_solution_parameter_group**](docs/SolutionApi.md#get_solution_parameter_group) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group
|
|
189
|
+
*SolutionApi* | [**get_solution_security**](docs/SolutionApi.md#get_solution_security) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information
|
|
190
|
+
*SolutionApi* | [**list_run_templates**](docs/SolutionApi.md#list_run_templates) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | List all solution run templates
|
|
191
|
+
*SolutionApi* | [**list_solution_parameter_groups**](docs/SolutionApi.md#list_solution_parameter_groups) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups
|
|
192
|
+
*SolutionApi* | [**list_solution_parameters**](docs/SolutionApi.md#list_solution_parameters) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters
|
|
193
|
+
*SolutionApi* | [**list_solution_security_users**](docs/SolutionApi.md#list_solution_security_users) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users
|
|
194
|
+
*SolutionApi* | [**list_solutions**](docs/SolutionApi.md#list_solutions) | **GET** /organizations/{organization_id}/solutions | List all Solutions
|
|
195
|
+
*SolutionApi* | [**update_solution**](docs/SolutionApi.md#update_solution) | **PATCH** /organizations/{organization_id}/solutions/{solution_id} | Update a solution
|
|
196
|
+
*SolutionApi* | [**update_solution_access_control**](docs/SolutionApi.md#update_solution_access_control) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update solution access control
|
|
197
|
+
*SolutionApi* | [**update_solution_default_security**](docs/SolutionApi.md#update_solution_default_security) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/default | Update solution default security
|
|
198
|
+
*SolutionApi* | [**update_solution_parameter**](docs/SolutionApi.md#update_solution_parameter) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Update solution parameter
|
|
199
|
+
*SolutionApi* | [**update_solution_parameter_group**](docs/SolutionApi.md#update_solution_parameter_group) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Update a solution parameter group
|
|
200
|
+
*SolutionApi* | [**update_solution_run_template**](docs/SolutionApi.md#update_solution_run_template) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update a specific run template
|
|
201
|
+
*WorkspaceApi* | [**create_workspace**](docs/WorkspaceApi.md#create_workspace) | **POST** /organizations/{organization_id}/workspaces | Create a new workspace
|
|
202
|
+
*WorkspaceApi* | [**create_workspace_access_control**](docs/WorkspaceApi.md#create_workspace_access_control) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/security/access | Add a control access to the Workspace
|
|
203
|
+
*WorkspaceApi* | [**create_workspace_file**](docs/WorkspaceApi.md#create_workspace_file) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/files | Upload a file for the Workspace
|
|
204
|
+
*WorkspaceApi* | [**delete_workspace**](docs/WorkspaceApi.md#delete_workspace) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id} | Delete a workspace
|
|
205
|
+
*WorkspaceApi* | [**delete_workspace_access_control**](docs/WorkspaceApi.md#delete_workspace_access_control) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Remove the specified access from the given Workspace
|
|
206
|
+
*WorkspaceApi* | [**delete_workspace_file**](docs/WorkspaceApi.md#delete_workspace_file) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/files/delete | Delete a workspace file
|
|
207
|
+
*WorkspaceApi* | [**delete_workspace_files**](docs/WorkspaceApi.md#delete_workspace_files) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/files | Delete all Workspace files
|
|
208
|
+
*WorkspaceApi* | [**get_workspace**](docs/WorkspaceApi.md#get_workspace) | **GET** /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of a workspace
|
|
209
|
+
*WorkspaceApi* | [**get_workspace_access_control**](docs/WorkspaceApi.md#get_workspace_access_control) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace
|
|
210
|
+
*WorkspaceApi* | [**get_workspace_file**](docs/WorkspaceApi.md#get_workspace_file) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified
|
|
211
|
+
*WorkspaceApi* | [**get_workspace_security**](docs/WorkspaceApi.md#get_workspace_security) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information
|
|
212
|
+
*WorkspaceApi* | [**list_workspace_files**](docs/WorkspaceApi.md#list_workspace_files) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files
|
|
213
|
+
*WorkspaceApi* | [**list_workspace_role_permissions**](docs/WorkspaceApi.md#list_workspace_role_permissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role
|
|
214
|
+
*WorkspaceApi* | [**list_workspace_security_users**](docs/WorkspaceApi.md#list_workspace_security_users) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security/users | Get the Workspace security users list
|
|
215
|
+
*WorkspaceApi* | [**list_workspaces**](docs/WorkspaceApi.md#list_workspaces) | **GET** /organizations/{organization_id}/workspaces | List all Workspaces
|
|
216
|
+
*WorkspaceApi* | [**update_workspace**](docs/WorkspaceApi.md#update_workspace) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id} | Update a workspace
|
|
217
|
+
*WorkspaceApi* | [**update_workspace_access_control**](docs/WorkspaceApi.md#update_workspace_access_control) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Update the specified access to User for a Workspace
|
|
218
|
+
*WorkspaceApi* | [**update_workspace_default_security**](docs/WorkspaceApi.md#update_workspace_default_security) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/security/default | Update the Workspace default security
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
## Documentation For Models
|
|
222
|
+
|
|
223
|
+
- [AboutInfo](docs/AboutInfo.md)
|
|
224
|
+
- [AboutInfoVersion](docs/AboutInfoVersion.md)
|
|
225
|
+
- [ComponentRolePermissions](docs/ComponentRolePermissions.md)
|
|
226
|
+
- [ContainerResourceSizeInfo](docs/ContainerResourceSizeInfo.md)
|
|
227
|
+
- [ContainerResourceSizing](docs/ContainerResourceSizing.md)
|
|
228
|
+
- [CreatedRun](docs/CreatedRun.md)
|
|
229
|
+
- [Dataset](docs/Dataset.md)
|
|
230
|
+
- [DatasetAccessControl](docs/DatasetAccessControl.md)
|
|
231
|
+
- [DatasetCreateRequest](docs/DatasetCreateRequest.md)
|
|
232
|
+
- [DatasetEditInfo](docs/DatasetEditInfo.md)
|
|
233
|
+
- [DatasetPart](docs/DatasetPart.md)
|
|
234
|
+
- [DatasetPartCreateRequest](docs/DatasetPartCreateRequest.md)
|
|
235
|
+
- [DatasetPartTypeEnum](docs/DatasetPartTypeEnum.md)
|
|
236
|
+
- [DatasetPartUpdateRequest](docs/DatasetPartUpdateRequest.md)
|
|
237
|
+
- [DatasetRole](docs/DatasetRole.md)
|
|
238
|
+
- [DatasetSecurity](docs/DatasetSecurity.md)
|
|
239
|
+
- [DatasetUpdateRequest](docs/DatasetUpdateRequest.md)
|
|
240
|
+
- [LastRunInfo](docs/LastRunInfo.md)
|
|
241
|
+
- [Organization](docs/Organization.md)
|
|
242
|
+
- [OrganizationAccessControl](docs/OrganizationAccessControl.md)
|
|
243
|
+
- [OrganizationCreateRequest](docs/OrganizationCreateRequest.md)
|
|
244
|
+
- [OrganizationEditInfo](docs/OrganizationEditInfo.md)
|
|
245
|
+
- [OrganizationRole](docs/OrganizationRole.md)
|
|
246
|
+
- [OrganizationSecurity](docs/OrganizationSecurity.md)
|
|
247
|
+
- [OrganizationUpdateRequest](docs/OrganizationUpdateRequest.md)
|
|
248
|
+
- [ResourceSizeInfo](docs/ResourceSizeInfo.md)
|
|
249
|
+
- [Run](docs/Run.md)
|
|
250
|
+
- [RunContainer](docs/RunContainer.md)
|
|
251
|
+
- [RunEditInfo](docs/RunEditInfo.md)
|
|
252
|
+
- [RunResourceRequested](docs/RunResourceRequested.md)
|
|
253
|
+
- [RunState](docs/RunState.md)
|
|
254
|
+
- [RunStatus](docs/RunStatus.md)
|
|
255
|
+
- [RunStatusNode](docs/RunStatusNode.md)
|
|
256
|
+
- [RunTemplate](docs/RunTemplate.md)
|
|
257
|
+
- [RunTemplateCreateRequest](docs/RunTemplateCreateRequest.md)
|
|
258
|
+
- [RunTemplateParameter](docs/RunTemplateParameter.md)
|
|
259
|
+
- [RunTemplateParameterCreateRequest](docs/RunTemplateParameterCreateRequest.md)
|
|
260
|
+
- [RunTemplateParameterGroup](docs/RunTemplateParameterGroup.md)
|
|
261
|
+
- [RunTemplateParameterGroupCreateRequest](docs/RunTemplateParameterGroupCreateRequest.md)
|
|
262
|
+
- [RunTemplateParameterGroupUpdateRequest](docs/RunTemplateParameterGroupUpdateRequest.md)
|
|
263
|
+
- [RunTemplateParameterUpdateRequest](docs/RunTemplateParameterUpdateRequest.md)
|
|
264
|
+
- [RunTemplateParameterValue](docs/RunTemplateParameterValue.md)
|
|
265
|
+
- [RunTemplateResourceSizing](docs/RunTemplateResourceSizing.md)
|
|
266
|
+
- [RunTemplateUpdateRequest](docs/RunTemplateUpdateRequest.md)
|
|
267
|
+
- [Runner](docs/Runner.md)
|
|
268
|
+
- [RunnerAccessControl](docs/RunnerAccessControl.md)
|
|
269
|
+
- [RunnerCreateRequest](docs/RunnerCreateRequest.md)
|
|
270
|
+
- [RunnerDatasets](docs/RunnerDatasets.md)
|
|
271
|
+
- [RunnerEditInfo](docs/RunnerEditInfo.md)
|
|
272
|
+
- [RunnerResourceSizing](docs/RunnerResourceSizing.md)
|
|
273
|
+
- [RunnerRole](docs/RunnerRole.md)
|
|
274
|
+
- [RunnerRunTemplateParameterValue](docs/RunnerRunTemplateParameterValue.md)
|
|
275
|
+
- [RunnerSecurity](docs/RunnerSecurity.md)
|
|
276
|
+
- [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
|
|
277
|
+
- [RunnerValidationStatus](docs/RunnerValidationStatus.md)
|
|
278
|
+
- [Solution](docs/Solution.md)
|
|
279
|
+
- [SolutionAccessControl](docs/SolutionAccessControl.md)
|
|
280
|
+
- [SolutionCreateRequest](docs/SolutionCreateRequest.md)
|
|
281
|
+
- [SolutionEditInfo](docs/SolutionEditInfo.md)
|
|
282
|
+
- [SolutionRole](docs/SolutionRole.md)
|
|
283
|
+
- [SolutionSecurity](docs/SolutionSecurity.md)
|
|
284
|
+
- [SolutionUpdateRequest](docs/SolutionUpdateRequest.md)
|
|
285
|
+
- [Workspace](docs/Workspace.md)
|
|
286
|
+
- [WorkspaceAccessControl](docs/WorkspaceAccessControl.md)
|
|
287
|
+
- [WorkspaceCreateRequest](docs/WorkspaceCreateRequest.md)
|
|
288
|
+
- [WorkspaceEditInfo](docs/WorkspaceEditInfo.md)
|
|
289
|
+
- [WorkspaceFile](docs/WorkspaceFile.md)
|
|
290
|
+
- [WorkspaceRole](docs/WorkspaceRole.md)
|
|
291
|
+
- [WorkspaceSecurity](docs/WorkspaceSecurity.md)
|
|
292
|
+
- [WorkspaceSolution](docs/WorkspaceSolution.md)
|
|
293
|
+
- [WorkspaceUpdateRequest](docs/WorkspaceUpdateRequest.md)
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<a id="documentation-for-authorization"></a>
|
|
297
|
+
## Documentation For Authorization
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
Authentication schemes defined for the API:
|
|
301
|
+
<a id="oAuth2AuthCode"></a>
|
|
302
|
+
### oAuth2AuthCode
|
|
303
|
+
|
|
304
|
+
- **Type**: OAuth
|
|
305
|
+
- **Flow**: accessCode
|
|
306
|
+
- **Authorization URL**: https://example.com/authorize
|
|
307
|
+
- **Scopes**: N/A
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
## Author
|
|
311
|
+
|
|
312
|
+
platform@cosmotech.com
|
|
313
|
+
|
|
314
|
+
|