Skip to content

Add projection parameter to get_communities #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mpbraendle wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add projection parameter to get_communities #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions dspace_rest_client/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,7 +1036,7 @@ def download_bitstream(self, uuid=None):

# PAGINATION
def get_communities(
self, uuid=None, page=0, size=20, sort=None, top=False, embeds=None
self, uuid=None, page=0, size=20, sort=None, top=False, embeds=None, projection=None
):
"""
Get communities - either all, for single UUID, or all top-level (ie no sub-communities)
Expand All @@ -1045,6 +1045,7 @@ def get_communities(
@param size: integer size (default: 20)
@param top: whether to restrict search to top communities (default: false)
@param embeds: list of resources to embed in response JSON
@param projection: projection parameter
@return: list of communities, or None if error
"""
url = f"{self.API_ENDPOINT}/core/communities"
Expand All @@ -1055,13 +1056,18 @@ def get_communities(
params["page"] = page
if sort is not None:
params["sort"] = sort
if projection is not None:
params["projection"] = projection
if uuid is not None:
try:
# This isn't used, but it'll throw a ValueError if not a valid UUID
id = UUID(uuid).version
# Set URL and parameters
url = f"{url}/{uuid}"
params = None
if projection is not None:
params["projection"] = projection
else:
params = None
except ValueError:
logging.error("Invalid community UUID: %s", uuid)
return None
Expand Down