Skip to content

Commit

Permalink
fix all broken links in docs... (#1403)
Browse files Browse the repository at this point in the history
  • Loading branch information
haakonvt authored Oct 3, 2023
1 parent 96d99c5 commit 39c2228
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 15 deletions.
8 changes: 4 additions & 4 deletions cognite/client/_api/data_modeling/instances.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ def retrieve(
sources: ViewIdentifier | Sequence[ViewIdentifier] | View | Sequence[View] | None = None,
include_typing: bool = False,
) -> InstancesResult:
"""`Retrieve one or more instance by id(s). <https://developer.cognite.com/api#tag/Instances/tag/Instances/operation/byExternalIdsInstances>`_
"""`Retrieve one or more instance by id(s). <https://developer.cognite.com/api#tag/Instances/operation/byExternalIdsInstances>`_
Args:
nodes (NodeId | Sequence[NodeId] | tuple[str, str] | Sequence[tuple[str, str]] | None): Node ids
Expand Down Expand Up @@ -371,7 +371,7 @@ def delete(
nodes: NodeId | Sequence[NodeId] | tuple[str, str] | Sequence[tuple[str, str]] | None = None,
edges: EdgeId | Sequence[EdgeId] | tuple[str, str] | Sequence[tuple[str, str]] | None = None,
) -> InstancesDeleteResult:
"""`Delete one or more instances <https://developer.cognite.com/api#tag/Instances/tag/Instances/operation/deleteBulk>`_
"""`Delete one or more instances <https://developer.cognite.com/api#tag/Instances/operation/deleteBulk>`_
Args:
nodes (NodeId | Sequence[NodeId] | tuple[str, str] | Sequence[tuple[str, str]] | None): Node ids
Expand Down Expand Up @@ -549,7 +549,7 @@ def apply(
skip_on_version_conflict: bool = False,
replace: bool = False,
) -> InstancesApplyResult:
"""`Add or update (upsert) instances. <https://developer.cognite.com/api#tag/Instances/tag/Instances/operation/applyNodeAndEdges>`_
"""`Add or update (upsert) instances. <https://developer.cognite.com/api#tag/Instances/operation/applyNodeAndEdges>`_
Args:
nodes (NodeApply | Sequence[NodeApply] | None): Nodes to apply
Expand Down Expand Up @@ -999,7 +999,7 @@ def list(
sort: Sequence[InstanceSort | dict] | InstanceSort | dict | None = None,
filter: Filter | dict | None = None,
) -> NodeList | EdgeList:
"""`List instances <https://developer.cognite.com/api#tag/Instances/tag/Instances/operation/advancedListInstance>`_
"""`List instances <https://developer.cognite.com/api#tag/Instances/operation/advancedListInstance>`_
Args:
instance_type (Literal["node", "edge"]): Whether to query for nodes or edges.
Expand Down
3 changes: 1 addition & 2 deletions cognite/client/_api/diagrams.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,8 @@ class DiagramsAPI(APIClient):

def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
super().__init__(config, api_version, cognite_client)
# https://docs.cognite.com/api/playground/#operation/diagramDetect
# https://developer.cognite.com/api#tag/Engineering-diagrams/operation/diagramDetect
self._DETECT_API_FILE_LIMIT = 50
# https://docs.cognite.com/api/playground/#operation/diagramDetectMultipleResults
self._DETECT_API_STATUS_JOB_LIMIT = 1000

def _camel_post(
Expand Down
12 changes: 6 additions & 6 deletions cognite/client/_api/extractionpipelines.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ def list(
created_time: dict[str, Any] | TimestampRange | None = None,
limit: int | None = DEFAULT_LIMIT_READ,
) -> ExtractionPipelineRunList:
"""`List runs for an extraction pipeline with given external_id <https://developer.cognite.com/api#tag/Extraction-Pipelines/operation/filterRuns>`_
"""`List runs for an extraction pipeline with given external_id <https://developer.cognite.com/api#tag/Extraction-Pipelines-Runs/operation/filterRuns>`_
Args:
external_id (str): Extraction pipeline external Id.
Expand Down Expand Up @@ -283,7 +283,7 @@ def create(self, run: Sequence[ExtractionPipelineRun]) -> ExtractionPipelineRunL
def create(
self, run: ExtractionPipelineRun | Sequence[ExtractionPipelineRun]
) -> ExtractionPipelineRun | ExtractionPipelineRunList:
"""`Create one or more extraction pipeline runs. <https://developer.cognite.com/api#tag/Extraction-Pipelines/operation/createRuns>`_
"""`Create one or more extraction pipeline runs. <https://developer.cognite.com/api#tag/Extraction-Pipelines-Runs/operation/createRuns>`_
You can create an arbitrary number of extraction pipeline runs, and the SDK will split the request into multiple requests.
Expand Down Expand Up @@ -313,7 +313,7 @@ class ExtractionPipelineConfigsAPI(APIClient):
def retrieve(
self, external_id: str, revision: int | None = None, active_at_time: int | None = None
) -> ExtractionPipelineConfig:
"""`Retrieve a specific configuration revision, or the latest by default <https://developer.cognite.com/api#tag/Extraction-Pipelines/operation/getExtPipeConfigRevision>`
"""`Retrieve a specific configuration revision, or the latest by default <https://developer.cognite.com/api#tag/Extraction-Pipelines-Config/operation/getExtPipeConfigRevision>`
By default the latest configuration revision is retrieved, or you can specify a timestamp or a revision number.
Expand All @@ -339,7 +339,7 @@ def retrieve(
return ExtractionPipelineConfig._load(response.json(), cognite_client=self._cognite_client)

def list(self, external_id: str) -> ExtractionPipelineConfigRevisionList:
"""`Retrieve all configuration revisions from an extraction pipeline <https://developer.cognite.com/api#tag/Extraction-Pipelines/operation/listExtPipeConfigRevisions>`
"""`Retrieve all configuration revisions from an extraction pipeline <https://developer.cognite.com/api#tag/Extraction-Pipelines-Config/operation/listExtPipeConfigRevisions>`
Args:
external_id (str): External id of the extraction pipeline to retrieve config from.
Expand All @@ -359,7 +359,7 @@ def list(self, external_id: str) -> ExtractionPipelineConfigRevisionList:
return ExtractionPipelineConfigRevisionList._load(response.json()["items"], cognite_client=self._cognite_client)

def create(self, config: ExtractionPipelineConfig) -> ExtractionPipelineConfig:
"""`Create a new configuration revision <https://developer.cognite.com/api#tag/Extraction-Pipelines/operation/createExtPipeConfig>`
"""`Create a new configuration revision <https://developer.cognite.com/api#tag/Extraction-Pipelines-Config/operation/createExtPipeConfig>`
Args:
config (ExtractionPipelineConfig): Configuration revision to create.
Expand All @@ -380,7 +380,7 @@ def create(self, config: ExtractionPipelineConfig) -> ExtractionPipelineConfig:
return ExtractionPipelineConfig._load(response.json(), cognite_client=self._cognite_client)

def revert(self, external_id: str, revision: int) -> ExtractionPipelineConfig:
"""`Revert to a previous configuration revision <https://developer.cognite.com/api#tag/Extraction-Pipelines/operation/createExtPipeConfig>`
"""`Revert to a previous configuration revision <https://developer.cognite.com/api#tag/Extraction-Pipelines-Config/operation/revertExtPipeConfigRevision>`
Args:
external_id (str): External id of the extraction pipeline to revert revision for.
Expand Down
2 changes: 1 addition & 1 deletion cognite/client/_api/functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ def call(
data: dict | None = None,
wait: bool = True,
) -> FunctionCall:
"""`Call a function by its ID or external ID. <https://developer.cognite.com/api#tag/Functions/operation/postFunctionsCall>`_.
"""`Call a function by its ID or external ID. <https://developer.cognite.com/api#tag/Function-calls/operation/postFunctionsCall>`_.
Args:
id (int | None): ID
Expand Down
4 changes: 2 additions & 2 deletions cognite/client/_api/transformations/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ async def run_async(
return await job.wait_async(timeout=timeout)

def cancel(self, transformation_id: int | None = None, transformation_external_id: str | None = None) -> None:
"""`Cancel a running transformation. <https://developer.cognite.com/api#tag/Transformations/operation/cancelTransformation>`_
"""`Cancel a running transformation. <https://developer.cognite.com/api#tag/Transformations/operation/postApiV1ProjectsProjectTransformationsCancel>`_
Args:
transformation_id (int | None): Transformation internal id
Expand Down Expand Up @@ -445,7 +445,7 @@ def preview(
source_limit: int | None = 100,
infer_schema_limit: int | None = 1000,
) -> TransformationPreviewResult:
"""`Preview the result of a query. <https://developer.cognite.com/api#tag/Transformations/operation/runPreview>`_
"""`Preview the result of a query. <https://developer.cognite.com/api#tag/Query/operation/runPreview>`_
Args:
query (str | None): SQL query to run for preview.
Expand Down

0 comments on commit 39c2228

Please sign in to comment.