Skip to content

Commit

Permalink
Update user profile docs url (#1530)
Browse files Browse the repository at this point in the history
  • Loading branch information
gulkaktus authored Nov 29, 2023
1 parent c84e158 commit dd212fa
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions cognite/client/_api/user_profiles.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class UserProfilesAPI(APIClient):
_RESOURCE_PATH = "/profiles"

def me(self) -> UserProfile:
"""`Retrieve your own user profile <https://developer.cognite.com/api#tag/User-profiles/paths/~1profiles~1me/get>`_
"""`Retrieve your own user profile <https://developer.cognite.com/api#tag/User-profiles/operation/getRequesterUserProfile>`_
Retrieves the user profile of the principal issuing the request, i.e. the principal *this* CogniteClient was instantiated with.
Expand Down Expand Up @@ -43,7 +43,7 @@ def retrieve(self, user_identifier: MutableSequence[str] | tuple[str, ...]) -> U
def retrieve(
self, user_identifier: str | MutableSequence[str] | tuple[str, ...]
) -> UserProfile | UserProfileList | None:
"""`Retrieve user profiles by user identifier. <https://developer.cognite.com/api#tag/User-profiles/paths/~1profiles~1byids/post>`_
"""`Retrieve user profiles by user identifier. <https://developer.cognite.com/api#tag/User-profiles/operation/getUserProfilesByIds>`_
Retrieves one or more user profiles indexed by the user identifier in the same CDF project.
Expand Down Expand Up @@ -81,7 +81,7 @@ def retrieve(
return UserProfileList(cast(List[UserProfile], [profiles.get(user) for user in user_identifier]))

def search(self, name: str, limit: int = DEFAULT_LIMIT_READ) -> UserProfileList:
"""`Search for user profiles <https://developer.cognite.com/api#tag/User-profiles/paths/~1profiles~1search/post>`_
"""`Search for user profiles <https://developer.cognite.com/api#tag/User-profiles/operation/userProfilesSearch>`_
Primarily meant for human-centric use-cases and data exploration, not for programs, as the result set ordering and match criteria threshold may change over time.
Args:
Expand All @@ -107,7 +107,7 @@ def search(self, name: str, limit: int = DEFAULT_LIMIT_READ) -> UserProfileList:
)

def list(self, limit: int | None = DEFAULT_LIMIT_READ) -> UserProfileList:
"""`List user profiles <https://developer.cognite.com/api#tag/User-profiles/paths/~1profiles/get>`_
"""`List user profiles <https://developer.cognite.com/api#tag/User-profiles/operation/listUserProfiles>`_
List all user profiles in the current CDF project. The results are ordered alphabetically by name.
Expand Down

0 comments on commit dd212fa

Please sign in to comment.