Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 12 additions & 2 deletions atlassian/confluence/cloud/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,18 @@ def get_content_by_type(self, content_type, **kwargs):
return self.get("rest/api/content", params={"type": content_type, **kwargs})

def get_all_pages_from_space(self, space_key, **kwargs):
"""Get all pages from space."""
return self._get_paged("rest/api/content", params={"spaceKey": space_key, "type": "page", **kwargs})
"""
Get all pages from space.

:param space_key: The space key to fetch pages from.
:param content_type: OPTIONAL: The content type to return ('page', 'blogpost'). Default: page.
:param kwargs: OPTIONAL: Other query parameters, such as start, limit, status and expand.
Parameters set to None are not sent.
:return: Generator yielding pages one by one, following pagination.
"""
params = {"spaceKey": space_key, "type": kwargs.pop("content_type", None) or "page"}
params.update({key: value for key, value in kwargs.items() if value is not None})
return self._get_paged("rest/api/content", params=params)

def get_all_blog_posts_from_space(self, space_key, **kwargs):
"""Get all blog posts from space."""
Expand Down
14 changes: 12 additions & 2 deletions atlassian/confluence/server/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,18 @@ def get_content_by_id(self, content_id, **kwargs):
return self.get(f"content/{content_id}", **kwargs)

def get_all_pages_from_space(self, space_key, **kwargs):
"""Get all pages from space."""
return self._get_paged("content", params={"spaceKey": space_key, "type": "page", **kwargs})
"""
Get all pages from space.

:param space_key: The space key to fetch pages from.
:param content_type: OPTIONAL: The content type to return ('page', 'blogpost'). Default: page.
:param kwargs: OPTIONAL: Other query parameters, such as start, limit, status and expand.
Parameters set to None are not sent.
:return: Generator yielding pages one by one, following pagination.
"""
params = {"spaceKey": space_key, "type": kwargs.pop("content_type", None) or "page"}
params.update({key: value for key, value in kwargs.items() if value is not None})
return self._get_paged("content", params=params)

def get_all_blog_posts_from_space(self, space_key, **kwargs):
"""Get all blog posts from space."""
Expand Down
5 changes: 3 additions & 2 deletions docs/confluence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,9 @@ Get page info
# Get all pages from Space
# content_type can be 'page' or 'blogpost'. Defaults to 'page'
# expand is a comma separated list of properties to expand on the content.
# max limit is 100. For more you have to loop over start values.
confluence.get_all_pages_from_space(space, start=0, limit=100, status=None, expand=None, content_type='page')
# Returns a generator that follows pagination, so there is no need to loop over start values.
# Wrap it in list() if you need a list.
confluence.get_all_pages_from_space(space, limit=100, status=None, expand=None, content_type='page')

# Get all pages from space as Generator
confluence.get_all_pages_from_space_as_generator(space, start=0, limit=100, status=None, expand=None, content_type='page')
Expand Down
17 changes: 17 additions & 0 deletions tests/confluence/test_confluence_cloud.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,23 @@ def test_get_all_pages_from_space(self, mock_get, confluence_cloud):
absolute=False,
)

@patch.object(ConfluenceCloud, "get")
def test_get_all_pages_from_space_content_type_and_none_params(self, mock_get, confluence_cloud):
"""content_type selects the type, and parameters set to None are not sent (#1708)."""
mock_get.return_value = {"results": [{"id": "123", "title": "Blog Post"}]}
result = confluence_cloud.get_all_pages_from_space(
"TEST", start=0, limit=50, status=None, expand="version", content_type="blogpost"
)
assert list(result) == [{"id": "123", "title": "Blog Post"}]
mock_get.assert_called_once_with(
"rest/api/content",
params={"spaceKey": "TEST", "type": "blogpost", "start": 0, "limit": 50, "expand": "version"},
trailing=None,
data=None,
flags=None,
absolute=False,
)

@patch.object(ConfluenceCloud, "get")
def test_get_all_pages_from_space_pagination(self, mock_get, confluence_cloud):
"""Test get_all_pages_from_space paginates correctly."""
Expand Down
17 changes: 17 additions & 0 deletions tests/confluence/test_confluence_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -827,6 +827,23 @@ def test_get_all_pages_from_space(self, mock_get, confluence_server):
absolute=False,
)

@patch.object(ConfluenceServer, "get")
def test_get_all_pages_from_space_content_type_and_none_params(self, mock_get, confluence_server):
"""content_type selects the type, and parameters set to None are not sent (#1708)."""
mock_get.return_value = {"results": [{"id": "123", "title": "Blog Post"}]}
result = confluence_server.get_all_pages_from_space(
"TEST", start=0, limit=50, status=None, expand="version", content_type="blogpost"
)
assert list(result) == [{"id": "123", "title": "Blog Post"}]
mock_get.assert_called_once_with(
"content",
params={"spaceKey": "TEST", "type": "blogpost", "start": 0, "limit": 50, "expand": "version"},
trailing=None,
data=None,
flags=None,
absolute=False,
)

# Pagination Tests for _get_paged (fix for issue #1598)
@patch.object(ConfluenceServer, "get")
def test_pagination_with_next_link_as_string(self, mock_get, confluence_server):
Expand Down
Loading