diff options
Diffstat (limited to 'src/mailman/rest/docs')
| -rw-r--r-- | src/mailman/rest/docs/addresses.rst | 7 | ||||
| -rw-r--r-- | src/mailman/rest/docs/basic.rst | 5 | ||||
| -rw-r--r-- | src/mailman/rest/docs/domains.rst | 8 | ||||
| -rw-r--r-- | src/mailman/rest/docs/helpers.rst | 12 | ||||
| -rw-r--r-- | src/mailman/rest/docs/membership.rst | 4 | ||||
| -rw-r--r-- | src/mailman/rest/docs/moderation.rst | 7 | ||||
| -rw-r--r-- | src/mailman/rest/docs/preferences.rst | 2 | ||||
| -rw-r--r-- | src/mailman/rest/docs/users.rst | 30 |
8 files changed, 10 insertions, 65 deletions
diff --git a/src/mailman/rest/docs/addresses.rst b/src/mailman/rest/docs/addresses.rst index fec0c194b..670a12ef5 100644 --- a/src/mailman/rest/docs/addresses.rst +++ b/src/mailman/rest/docs/addresses.rst @@ -64,13 +64,6 @@ But his address record can be accessed with the case-preserved version too. registered_on: 2005-08-01T07:49:23 self_link: http://localhost:9001/3.0/addresses/bart.person@example.com -A non-existent email address can't be retrieved. - - >>> dump_json('http://localhost:9001/3.0/addresses/nobody@example.com') - Traceback (most recent call last): - ... - HTTPError: HTTP Error 404: 404 Not Found - When an address has a real name associated with it, this is also available in the REST API. diff --git a/src/mailman/rest/docs/basic.rst b/src/mailman/rest/docs/basic.rst index aa0205874..576aacc2c 100644 --- a/src/mailman/rest/docs/basic.rst +++ b/src/mailman/rest/docs/basic.rst @@ -24,13 +24,10 @@ Credentials When the `Authorization` header contains the proper credentials, the request succeeds. - >>> from base64 import b64encode >>> from httplib2 import Http - >>> auth = b64encode('{0}:{1}'.format(config.webservice.admin_user, - ... config.webservice.admin_pass)) >>> headers = { ... 'Content-Type': 'application/x-www-form-urlencode', - ... 'Authorization': 'Basic ' + auth, + ... 'Authorization': 'Basic cmVzdGFkbWluOnJlc3RwYXNz', ... } >>> url = 'http://localhost:9001/3.0/system' >>> response, content = Http().request(url, 'GET', None, headers) diff --git a/src/mailman/rest/docs/domains.rst b/src/mailman/rest/docs/domains.rst index b28326f73..a78dacd85 100644 --- a/src/mailman/rest/docs/domains.rst +++ b/src/mailman/rest/docs/domains.rst @@ -228,13 +228,5 @@ Domains can also be deleted via the API. server: ... status: 204 -It is an error to delete a domain twice. - - >>> dump_json('http://localhost:9001/3.0/domains/lists.example.com', - ... method='DELETE') - Traceback (most recent call last): - ... - HTTPError: HTTP Error 404: 404 Not Found - .. _Domains: ../../model/docs/domains.html diff --git a/src/mailman/rest/docs/helpers.rst b/src/mailman/rest/docs/helpers.rst index 2dd65bbb8..5614e6544 100644 --- a/src/mailman/rest/docs/helpers.rst +++ b/src/mailman/rest/docs/helpers.rst @@ -45,7 +45,7 @@ gets modified to contain the etag under the ``http_etag`` key. >>> resource = dict(geddy='bass', alex='guitar', neil='drums') >>> json_data = etag(resource) >>> print(resource['http_etag']) - "96e036d66248cab746b7d97047e08896fcfb2493" + "6929ecfbda2282980a4818fb75f82e812077f77a" For convenience, the etag function also returns the JSON representation of the dictionary after tagging, since that's almost always what you want. @@ -58,7 +58,7 @@ dictionary after tagging, since that's almost always what you want. >>> dump_msgdata(data) alex : guitar geddy : bass - http_etag: "96e036d66248cab746b7d97047e08896fcfb2493" + http_etag: "6929ecfbda2282980a4818fb75f82e812077f77a" neil : drums @@ -82,7 +82,7 @@ On valid input, the validator can be used as a ``**keyword`` argument. >>> def print_request(one, two, three): ... print(repr(one), repr(two), repr(three)) >>> print_request(**validator(FakeRequest)) - 1 u'two' True + 1 'two' True On invalid input, an exception is raised. @@ -129,15 +129,15 @@ However, if optional keys are missing, it's okay. >>> def print_request(one, two, three, four=None, five=None): ... print(repr(one), repr(two), repr(three), repr(four), repr(five)) >>> print_request(**validator(FakeRequest)) - 1 u'two' True 4 5 + 1 'two' True 4 5 >>> del FakeRequest.params['four'] >>> print_request(**validator(FakeRequest)) - 1 u'two' True None 5 + 1 'two' True None 5 >>> del FakeRequest.params['five'] >>> print_request(**validator(FakeRequest)) - 1 u'two' True None None + 1 'two' True None None But if the optional values are present, they must of course also be valid. diff --git a/src/mailman/rest/docs/membership.rst b/src/mailman/rest/docs/membership.rst index 30e69d9f5..b0b884d51 100644 --- a/src/mailman/rest/docs/membership.rst +++ b/src/mailman/rest/docs/membership.rst @@ -572,7 +572,7 @@ Elly is now a known user, and a member of the mailing list. <User "Elly Person" (...) at ...> >>> set(member.list_id for member in elly.memberships.members) - set([u'ant.example.com']) + {'ant.example.com'} >>> dump_json('http://localhost:9001/3.0/members') entry 0: @@ -674,7 +674,7 @@ so she leaves from the mailing list. Elly is no longer a member of the mailing list. >>> set(member.mailing_list for member in elly.memberships.members) - set([]) + set() Digest delivery diff --git a/src/mailman/rest/docs/moderation.rst b/src/mailman/rest/docs/moderation.rst index 6e2dbb43c..6aec921f0 100644 --- a/src/mailman/rest/docs/moderation.rst +++ b/src/mailman/rest/docs/moderation.rst @@ -141,13 +141,6 @@ The held message can be discarded. server: ... status: 204 -After which, the message is gone from the moderation queue. - - >>> dump_json(url(request_id)) - Traceback (most recent call last): - ... - HTTPError: HTTP Error 404: 404 Not Found - Messages can also be accepted via the REST API. Let's hold a new message for moderation. :: diff --git a/src/mailman/rest/docs/preferences.rst b/src/mailman/rest/docs/preferences.rst index b9332c954..172a9bedd 100644 --- a/src/mailman/rest/docs/preferences.rst +++ b/src/mailman/rest/docs/preferences.rst @@ -162,7 +162,7 @@ deleted. >>> dump_json('http://localhost:9001/3.0/addresses/anne@example.com' ... '/preferences') acknowledge_posts: True - http_etag: "1ff07b0367bede79ade27d217e12df3915aaee2b" + http_etag: "..." preferred_language: ja self_link: http://localhost:9001/3.0/addresses/anne@example.com/preferences diff --git a/src/mailman/rest/docs/users.rst b/src/mailman/rest/docs/users.rst index 04533f578..dcebba3e6 100644 --- a/src/mailman/rest/docs/users.rst +++ b/src/mailman/rest/docs/users.rst @@ -277,27 +277,6 @@ Users can also be deleted via the API. server: ... status: 204 -Cris's resource cannot be retrieved either by email address... - - >>> dump_json('http://localhost:9001/3.0/users/cris@example.com') - Traceback (most recent call last): - ... - HTTPError: HTTP Error 404: 404 Not Found - -...or user id. - - >>> dump_json('http://localhost:9001/3.0/users/3') - Traceback (most recent call last): - ... - HTTPError: HTTP Error 404: 404 Not Found - -Cris's address records no longer exist either. - - >>> dump_json('http://localhost:9001/3.0/addresses/cris@example.com') - Traceback (most recent call last): - ... - HTTPError: HTTP Error 404: 404 Not Found - User addresses ============== @@ -416,12 +395,3 @@ This time, Elly successfully logs into Mailman. date: ... server: ... status: 204 - -But this time, she is unsuccessful. - - >>> dump_json('http://localhost:9001/3.0/users/5/login', { - ... 'cleartext_password': 'not-the-password', - ... }, method='POST') - Traceback (most recent call last): - ... - HTTPError: HTTP Error 403: 403 Forbidden |