summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs
diff options
context:
space:
mode:
authorJ08nY2017-06-04 17:41:29 +0200
committerJ08nY2017-08-07 18:03:42 +0200
commite65f5e7bbb34063e252ffecd13fc349c5cb69a24 (patch)
treeb7cb079e8b0bd6c7f5312a38c59d22da68a7eae5 /src/mailman/rest/docs
parent324226f1f859f6be5e932dc9abe638aba268d154 (diff)
downloadmailman-e65f5e7bbb34063e252ffecd13fc349c5cb69a24.tar.gz
mailman-e65f5e7bbb34063e252ffecd13fc349c5cb69a24.tar.zst
mailman-e65f5e7bbb34063e252ffecd13fc349c5cb69a24.zip
Add description attribute to IStyle, expose it in REST.
Diffstat (limited to 'src/mailman/rest/docs')
-rw-r--r--src/mailman/rest/docs/lists.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/mailman/rest/docs/lists.rst b/src/mailman/rest/docs/lists.rst
index 6a034df94..67cbb697a 100644
--- a/src/mailman/rest/docs/lists.rst
+++ b/src/mailman/rest/docs/lists.rst
@@ -191,10 +191,13 @@ Apply a style at list creation time
of a particular type, e.g. discussion lists. We can see which styles are
available, and which is the default style.
- >>> dump_json('http://localhost:9001/3.0/lists/styles')
- default: legacy-default
- http_etag: "..."
- style_names: ['legacy-announce', 'legacy-default']
+ >>> json = call_http('http://localhost:9001/3.0/lists/styles')
+ >>> json['default']
+ 'legacy-default'
+ >>> for style in json['styles']:
+ ... print('{}: {}'.format(style['name'], style['description']))
+ legacy-announce: Announce only mailing list style.
+ legacy-default: Ordinary discussion mailing list style.
When creating a list, if we don't specify a style to apply, the default style
is used. However, we can provide a style name in the POST data to choose a