summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs
diff options
context:
space:
mode:
authorBarry Warsaw2017-05-23 12:32:03 -0700
committerBarry Warsaw2017-05-23 12:39:39 -0700
commit3bd2a292b7300ce354de1ed405dc8665311acd9f (patch)
tree4ce714a6e9b964a673211246c8ba25219e430e79 /src/mailman/rest/docs
parenta7c563e9048d302c52558e6e2202fdfb49961843 (diff)
downloadmailman-3bd2a292b7300ce354de1ed405dc8665311acd9f.tar.gz
mailman-3bd2a292b7300ce354de1ed405dc8665311acd9f.tar.zst
mailman-3bd2a292b7300ce354de1ed405dc8665311acd9f.zip
Add self_links to the system configuration resources.
Closes #335
Diffstat (limited to 'src/mailman/rest/docs')
-rw-r--r--src/mailman/rest/docs/systemconf.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/mailman/rest/docs/systemconf.rst b/src/mailman/rest/docs/systemconf.rst
index 213929a42..a65b81ab8 100644
--- a/src/mailman/rest/docs/systemconf.rst
+++ b/src/mailman/rest/docs/systemconf.rst
@@ -8,6 +8,7 @@ get a list of all defined sections.
>>> dump_json('http://localhost:9001/3.0/system/configuration')
http_etag: ...
sections: ['antispam', 'archiver.mail_archive', 'archiver.master', ...
+ self_link: http://localhost:9001/3.0/system/configuration
You can also get all the values for a particular section, such as the
``[mailman]`` section...
@@ -25,6 +26,7 @@ You can also get all the values for a particular section, such as the
pending_request_life: 3d
post_hook:
pre_hook:
+ self_link: http://localhost:9001/3.0/system/configuration/mailman
sender_headers: from from_ reply-to sender
site_owner: noreply@example.com
@@ -36,6 +38,7 @@ You can also get all the values for a particular section, such as the
org_domain_data_url: https://publicsuffix.org/list/public_suffix_list.dat
resolver_lifetime: 5s
resolver_timeout: 3s
+ self_link: http://localhost:9001/3.0/system/configuration/dmarc
Dotted section names work too, for example, to get the French language
settings section.
@@ -45,3 +48,4 @@ settings section.
description: French
enabled: yes
http_etag: ...
+ self_link: http://localhost:9001/3.0/system/configuration/language.fr