Skip to content

Commit 40510a7

Browse files
Automatically update python client (ref: Cosmo-Tech/cosmotech-api@46f7c63)
Co-authored-by: Leopold-Cramer <Leopold-Cramer@users.noreply.github.com>
1 parent ccb6ce3 commit 40510a7

File tree

14 files changed

+199
-24
lines changed

14 files changed

+199
-24
lines changed

cosmotech_api/api/dataset_api.py

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ def create_dataset(
7070
) -> Dataset:
7171
"""Create a Dataset
7272
73+
Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
7374
7475
:param organization_id: the Organization identifier (required)
7576
:type organization_id: str
@@ -151,6 +152,7 @@ def create_dataset_with_http_info(
151152
) -> ApiResponse[Dataset]:
152153
"""Create a Dataset
153154
155+
Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
154156
155157
:param organization_id: the Organization identifier (required)
156158
:type organization_id: str
@@ -232,6 +234,7 @@ def create_dataset_without_preload_content(
232234
) -> RESTResponseType:
233235
"""Create a Dataset
234236
237+
Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
235238
236239
:param organization_id: the Organization identifier (required)
237240
:type organization_id: str
@@ -719,6 +722,7 @@ def create_dataset_part(
719722
) -> DatasetPart:
720723
"""Create a data part of a Dataset
721724
725+
Create a new data part within a dataset. Specify type as 'File' for file storage or 'DB' for database storage. Returns the created part.
722726
723727
:param organization_id: the Organization identifier (required)
724728
:type organization_id: str
@@ -804,6 +808,7 @@ def create_dataset_part_with_http_info(
804808
) -> ApiResponse[DatasetPart]:
805809
"""Create a data part of a Dataset
806810
811+
Create a new data part within a dataset. Specify type as 'File' for file storage or 'DB' for database storage. Returns the created part.
807812
808813
:param organization_id: the Organization identifier (required)
809814
:type organization_id: str
@@ -889,6 +894,7 @@ def create_dataset_part_without_preload_content(
889894
) -> RESTResponseType:
890895
"""Create a data part of a Dataset
891896
897+
Create a new data part within a dataset. Specify type as 'File' for file storage or 'DB' for database storage. Returns the created part.
892898
893899
:param organization_id: the Organization identifier (required)
894900
:type organization_id: str
@@ -1058,7 +1064,7 @@ def delete_dataset(
10581064
) -> None:
10591065
"""Delete a Dataset
10601066
1061-
Delete a dataset
1067+
Permanently delete a dataset and all its data parts. This operation cannot be undone.
10621068
10631069
:param organization_id: the Organization identifier (required)
10641070
:type organization_id: str
@@ -1135,7 +1141,7 @@ def delete_dataset_with_http_info(
11351141
) -> ApiResponse[None]:
11361142
"""Delete a Dataset
11371143
1138-
Delete a dataset
1144+
Permanently delete a dataset and all its data parts. This operation cannot be undone.
11391145
11401146
:param organization_id: the Organization identifier (required)
11411147
:type organization_id: str
@@ -1212,7 +1218,7 @@ def delete_dataset_without_preload_content(
12121218
) -> RESTResponseType:
12131219
"""Delete a Dataset
12141220
1215-
Delete a dataset
1221+
Permanently delete a dataset and all its data parts. This operation cannot be undone.
12161222
12171223
:param organization_id: the Organization identifier (required)
12181224
:type organization_id: str
@@ -1349,6 +1355,7 @@ def delete_dataset_access_control(
13491355
) -> None:
13501356
"""Remove the specified access from the given Dataset
13511357
1358+
Remove a user or group's access to a dataset. Cannot remove the last administrator - at least one admin must remain.
13521359
13531360
:param organization_id: the Organization identifier (required)
13541361
:type organization_id: str
@@ -1428,6 +1435,7 @@ def delete_dataset_access_control_with_http_info(
14281435
) -> ApiResponse[None]:
14291436
"""Remove the specified access from the given Dataset
14301437
1438+
Remove a user or group's access to a dataset. Cannot remove the last administrator - at least one admin must remain.
14311439
14321440
:param organization_id: the Organization identifier (required)
14331441
:type organization_id: str
@@ -1507,6 +1515,7 @@ def delete_dataset_access_control_without_preload_content(
15071515
) -> RESTResponseType:
15081516
"""Remove the specified access from the given Dataset
15091517
1518+
Remove a user or group's access to a dataset. Cannot remove the last administrator - at least one admin must remain.
15101519
15111520
:param organization_id: the Organization identifier (required)
15121521
:type organization_id: str
@@ -1953,6 +1962,7 @@ def download_dataset_part(
19531962
) -> bytearray:
19541963
"""Download data from a dataset part
19551964
1965+
Download the file content from a dataset part. Returns the file as an application/octet-stream.
19561966
19571967
:param organization_id: the Organization identifier (required)
19581968
:type organization_id: str
@@ -2033,6 +2043,7 @@ def download_dataset_part_with_http_info(
20332043
) -> ApiResponse[bytearray]:
20342044
"""Download data from a dataset part
20352045
2046+
Download the file content from a dataset part. Returns the file as an application/octet-stream.
20362047
20372048
:param organization_id: the Organization identifier (required)
20382049
:type organization_id: str
@@ -2113,6 +2124,7 @@ def download_dataset_part_without_preload_content(
21132124
) -> RESTResponseType:
21142125
"""Download data from a dataset part
21152126
2127+
Download the file content from a dataset part. Returns the file as an application/octet-stream.
21162128
21172129
:param organization_id: the Organization identifier (required)
21182130
:type organization_id: str
@@ -2261,7 +2273,7 @@ def get_dataset(
22612273
) -> Dataset:
22622274
"""Retrieve a Dataset
22632275
2264-
Retrieve a dataset
2276+
Retrieve complete information about a specific dataset including dataset parts.
22652277
22662278
:param organization_id: the Organization identifier (required)
22672279
:type organization_id: str
@@ -2338,7 +2350,7 @@ def get_dataset_with_http_info(
23382350
) -> ApiResponse[Dataset]:
23392351
"""Retrieve a Dataset
23402352
2341-
Retrieve a dataset
2353+
Retrieve complete information about a specific dataset including dataset parts.
23422354
23432355
:param organization_id: the Organization identifier (required)
23442356
:type organization_id: str
@@ -2415,7 +2427,7 @@ def get_dataset_without_preload_content(
24152427
) -> RESTResponseType:
24162428
"""Retrieve a Dataset
24172429
2418-
Retrieve a dataset
2430+
Retrieve complete information about a specific dataset including dataset parts.
24192431
24202432
:param organization_id: the Organization identifier (required)
24212433
:type organization_id: str
@@ -3178,6 +3190,7 @@ def list_dataset_parts(
31783190
) -> List[DatasetPart]:
31793191
"""Retrieve all dataset parts of a Dataset
31803192
3193+
Retrieve all data parts associated with a dataset.
31813194
31823195
:param organization_id: the Organization identifier (required)
31833196
:type organization_id: str
@@ -3262,6 +3275,7 @@ def list_dataset_parts_with_http_info(
32623275
) -> ApiResponse[List[DatasetPart]]:
32633276
"""Retrieve all dataset parts of a Dataset
32643277
3278+
Retrieve all data parts associated with a dataset.
32653279
32663280
:param organization_id: the Organization identifier (required)
32673281
:type organization_id: str
@@ -3346,6 +3360,7 @@ def list_dataset_parts_without_preload_content(
33463360
) -> RESTResponseType:
33473361
"""Retrieve all dataset parts of a Dataset
33483362
3363+
Retrieve all data parts associated with a dataset.
33493364
33503365
:param organization_id: the Organization identifier (required)
33513366
:type organization_id: str
@@ -3798,7 +3813,7 @@ def list_datasets(
37983813
) -> List[Dataset]:
37993814
"""Retrieve a list of defined Dataset
38003815
3801-
List all datasets
3816+
Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via 'page' and 'size' query parameters. Returns datasets based on user permissions.
38023817
38033818
:param organization_id: the Organization identifier (required)
38043819
:type organization_id: str
@@ -3879,7 +3894,7 @@ def list_datasets_with_http_info(
38793894
) -> ApiResponse[List[Dataset]]:
38803895
"""Retrieve a list of defined Dataset
38813896
3882-
List all datasets
3897+
Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via 'page' and 'size' query parameters. Returns datasets based on user permissions.
38833898
38843899
:param organization_id: the Organization identifier (required)
38853900
:type organization_id: str
@@ -3960,7 +3975,7 @@ def list_datasets_without_preload_content(
39603975
) -> RESTResponseType:
39613976
"""Retrieve a list of defined Dataset
39623977
3963-
List all datasets
3978+
Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via 'page' and 'size' query parameters. Returns datasets based on user permissions.
39643979
39653980
:param organization_id: the Organization identifier (required)
39663981
:type organization_id: str
@@ -4125,6 +4140,7 @@ def query_data(
41254140
) -> bytearray:
41264141
"""Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
41274142
4143+
Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
41284144
41294145
:param organization_id: the Organization identifier (required)
41304146
:type organization_id: str
@@ -4247,6 +4263,7 @@ def query_data_with_http_info(
42474263
) -> ApiResponse[bytearray]:
42484264
"""Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
42494265
4266+
Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
42504267
42514268
:param organization_id: the Organization identifier (required)
42524269
:type organization_id: str
@@ -4369,6 +4386,7 @@ def query_data_without_preload_content(
43694386
) -> RESTResponseType:
43704387
"""Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
43714388
4389+
Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
43724390
43734391
:param organization_id: the Organization identifier (required)
43744392
:type organization_id: str
@@ -5671,7 +5689,7 @@ def update_dataset(
56715689
) -> Dataset:
56725690
"""Update a Dataset
56735691
5674-
Update a dataset
5692+
Update dataset information and return the updated dataset.
56755693
56765694
:param organization_id: the Organization identifier (required)
56775695
:type organization_id: str
@@ -5757,7 +5775,7 @@ def update_dataset_with_http_info(
57575775
) -> ApiResponse[Dataset]:
57585776
"""Update a Dataset
57595777
5760-
Update a dataset
5778+
Update dataset information and return the updated dataset.
57615779
57625780
:param organization_id: the Organization identifier (required)
57635781
:type organization_id: str
@@ -5843,7 +5861,7 @@ def update_dataset_without_preload_content(
58435861
) -> RESTResponseType:
58445862
"""Update a Dataset
58455863
5846-
Update a dataset
5864+
Update dataset information and return the updated dataset.
58475865
58485866
:param organization_id: the Organization identifier (required)
58495867
:type organization_id: str

cosmotech_api/api/meta_api.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ def about(
5555
) -> AboutInfo:
5656
"""Get various information about the API
5757
58+
Retrieve API version information and build details.
5859
5960
:param _request_timeout: timeout setting for this request. If one
6061
number provided, it will be total request
@@ -117,6 +118,7 @@ def about_with_http_info(
117118
) -> ApiResponse[AboutInfo]:
118119
"""Get various information about the API
119120
121+
Retrieve API version information and build details.
120122
121123
:param _request_timeout: timeout setting for this request. If one
122124
number provided, it will be total request
@@ -179,6 +181,7 @@ def about_without_preload_content(
179181
) -> RESTResponseType:
180182
"""Get various information about the API
181183
184+
Retrieve API version information and build details.
182185
183186
:param _request_timeout: timeout setting for this request. If one
184187
number provided, it will be total request

0 commit comments

Comments
 (0)