summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs
diff options
context:
space:
mode:
authorBarry Warsaw2016-04-01 15:14:51 -0400
committerBarry Warsaw2016-04-01 15:14:51 -0400
commitf7e9e4698bdd4cee39c9eb485296cbbfa32369a9 (patch)
tree6dc8557009cbddb4e416faecc329b38b1cc0ad0b /src/mailman/rest/docs
parentafdd3b6deb32cd8cfdad291aba173a63064514f8 (diff)
downloadmailman-f7e9e4698bdd4cee39c9eb485296cbbfa32369a9.tar.gz
mailman-f7e9e4698bdd4cee39c9eb485296cbbfa32369a9.tar.zst
mailman-f7e9e4698bdd4cee39c9eb485296cbbfa32369a9.zip
Allow fall backs for moderation actions.
The `moderation_action` for members and nonmember can now be ``None`` which signals falling back to the appropriate list default action, e.g. `default_member_action` and `default_nonmember_action`. Given by Aurélien Bompard. Closes #189
Diffstat (limited to 'src/mailman/rest/docs')
-rw-r--r--src/mailman/rest/docs/membership.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/mailman/rest/docs/membership.rst b/src/mailman/rest/docs/membership.rst
index ec8765d68..24065ba07 100644
--- a/src/mailman/rest/docs/membership.rst
+++ b/src/mailman/rest/docs/membership.rst
@@ -926,8 +926,8 @@ Moderating a member
===================
The moderation action for a member can be changed by PATCH'ing the
-`moderation_action` attribute.
-::
+`moderation_action` attribute. When the member action falls back to the list
+default, there is no such attribute in the resource.
>>> dump_json('http://localhost:9001/3.0/members/10')
address: http://localhost:9001/3.0/addresses/hperson@example.com
@@ -940,6 +940,10 @@ The moderation action for a member can be changed by PATCH'ing the
self_link: http://localhost:9001/3.0/members/10
user: http://localhost:9001/3.0/users/7
+Patching the moderation action both changes it for the given user, and adds
+the attribute to the member's resource.
+::
+
>>> dump_json('http://localhost:9001/3.0/members/10', {
... 'moderation_action': 'hold',
... }, method='PATCH')