diff options
| author | Louise Crow <louise.crow@gmail.com> | 2014-08-05 09:32:36 +0100 |
|---|---|---|
| committer | Louise Crow <louise.crow@gmail.com> | 2014-08-05 09:32:36 +0100 |
| commit | a64dbe172662fe1a9dfc572c1b21635ff086cc62 (patch) | |
| tree | 0b87f16b6aefcbbcca4fa127b7286a55bd640d2f /docs | |
| parent | 33604c3087217f6437d91ad545b4151e26b45cf6 (diff) | |
| parent | bbee628d4c25f80d58b496e47d5ef4a65587c5ab (diff) | |
Merge branch 'gh-pages' of ssh://git.mysociety.org/data/git/public/alaveteli into gh-pages
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/developers/api.md | 6 | ||||
| -rw-r--r-- | docs/installing/manual_install.md | 4 |
2 files changed, 7 insertions, 3 deletions
diff --git a/docs/developers/api.md b/docs/developers/api.md index cbd4c7c85..1e6c15cfd 100644 --- a/docs/developers/api.md +++ b/docs/developers/api.md @@ -22,7 +22,7 @@ these ways: * Look for the RSS feed links. * Examine the `<link rel="alternate" type="application/atom+xml">` tag in the head of the HTML. -* Add `/feed` to the start of another URL. +* Add `/feed` to the start of another URL. Note that even complicated search queries have Atom feeds. You can do all sorts of things with them, such as query by authority, by file type, by date range, @@ -73,9 +73,13 @@ as follows: * as form variable `json`: * `direction` - either `request` (from the user - might be a followup, reminder, etc) or `response` (from the authority) * `body` - the message itself + * `state` - optional, allows the authority to include an updated request `state` value when sending an update. Allowable values: `waiting_response`, `rejected`, `successful` and `partially_successful`. Only used in the `response` direction * `sent_at` - ISO-8601 formatted time that the correspondence was sent * (optionally) the variable `attachments` as `multipart/form-data`: * attachments to the correspondence. Attachments can only be attached to messages in the `response` direction +* `/api/v2/request/<id>/update.json` - POST a new state for the request: + * as form variable `json`: + * `state` - the user's assessment of the `state` of a request that has received a response from the authority. Allowable values: `waiting_response`, `rejected`, `successful` and `partially_successful`. Should only be used for the user's feedback, an authority wishing to update the request `state` should use `/api/v2/request/<id>.json` instead diff --git a/docs/installing/manual_install.md b/docs/installing/manual_install.md index 5ab2103a2..9631d8e9e 100644 --- a/docs/installing/manual_install.md +++ b/docs/installing/manual_install.md @@ -19,8 +19,8 @@ Note that there are [other ways to install Alaveteli]({{ site.baseurl }}docs/ins ## Target operating system -These instructions assume Debian Wheezy or Squeeze (64-bit) or Ubuntu 12.04 LTS -(precise). Debian is the best supported deployment platform. We also +These instructions assume a 64-bit version of Debian 6 (Wheezy), Debian 7 (Squeeze) +or Ubuntu 12.04 LTS (Precise). Debian is the best supported deployment platform. We also have instructions for [installing on MacOS]({{ site.baseurl }}docs/installing/macos/). Commands are intended to be run via the terminal or over ssh. |