chore: update all links to the official Cognite API reference (DM-3537) (#2486)

Co-authored-by: Vincent <vincent.gay@cognite.com>
Co-authored-by: Anders Øen Fylling <7851860+andersfylling@users.noreply.github.com>
Co-authored-by: vishal-cognite <vishal.doshi@cognite.com>
Co-authored-by: vikramlc <vikram.chawan121@gmail.com>

Author: 5 people

cognite/client/_api/ai/tools/documents.py

@@ -18,7 +18,7 @@ def summarize(
         external_id: str | None = None,
         instance_id: NodeId | None = None,
     ) -> Summary:
-        """`Summarize a document using a Large Language Model. <https://developer.cognite.com/api#tag/Document-AI/operation/document_questioning_api_v1_projects__projectName__ai_tools_documents_ask_post>`_
+        """`Summarize a document using a Large Language Model. <https://api-docs.cognite.com/20230101/tag/Document-AI/operation/document_questioning_ai_tools_documents_ask_post>`_
 
         Note:
             Currently only supports summarizing a single document at a time, but
@@ -77,7 +77,7 @@ def ask_question(
         additional_context: str | None = None,
         ignore_unknown_ids: bool = False,
     ) -> Answer:
-        """`Ask a question about one or more documents using a Large Language Model. <https://developer.cognite.com/api#tag/Document-AI/operation/documents_summary_api_v1_projects__projectName__ai_tools_documents_summarize_post>`_
+        """`Ask a question about one or more documents using a Large Language Model. <https://api-docs.cognite.com/20230101/tag/Document-AI/operation/documents_summary_ai_tools_documents_summarize_post>`_
 
         Supports up to 100 documents at a time.
 

cognite/client/_api/annotations.py

@@ -39,7 +39,7 @@ def create(self, annotations: Sequence[Annotation | AnnotationWrite]) -> Annotat
     def create(
         self, annotations: Annotation | AnnotationWrite | Sequence[Annotation | AnnotationWrite]
     ) -> Annotation | AnnotationList:
-        """`Create annotations <https://developer.cognite.com/api#tag/Annotations/operation/annotationsCreate>`_
+        """`Create annotations <https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsCreate>`_
 
         Args:
             annotations (Annotation | AnnotationWrite | Sequence[Annotation | AnnotationWrite]): Annotation(s) to create
@@ -64,7 +64,7 @@ def suggest(self, annotations: Annotation) -> Annotation: ...
     def suggest(self, annotations: Sequence[Annotation]) -> AnnotationList: ...
 
     def suggest(self, annotations: Annotation | Sequence[Annotation]) -> Annotation | AnnotationList:
-        """`Suggest annotations <https://developer.cognite.com/api#tag/Annotations/operation/annotationsSuggest>`_
+        """`Suggest annotations <https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsSuggest>`_
 
         Args:
             annotations (Annotation | Sequence[Annotation]): annotation(s) to suggest. They must have status set to "suggested".
@@ -136,7 +136,7 @@ def update(
         | Sequence[Annotation | AnnotationWrite | AnnotationUpdate],
         mode: Literal["replace_ignore_null", "patch", "replace"] = "replace_ignore_null",
     ) -> Annotation | AnnotationList:
-        """`Update annotations <https://developer.cognite.com/api#tag/Annotations/operation/annotationsUpdate>`_
+        """`Update annotations <https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsUpdate>`_
 
         Args:
             item (Annotation | AnnotationWrite | AnnotationUpdate | Sequence[Annotation | AnnotationWrite | AnnotationUpdate]): Annotation or list of annotations to update (or patch or list of patches to apply)
@@ -149,15 +149,15 @@ def update(
         )
 
     def delete(self, id: int | Sequence[int]) -> None:
-        """`Delete annotations <https://developer.cognite.com/api#tag/Annotations/operation/annotationsDelete>`_
+        """`Delete annotations <https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsDelete>`_
 
         Args:
             id (int | Sequence[int]): ID or list of IDs to be deleted
         """
         self._delete_multiple(identifiers=IdentifierSequence.load(ids=id), wrap_ids=True)
 
     def retrieve_multiple(self, ids: Sequence[int]) -> AnnotationList:
-        """`Retrieve annotations by IDs <https://developer.cognite.com/api#tag/Annotations/operation/annotationsByids>`_`
+        """`Retrieve annotations by IDs <https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsByids>`_`
 
         Args:
             ids (Sequence[int]): list of IDs to be retrieved
@@ -169,7 +169,7 @@ def retrieve_multiple(self, ids: Sequence[int]) -> AnnotationList:
         return self._retrieve_multiple(list_cls=AnnotationList, resource_cls=Annotation, identifiers=identifiers)
 
     def retrieve(self, id: int) -> Annotation | None:
-        """`Retrieve an annotation by id <https://developer.cognite.com/api#tag/Annotations/operation/annotationsGet>`_
+        """`Retrieve an annotation by id <https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsGet>`_
 
         Args:
             id (int): id of the annotation to be retrieved
@@ -214,7 +214,7 @@ def reverse_lookup(self, filter: AnnotationReverseLookupFilter, limit: int | Non
         )
 
     def list(self, filter: AnnotationFilter | dict, limit: int | None = DEFAULT_LIMIT_READ) -> AnnotationList:
-        """`List annotations. <https://developer.cognite.com/api#tag/Annotations/operation/annotationsFilter>`_
+        """`List annotations. <https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsFilter>`_
 
         Note:
             Passing a filter with both 'annotated_resource_type' and 'annotated_resource_ids' is always required.

cognite/client/_api/assets.py

@@ -231,7 +231,7 @@ def __iter__(self) -> Iterator[Asset]:
         return self()
 
     def retrieve(self, id: int | None = None, external_id: str | None = None) -> Asset | None:
-        """`Retrieve a single asset by id. <https://developer.cognite.com/api#tag/Assets/operation/getAsset>`_
+        """`Retrieve a single asset by id. <https://api-docs.cognite.com/20230101/tag/Assets/operation/getAsset>`_
 
         Args:
             id (int | None): ID
@@ -261,7 +261,7 @@ def retrieve_multiple(
         external_ids: SequenceNotStr[str] | None = None,
         ignore_unknown_ids: bool = False,
     ) -> AssetList:
-        """`Retrieve multiple assets by id. <https://developer.cognite.com/api#tag/Assets/operation/byIdsAssets>`_
+        """`Retrieve multiple assets by id. <https://api-docs.cognite.com/20230101/tag/Assets/operation/byIdsAssets>`_
 
         Args:
             ids (Sequence[int] | None): IDs
@@ -289,7 +289,7 @@ def retrieve_multiple(
         )
 
     def aggregate(self, filter: AssetFilter | dict[str, Any] | None = None) -> list[CountAggregate]:
-        """`Aggregate assets <https://developer.cognite.com/api#tag/Assets/operation/aggregateAssets>`_
+        """`Aggregate assets <https://api-docs.cognite.com/20230101/tag/Assets/operation/aggregateAssets>`_
 
         Args:
             filter (AssetFilter | dict[str, Any] | None): Filter on assets with strict matching.
@@ -316,7 +316,7 @@ def aggregate_count(
         advanced_filter: Filter | dict[str, Any] | None = None,
         filter: AssetFilter | dict[str, Any] | None = None,
     ) -> int:
-        """`Count of assets matching the specified filters. <https://developer.cognite.com/api#tag/Assets/operation/aggregateAssets>`_
+        """`Count of assets matching the specified filters. <https://api-docs.cognite.com/20230101/tag/Assets/operation/aggregateAssets>`_
 
         Args:
             property (AssetPropertyLike | None): If specified, get an approximate number of asset with a specific property (property is not null) and matching the filters.
@@ -357,7 +357,7 @@ def aggregate_cardinality_values(
         aggregate_filter: AggregationFilter | dict[str, Any] | None = None,
         filter: AssetFilter | dict[str, Any] | None = None,
     ) -> int:
-        """`Find approximate property count for assets. <https://developer.cognite.com/api#tag/Assets/operation/aggregateAssets>`_
+        """`Find approximate property count for assets. <https://api-docs.cognite.com/20230101/tag/Assets/operation/aggregateAssets>`_
 
         Args:
             property (AssetPropertyLike): The property to count the cardinality of.
@@ -401,7 +401,7 @@ def aggregate_cardinality_properties(
         aggregate_filter: AggregationFilter | dict[str, Any] | None = None,
         filter: AssetFilter | dict[str, Any] | None = None,
     ) -> int:
-        """`Find approximate paths count for assets.  <https://developer.cognite.com/api#tag/Assets/operation/aggregateAssets>`_
+        """`Find approximate paths count for assets.  <https://api-docs.cognite.com/20230101/tag/Assets/operation/aggregateAssets>`_
 
         Args:
             path (AssetPropertyLike): The scope in every document to aggregate properties. The only value allowed now is ["metadata"].
@@ -437,7 +437,7 @@ def aggregate_unique_values(
         aggregate_filter: AggregationFilter | dict[str, Any] | None = None,
         filter: AssetFilter | dict[str, Any] | None = None,
     ) -> UniqueResultList:
-        """`Get unique properties with counts for assets. <https://developer.cognite.com/api#tag/Assets/operation/aggregateAssets>`_
+        """`Get unique properties with counts for assets. <https://api-docs.cognite.com/20230101/tag/Assets/operation/aggregateAssets>`_
 
         Note:
             In the case of text fields, the values are aggregated in a case-insensitive manner.
@@ -499,7 +499,7 @@ def aggregate_unique_properties(
         aggregate_filter: AggregationFilter | dict[str, Any] | None = None,
         filter: AssetFilter | dict[str, Any] | None = None,
     ) -> UniqueResultList:
-        """`Get unique paths with counts for assets. <https://developer.cognite.com/api#tag/Assets/operation/aggregateAssets>`_
+        """`Get unique paths with counts for assets. <https://api-docs.cognite.com/20230101/tag/Assets/operation/aggregateAssets>`_
 
         Note:
             In the case of text fields, the values are aggregated in a case-insensitive manner.
@@ -539,7 +539,7 @@ def create(self, asset: Sequence[Asset] | Sequence[AssetWrite]) -> AssetList: ..
     def create(self, asset: Asset | AssetWrite) -> Asset: ...
 
     def create(self, asset: Asset | AssetWrite | Sequence[Asset] | Sequence[AssetWrite]) -> Asset | AssetList:
-        """`Create one or more assets. <https://developer.cognite.com/api#tag/Assets/operation/createAssets>`_
+        """`Create one or more assets. <https://api-docs.cognite.com/20230101/tag/Assets/operation/createAssets>`_
 
         You can create an arbitrary number of assets, and the SDK will split the request into multiple requests.
         When specifying parent-child relation between assets using `parentExternalId` the link will be resvoled into an internal ID and stored as `parentId`.
@@ -709,7 +709,7 @@ def delete(
         recursive: bool = False,
         ignore_unknown_ids: bool = False,
     ) -> None:
-        """`Delete one or more assets <https://developer.cognite.com/api#tag/Assets/operation/deleteAssets>`_
+        """`Delete one or more assets <https://api-docs.cognite.com/20230101/tag/Assets/operation/deleteAssets>`_
 
         Args:
             id (int | Sequence[int] | None): Id or list of ids
@@ -750,7 +750,7 @@ def update(
         item: Asset | AssetWrite | AssetUpdate | Sequence[Asset | AssetWrite | AssetUpdate],
         mode: Literal["replace_ignore_null", "patch", "replace"] = "replace_ignore_null",
     ) -> Asset | AssetList:
-        """`Update one or more assets <https://developer.cognite.com/api#tag/Assets/operation/updateAssets>`_
+        """`Update one or more assets <https://api-docs.cognite.com/20230101/tag/Assets/operation/updateAssets>`_
         Labels can be added, removed or replaced (set). Note that set operation deletes all the existing labels and adds the new specified labels.
 
         Args:
@@ -853,7 +853,7 @@ def filter(
         aggregated_properties: Sequence[AggregateAssetProperty] | None = None,
         limit: int | None = DEFAULT_LIMIT_READ,
     ) -> AssetList:
-        """`Advanced filter assets <https://developer.cognite.com/api#tag/Assets/operation/listAssets>`_
+        """`Advanced filter assets <https://api-docs.cognite.com/20230101/tag/Assets/operation/listAssets>`_
 
         Advanced filter lets you create complex filtering expressions that combine simple operations,
         such as equals, prefix, exists, etc., using boolean operators and, or, and not.
@@ -920,7 +920,7 @@ def search(
         filter: AssetFilter | dict[str, Any] | None = None,
         limit: int = DEFAULT_LIMIT_READ,
     ) -> AssetList:
-        """`Search for assets <https://developer.cognite.com/api#tag/Assets/operation/searchAssets>`_
+        """`Search for assets <https://api-docs.cognite.com/20230101/tag/Assets/operation/searchAssets>`_
         Primarily meant for human-centric use-cases and data exploration, not for programs, since matching and ordering may change over time. Use the `list` function if stable or exact matches are required.
 
         Args:
@@ -1031,7 +1031,7 @@ def list(
         advanced_filter: Filter | dict[str, Any] | None = None,
         sort: SortSpec | list[SortSpec] | None = None,
     ) -> AssetList:
-        """`List assets <https://developer.cognite.com/api#tag/Assets/operation/listAssets>`_
+        """`List assets <https://api-docs.cognite.com/20230101/tag/Assets/operation/listAssets>`_
 
         Args:
             name (str | None): Name of asset. Often referred to as tag.

cognite/client/_api/data_modeling/containers.py

@@ -99,7 +99,7 @@ def retrieve(self, ids: ContainerIdentifier) -> Container | None: ...
     def retrieve(self, ids: Sequence[ContainerIdentifier]) -> ContainerList: ...
 
     def retrieve(self, ids: ContainerIdentifier | Sequence[ContainerIdentifier]) -> Container | ContainerList | None:
-        """`Retrieve one or more container by id(s). <https://developer.cognite.com/api#tag/Containers/operation/byExternalIdsContainers>`_
+        """`Retrieve one or more container by id(s). <https://api-docs.cognite.com/20230101/tag/Containers/operation/byExternalIdsContainers>`_
 
         Args:
             ids (ContainerIdentifier | Sequence[ContainerIdentifier]): Identifier for container(s).
@@ -128,7 +128,7 @@ def retrieve(self, ids: ContainerIdentifier | Sequence[ContainerIdentifier]) ->
         )
 
     def delete(self, ids: ContainerIdentifier | Sequence[ContainerIdentifier]) -> list[ContainerId]:
-        """`Delete one or more containers <https://developer.cognite.com/api#tag/Containers/operation/deleteContainers>`_
+        """`Delete one or more containers <https://api-docs.cognite.com/20230101/tag/Containers/operation/deleteContainers>`_
 
         Args:
             ids (ContainerIdentifier | Sequence[ContainerIdentifier]): The container identifier(s).
@@ -154,7 +154,7 @@ def delete(self, ids: ContainerIdentifier | Sequence[ContainerIdentifier]) -> li
         return [ContainerId(space=item["space"], external_id=item["externalId"]) for item in deleted_containers]
 
     def delete_constraints(self, ids: Sequence[ConstraintIdentifier]) -> list[ConstraintIdentifier]:
-        """`Delete one or more constraints <https://developer.cognite.com/api#tag/Containers/operation/deleteContainerConstraints>`_
+        """`Delete one or more constraints <https://api-docs.cognite.com/20230101/tag/Containers/operation/deleteContainerConstraints>`_
 
         Args:
             ids (Sequence[ConstraintIdentifier]): The constraint identifier(s).
@@ -173,7 +173,7 @@ def delete_constraints(self, ids: Sequence[ConstraintIdentifier]) -> list[Constr
         return self._delete_constraints_or_indexes(ids, "constraints")
 
     def delete_indexes(self, ids: Sequence[IndexIdentifier]) -> list[IndexIdentifier]:
-        """`Delete one or more indexes <https://developer.cognite.com/api#tag/Containers/operation/deleteContainerIndexes>`_
+        """`Delete one or more indexes <https://api-docs.cognite.com/20230101/tag/Containers/operation/deleteContainerIndexes>`_
 
         Args:
             ids (Sequence[IndexIdentifier]): The index identifier(s).
@@ -223,7 +223,7 @@ def list(
         limit: int | None = DATA_MODELING_DEFAULT_LIMIT_READ,
         include_global: bool = False,
     ) -> ContainerList:
-        """`List containers <https://developer.cognite.com/api#tag/Containers/operation/listContainers>`_
+        """`List containers <https://api-docs.cognite.com/20230101/tag/Containers/operation/listContainers>`_
 
         Args:
             space (str | None): The space to query
@@ -267,7 +267,7 @@ def apply(self, container: Sequence[ContainerApply]) -> ContainerList: ...
     def apply(self, container: ContainerApply) -> Container: ...
 
     def apply(self, container: ContainerApply | Sequence[ContainerApply]) -> Container | ContainerList:
-        """`Add or update (upsert) containers. <https://developer.cognite.com/api#tag/Containers/operation/ApplyContainers>`_
+        """`Add or update (upsert) containers. <https://api-docs.cognite.com/20230101/tag/Containers/operation/ApplyContainers>`_
 
         Args:
             container (ContainerApply | Sequence[ContainerApply]): Container(s) to create or update.

cognite/client/_api/data_modeling/data_models.py

@@ -109,7 +109,7 @@ def retrieve(
     def retrieve(
         self, ids: DataModelIdentifier | Sequence[DataModelIdentifier], inline_views: bool = False
     ) -> DataModelList[ViewId] | DataModelList[View]:
-        """`Retrieve data_model(s) by id(s). <https://developer.cognite.com/api#tag/Data-models/operation/byExternalIdsDataModels>`_
+        """`Retrieve data_model(s) by id(s). <https://api-docs.cognite.com/20230101/tag/Data-models/operation/byExternalIdsDataModels>`_
 
         Args:
             ids (DataModelIdentifier | Sequence[DataModelIdentifier]): Data Model identifier(s).
@@ -134,7 +134,7 @@ def retrieve(
         )
 
     def delete(self, ids: DataModelIdentifier | Sequence[DataModelIdentifier]) -> list[DataModelId]:
-        """`Delete one or more data model <https://developer.cognite.com/api#tag/Data-models/operation/deleteDataModels>`_
+        """`Delete one or more data model <https://api-docs.cognite.com/20230101/tag/Data-models/operation/deleteDataModels>`_
 
         Args:
             ids (DataModelIdentifier | Sequence[DataModelIdentifier]): Data Model identifier(s).
@@ -187,7 +187,7 @@ def list(
         all_versions: bool = False,
         include_global: bool = False,
     ) -> DataModelList[View] | DataModelList[ViewId]:
-        """`List data models <https://developer.cognite.com/api#tag/Data-models/operation/listDataModels>`_
+        """`List data models <https://api-docs.cognite.com/20230101/tag/Data-models/operation/listDataModels>`_
 
         Args:
             inline_views (bool): Whether to expand the referenced views inline in the returned result.
@@ -234,7 +234,7 @@ def apply(self, data_model: Sequence[DataModelApply]) -> DataModelList: ...
     def apply(self, data_model: DataModelApply) -> DataModel: ...
 
     def apply(self, data_model: DataModelApply | Sequence[DataModelApply]) -> DataModel | DataModelList:
-        """`Create or update one or more data model. <https://developer.cognite.com/api#tag/Data-models/operation/createDataModels>`_
+        """`Create or update one or more data model. <https://api-docs.cognite.com/20230101/tag/Data-models/operation/createDataModels>`_
 
         Args:
             data_model (DataModelApply | Sequence[DataModelApply]): Data model(s) to create or update (upsert).