-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
On 08/26/2014 11:59 PM, Barry Warsaw wrote:
I'm considering making two small incompatible changes to the JSON representation of list requests in the REST API. Here's what you currently get (from rest/docs/moderation.rst) for a held subscription request:
dump_json('http://localhost:9001/3.0/lists/ant@example.com/requests/1')
address: anne@example.com delivery_mode: regular display_name: Anne Person http_etag: "..." language: en password: password request_id: 1 type: subscription when: 2005-08-01T07:49:23
I want to change the 'address' key to 'email' and remove the 'password' key, e.g.:
[...]
I'd like to just get rid of these and break compatibility, but if it would cause pain to Postorius or other tools, I can deprecate the old names and remove them in the future.
Let me know what you think.
We're still in beta, so I think breaking backwards compatibility is justifiable (we should probably coordinate the release of the affected packages though).
If we want to make our lives a little easier we could keep the "address" and "password" properties as proxy attributes in mailman.client to minimize the risk of things breaking. At least for a while.
In the future (once we're out of beta) we could mabye just bump up the API version number in cases like that. BTW: Should the API version nr always correspond with the core's version number? Like core version 3.0.12 => "http://localhost:8001/3.0"?
Florian
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1
iQEcBAEBAgAGBQJT/dSKAAoJEEceGbPdavl7lHUH/0eLV1tzfogv3MojR2TnK5DF QS4WlJLU8s+vAZQECjrRKr5kCsiruOteVG3Hm8Ts9HEiMrq4pmjvOKc/oCl3q7C2 Hgo30mm/BCW2ZD4TQ5CCz5Q4eMV5vz01f09YS8alQx57reOx6GqSgcpTJKgjVJz4 AgGBqsDH9fkf8IGRIpoqnC4qwH4W6mofITKXLVDvAv4jHnmQv/VqMn+LN48BysI+ ij/0iH7qadTPlUfvLqv8JMNBzPBgxpEEkyVFVTQcggiwRbXTZDq8IMTBZY5E2hp5 5x4WBiNGdCJp3XwVYfmTC0/VwyM6WXbYTWDkuLhhM6iczBzdpWc+EjWNyeVtKLk= =uUdq -----END PGP SIGNATURE-----