views: comments: moderation: Fix doc string for unsubscribe
@@ -561,7 +561,7 @@ class API(object):
@apiParam {string} email
The email address of the subscriber.
@apiParam {string} key
- The key to authenticate the subscriber.
+ The key to authenticate the subscriber. Containing a list with the keyword unsubscribe and the email ['unsubscribe', email].
@apiExample {curl} Unsubscribe Alice from replies to comment with id 13:
curl -X GET 'https://comments.example.com/id/13/unsubscribe/alice@example.com/WyJ1bnN1YnNjcmliZSIsImFsaWNlQGV4YW1wbGUuY29tIl0.DdcH9w.Wxou-l22ySLFkKUs7RUHnoM8Kos'
@@ -569,17 +569,11 @@ class API(object):
@apiSuccessExample {html} Using GET:
&lt;!DOCTYPE html&gt;
&lt;html&gt;
- &lt;head&gt;
- &lt;script&gt;
- if (confirm('Delete: Are you sure?')) {
- xhr = new XMLHttpRequest;
- xhr.open('POST', window.location.href);
- xhr.send(null);
- }
- &lt;/script&gt;
-
- @apiSuccessExample Using POST:
- Yo
+ &lt;head&gtSuccessfully unsubscribed&lt;/head&gt;
+ &lt;body&gt;
+ &lt;p&gt;You have been unsubscribed from replies in the given conversation.&lt;/p&gt;
+ &lt;/body&gt;
+ &lt;/html&gt;
"""
def unsubscribe(self, environ, request, id, email, key):
