Merge pull request #2057 from walterrowe/main

nejch · web-flow · commit 0f607f685b1e · 2022-06-06T11:15:09.000+02:00
docs: update docs to reflect addition of mutually exclusive attributes
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -113,10 +113,11 @@ Examples:
    items when using listing methods. See the :ref:`pagination` section for more
    information.
 
-You can list the mandatory and optional attributes for object creation and
-update with the manager's ``get_create_attrs()`` and ``get_update_attrs()``
-methods. They return 2 tuples, the first one is the list of mandatory
-attributes, the second one is the list of optional attribute:
+You can list the mandatory, optional, and mutually exclusive attributes for object
+creation and update with the manager's ``get_create_attrs()`` and ``get_update_attrs()``
+methods. They return 3 tuples. The first tuple is the list of mandatory attributes.
+The second tuple is the list of optional attributes. The third tuple is the mutually
+exclusive attributes:
 
 .. code-block:: python
 
diff --git a/docs/ext/manager_tmpl.j2 b/docs/ext/manager_tmpl.j2
@@ -8,14 +8,20 @@
 {% if cls._create_attrs %}
 **Object Creation**
 {% if cls._create_attrs[0] %}
-Mandatory attributes:
-{% for item in cls._create_attrs[0] %}
+Mandatory attributes for object create:
+{% for item in cls._create_attrs.required %}
 - ``{{ item }}``
 {% endfor %}
 {% endif %}
 {% if cls._create_attrs[1] %}
-Optional attributes:
-{% for item in cls._create_attrs[1] %}
+Optional attributes for object create:
+{% for item in cls._create_attrs.optional %}
+- ``{{ item }}``
+{% endfor %}
+{% endif %}
+{% if cls._create_attrs[2] %}
+Mutually exclusive attributes for object create:
+{% for item in cls._create_attrs.exlusive %}
 - ``{{ item }}``
 {% endfor %}
 {% endif %}
@@ -25,13 +31,19 @@ Optional attributes:
 **Object update**
 {% if cls._update_attrs[0] %}
 Mandatory attributes for object update:
-{% for item in cls._update_attrs[0] %}
+{% for item in cls._update_attrs.required %}
 - ``{{ item }}``
 {% endfor %}
 {% endif %}
 {% if cls._update_attrs[1] %}
 Optional attributes for object update:
-{% for item in cls._update_attrs[1] %}
+{% for item in cls._update_attrs.optional %}
+- ``{{ item }}``
+{% endfor %}
+{% endif %}
+{% if cls._update_attrs[2] %}
+Mutually exclusive attributes for object update:
+{% for item in cls._update_attrs.exlusive %}
 - ``{{ item }}``
 {% endfor %}
 {% endif %}
