Skip to content

Commit d3393f5

Browse files
committed
Add tip to FilesAPI methods to use Data Modeling Files API instead
1 parent aa2316c commit d3393f5

2 files changed

Lines changed: 31 additions & 1 deletion

File tree

cognite/client/_api/files.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,9 @@ async def retrieve(
270270
Returns:
271271
FileMetadata | None: Requested file metadata or None if it does not exist.
272272
273+
Tip:
274+
If you are working with Data Modeling, consider using :meth:`client.data_modeling.files.retrieve <cognite.client._api.data_modeling.files.DataModelingFilesAPI.retrieve>` instead.
275+
273276
Examples:
274277
275278
Get file metadata by instance id:
@@ -307,6 +310,9 @@ async def retrieve_multiple(
307310
Returns:
308311
FileMetadataList: The requested file metadatas.
309312
313+
Tip:
314+
If you are working with Data Modeling, consider using :meth:`client.data_modeling.files.retrieve <cognite.client._api.data_modeling.files.DataModelingFilesAPI.retrieve>` instead.
315+
310316
Examples:
311317
312318
Get file metadatas by instance id:
@@ -509,6 +515,9 @@ async def upload_content(
509515
Returns:
510516
FileMetadata: No description.
511517
518+
Tip:
519+
If you are working with Data Modeling, consider using :meth:`client.data_modeling.files.upload_content <cognite.client._api.data_modeling.files.DataModelingFilesAPI.upload_content>` instead.
520+
512521
Examples:
513522
514523
Upload file content using instance_id:
@@ -750,6 +759,9 @@ async def upload_content_bytes(
750759
Returns:
751760
FileMetadata: No description.
752761
762+
Tip:
763+
If you are working with Data Modeling, consider using :meth:`client.data_modeling.files.upload_content_bytes <cognite.client._api.data_modeling.files.DataModelingFilesAPI.upload_content_bytes>` instead.
764+
753765
Examples:
754766
755767
Finish a file creation by uploading the content using instance_id:
@@ -1178,6 +1190,9 @@ async def retrieve_download_urls(
11781190
Returns:
11791191
dict[int, str] | dict[str, str] | dict[NodeId, str] | dict[int | str | NodeId, str]: Dictionary containing download urls.
11801192
1193+
Tip:
1194+
If you are working with Data Modeling, consider using :meth:`client.data_modeling.files.retrieve_download_urls <cognite.client._api.data_modeling.files.DataModelingFilesAPI.retrieve_download_urls>` instead.
1195+
11811196
Examples:
11821197
11831198
Get download URLs by instance id:

cognite/client/_sync_api/files.py

Lines changed: 16 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)