Skip to content

Commit a654a05

Browse files
committed
add docstring
1 parent 43c9edb commit a654a05

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

examples/confluence-reader/fetch_confluence_space.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,27 @@ def update_last_modification_date():
8585

8686

8787
class ConfluenceDataSource:
88+
"""
89+
A class for retrieving and managing data from a Confluence space.
90+
91+
This class provides methods to interact with Confluence data, including fetching updated pages,
92+
retrieving all pages, fetching updated documents by parent ID, flagging deleted pages, and updating saved documents.
93+
94+
Attributes:
95+
confluence_url (str): The URL of the Confluence instance.
96+
token (str): The authentication token for accessing Confluence.
97+
space_key (str): The key of the Confluence space to retrieve data from.
98+
loader (ConfluenceLoader): An instance of the ConfluenceLoader for data retrieval.
99+
100+
Methods:
101+
fetch_updated_pages_in_confluence_space(): Fetches updated pages in the Confluence space based on the last modification date.
102+
fetch_all_pages_in_confluence_space(): Retrieves all pages in the Confluence space.
103+
fetch_updated_documents_by_parent_id(parent_page_id): Recursively fetches updated documents based on a parent page ID.
104+
flag_deleted_pages(): Flags deleted pages based on the current Confluence data.
105+
update_saved_documents(): Updates the saved documents in the JSON file with the latest data.
106+
107+
"""
108+
88109
def __init__(self, confluence_url, token, space_key):
89110
self.confluence_url = confluence_url
90111
self.token = token

0 commit comments

Comments
 (0)