Saimon/add docs file access (#285)

saimonation · web-flow · commit e07a695559e7 · 2025-03-18T21:20:25.000-04:00
diff --git a/docs/source/UserGuides/Edge/Quickstart.rst b/docs/source/UserGuides/Edge/Quickstart.rst
@@ -4,7 +4,7 @@ Quickstart
 
 Eager to get started? This page gives a good introduction in how to get started with the CTERA SDK and the Edge Filer APIs.
 
-First, make sure that aiohttp is :ref:`installed<cterasdk-installation>` and up-to-date
+First, make sure that cterasdk is :ref:`installed<cterasdk-installation>` and up-to-date
 
 Let’s get started with some simple examples.
 
diff --git a/docs/source/UserGuides/Portal/Files.rst b/docs/source/UserGuides/Portal/Files.rst
@@ -8,17 +8,47 @@ List
 .. automethod:: cterasdk.core.files.browser.FileBrowser.listdir
    :noindex:
 
+Use the following API to list the contents of a directory as a Global Administrator.
+This API requires that the administrator has *Access End User Folders*.
+For more details, see `Customizing Administrator Roles` <https://kb.ctera.com/docs/customizing-administrator-roles-2>`_.
+
 .. code:: python
 
    with GlobalAdmin('tenant.ctera.com') as admin:
       admin.login('admin-user', 'admin-pass')
-      admin.files.listdir('Users/John Smith/My Files')
-      admin.files.listdir('Users/John Smith/My Files', include_deleted=True)  # include deleted files
+
+      """List all sub-directories"""
+      for f in admin.files.listdir('Users/John Smith/My Files'):
+          if f.isFolder:
+              print({
+                  f.name,
+                  f.href,
+                  f.permalink  # a URL that links directly to a specific file
+              })
+
+..
+
+Use the following API to list the contents of a directory as an End User or a Team Portal Administrator.
+This API requires that the Team Portal Administrator has *Access End User Folders*.
+For more details, see `Viewing Folder Content <https://kb.ctera.com/docs/managing-folders-1#viewing-folder-content>`_.
+
+.. code:: python
 
    with ServicesPortal('tenant.ctera.com') as user:
       user.login('username', 'user-password')
-      user.files.listdir('My Files/Documents')
-      user.files.listdir('My Files/Documents', include_deleted=True)  # include deleted files
+      for f in user.files.listdir('My Files/Documents'):
+          if not f.isFolder:
+              print({
+                  f.name,
+                  f.href,
+                  f.size,
+                  f.lastmodified,
+                  f.permalink  # a URL that links directly to a specific file
+              })
+
+      """List all deleted files"""
+      deleted_files = [f.href for f in user.files.listdir('My Files/Documents', include_deleted=True) if f.isDeleted]
+      print(deleted_files)
 
 .. automethod:: cterasdk.core.files.browser.FileBrowser.walk
    :noindex:
diff --git a/docs/source/UserGuides/Portal/Quickstart.rst b/docs/source/UserGuides/Portal/Quickstart.rst
@@ -4,7 +4,7 @@ Quickstart
 
 Eager to get started? This page gives a good introduction in how to get started with the CTERA SDK and the Portal APIs.
 
-First, make sure that aiohttp is :ref:`installed<cterasdk-installation>` and up-to-date
+First, make sure that cterasdk is :ref:`installed<cterasdk-installation>` and up-to-date
 
 Let’s get started with some simple examples.
 
diff --git a/docs/source/api/cterasdk.clients.tracers.logger.rst b/docs/source/api/cterasdk.clients.tracers.logger.rst
@@ -0,0 +1,7 @@
+cterasdk.clients.tracers.logger module
+======================================
+
+.. automodule:: cterasdk.clients.tracers.logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/cterasdk.clients.tracers.logging_tracers.rst b/docs/source/api/cterasdk.clients.tracers.logging_tracers.rst
diff --git a/docs/source/api/cterasdk.clients.tracers.postman.rst b/docs/source/api/cterasdk.clients.tracers.postman.rst
@@ -0,0 +1,7 @@
+cterasdk.clients.tracers.postman module
+=======================================
+
+.. automodule:: cterasdk.clients.tracers.postman
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/cterasdk.clients.tracers.rst b/docs/source/api/cterasdk.clients.tracers.rst
@@ -11,5 +11,6 @@ Submodules
 
 .. toctree::
 
-   cterasdk.clients.tracers.logging_tracers
-   cterasdk.clients.tracers.session_tracers
+   cterasdk.clients.tracers.logger
+   cterasdk.clients.tracers.postman
+   cterasdk.clients.tracers.session
diff --git a/docs/source/api/cterasdk.clients.tracers.session.rst b/docs/source/api/cterasdk.clients.tracers.session.rst
@@ -0,0 +1,7 @@
+cterasdk.clients.tracers.session module
+=======================================
+
+.. automodule:: cterasdk.clients.tracers.session
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/cterasdk.clients.tracers.session_tracers.rst b/docs/source/api/cterasdk.clients.tracers.session_tracers.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,18 +6,20 @@ The CTERA SDK for Python provides developers with powerful tools to automate the
 of the CTERA Global File System, streamline data management tasks,
 and seamlessly integrate CTERA's global namespace with their applications.
 
-Current version is |release|.
-
 .. _GitHub: https://github.com/ctera/ctera-python-sdk
 
 
 Key Features
 ============
 
-- Supports configuration management for CTERA Drive, Edge Filer and Portal, including remote access
-- Supports managing CTERA Migrate
-- Supports file access for CTERA Edge Filer and Portal
-
+1. Configuration Management:
+    1. `Portal Management <UserGuides/Portal/Administration.html>`_
+    2. `Edge Filer Management <UserGuides/Edge/Configuration.html>`_, including remote access.
+2. Managing `Data Discovery and Migration Jobs <UserGuides/Edge/Migration.html>`_
+3. File Data Management APIs for `CTERA Edge Filer <UserGuides/Edge/Index.html>`_ and `CTERA Portal <UserGuides/Portal/Index.html>`_.
+4. Data Services Framework:
+    1. `Subscribing to File System Notifications <UserGuides/DataServices/NotificationService.html>`_
+    2. `CTERA Direct IO <UserGuides/DataServices/DirectIO.html>`_, enabling parallel high-performnace retrieval directly from object storage.
 
 .. _cterasdk-installation:
 
