PYCBC-1648: Add update_collection and missing collection settings to API docs

Changes
=======
Added to API docs:
* CreateCollectionSettings
* update_collection and relevant classes (UpdateCollectionSettings, UpdateCollectionOptions)
* max_expiry & history CollectionSpec properties

Change-Id: I9bace3898f5184abe29a1e5a2f37dd80bd4cd4b2
Reviewed-on: https://review.couchbase.org/c/couchbase-python-client/+/221999
Tested-by: Build Bot <[email protected]>
Reviewed-by: Jared Casey <[email protected]>

Author: DemetrisChr

couchbase/management/collections.py

@@ -164,7 +164,7 @@ def create_collection(self,  # noqa: F811
         Args:
             scope_name (str): The name of the scope the collection will be created in.
             collection_name (str): The name of the collection to be created
-            settings (:class:`~couchbase.management.options.CreateCollectionSettings`, optional): Settings to apply for the collection
+            settings (:class:`~.CreateCollectionSettings`, optional): Settings to apply for the collection
             options (:class:`~couchbase.management.options.CreateCollectionOptions`): Optional parameters for this operation.
             **kwargs (Dict[str, Any]): keyword arguments that can be used as optional parameters for this operation.
 
@@ -254,7 +254,7 @@ def update_collection(self,
         Args:
             scope_name (str): The name of the scope the collection is in.
             collection_name (str): The name of the collection that will be updated
-            settings (:class:`~couchbase.management.options.UpdateCollectionSettings`, optional): Settings to apply for the collection
+            settings (:class:`~.UpdateCollectionSettings`, optional): Settings to apply for the collection
             options (:class:`~couchbase.management.options.UpdateCollectionOptions`): Optional parameters for this operation.
             **kwargs (Dict[str, Any]): keyword arguments that can be used as optional parameters for this operation.
 

couchbase/management/logic/collections_logic.py

@@ -265,6 +265,10 @@ def update_collection(self,
 
 
 class CreateCollectionSettings:
+    """
+        Specifies settings for a collection that will be created.
+    """
+
     def __init__(self,
                  max_expiry=None,  # type: Optional[timedelta]
                  history=None,     # type: Optional[bool]
@@ -275,7 +279,7 @@ def __init__(self,
     @property
     def max_expiry(self) -> Optional[timedelta]:
         """
-            Optional[timedelta]: The expiry for documents in the collection.
+            Optional[timedelta]: The maximum expiry for documents in the collection.
         """
         return self._max_expiry
 
@@ -289,6 +293,10 @@ def history(self) -> Optional[bool]:
 
 
 class UpdateCollectionSettings:
+    """
+        Specifies settings for a collection that will be updated.
+    """
+
     def __init__(self,
                  max_expiry=None,  # type: Optional[timedelta]
                  history=None,     # type: Optional[bool]
@@ -299,7 +307,7 @@ def __init__(self,
     @property
     def max_expiry(self) -> Optional[timedelta]:
         """
-            Optional[timedelta]: The expiry for documents in the collection.
+            Optional[timedelta]: The maximum expiry for documents in the collection.
         """
         return self._max_expiry
 
@@ -339,14 +347,19 @@ def max_expiry(self) -> Optional[timedelta]:
     @property
     def max_ttl(self) -> Optional[timedelta]:
         """
-            **DEPRECATED**
             Optional[timedelta]: The expiry for documents in the collection.
+
+            **DEPRECATED** Use :attr:`max_expiry` instead.
         """
         Supportability.class_property_deprecated('max_ttl', 'max_expiry')
         return self._max_expiry
 
     @property
     def history(self) -> Optional[bool]:
+        """
+            Optional[bool]: Whether history retention is enabled in the collection. None represents the bucket-level
+            setting.
+        """
         return self._history
 
     @property

docs/couchbase_api/couchbase_management.rst

@@ -28,6 +28,8 @@ Collection Management
 
 .. autoclass:: CollectionManager
 
+    .. automethod:: create_collection
+
     .. py:method:: create_collection(collection: CollectionSpec, *options: CreateCollectionOptions, **kwargs: Dict[str, Any]) -> None
         :noindex:
 
@@ -45,9 +47,12 @@ Collection Management
         :raises `~couchbase.exceptions.CollectionAlreadyExistsException`: If the collection already exists.
         :raises `~couchbase.exceptions.ScopeNotFoundException`: If the scope does not exist.
 
-    .. automethod:: create_collection
     .. automethod:: create_scope
 
+    .. automethod:: update_collection
+
+    .. automethod:: drop_collection
+
     .. py:method:: drop_collection(collection: CollectionSpec, *options: DropCollectionOptions, **kwargs: Dict[str, Any]) -> None
         :noindex:
 
@@ -64,15 +69,26 @@ Collection Management
         :type \*\*kwargs: Dict[str, Any]
         :raises `~couchbase.exceptions.CollectionNotFoundException`: If the collection does not exist.
 
-    .. automethod:: drop_collection
     .. automethod:: drop_scope
     .. automethod:: get_all_scopes
 
+.. autoclass:: CreateCollectionSettings
+
+    .. autoproperty:: max_expiry
+    .. autoproperty:: history
+
+.. autoclass:: UpdateCollectionSettings
+
+    .. autoproperty:: max_expiry
+    .. autoproperty:: history
+
 .. autoclass:: CollectionSpec
 
     .. autoproperty:: name
     .. autoproperty:: scope_name
+    .. autoproperty:: max_expiry
     .. autoproperty:: max_ttl
+    .. autoproperty:: history
 
 .. autoclass:: ScopeSpec
 

docs/couchbase_api/management_options.rst

@@ -48,6 +48,10 @@ CreateScopeOptions
 ++++++++++++++++++++++++
 .. autoclass:: CreateScopeOptions
 
+UpdateCollectionOptions
+++++++++++++++++++++++++
+.. autoclass:: UpdateCollectionOptions
+
 DropCollectionOptions
 ++++++++++++++++++++++++
 .. autoclass:: DropCollectionOptions