Skip to content

Commit

Permalink
docs; Better description View Identifier (#1715)
Browse files Browse the repository at this point in the history
  • Loading branch information
doctrino committed Apr 17, 2024
1 parent 2ee5614 commit 8ee5267
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion cognite/client/_api/data_modeling/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,10 @@ def retrieve(
"""`Retrieve a single view by id. <https://developer.cognite.com/api#tag/Views/operation/byExternalIdsViews>`_
Args:
ids (ViewIdentifier | Sequence[ViewIdentifier]): View identifier(s)
ids (ViewIdentifier | Sequence[ViewIdentifier]): The view identifier(s). This can be given as a tuple of
strings or a ViewId object. For example, ("my_space", "my_view"), ("my_space", "my_view", "my_version"),
or ViewId("my_space", "my_view", "my_version"). Note that version is optional, if not provided, all versions
will be returned.
include_inherited_properties (bool): Whether to include properties inherited from views this view implements.
all_versions (bool): Whether to return all versions. If false, only the newest version is returned,
Expand Down

0 comments on commit 8ee5267

Please sign in to comment.