UNPKG

2.01 kBMarkdownView Raw
1**/api/v1** - Root of API
2
3 - GET **/notes** Fetches notes, returned as GeoJSON. Params:
4 - **from**: date to search from (as YYYY-MM-DD)
5 - **to**: date to search to (as YYYY-MM-DD)
6 - **users**: comma separated list of usernames - searches all notes where _users_ have participated in discussion.
7 - **bbox**: BBOX string, bounding box to search for notes within
8 - **sort**: Operator + Field to sort by - eg. '-created_by' will sort descending by `created_by`. Fields supported are created_by, closed_at, commented_at
9 - **comment**: Text to search through all note comments for
10 - **offset**: Record number to start returning results at (default=0)
11 - **limit**: Number of results to return (default=20)
12
13 - GET **/changesets** Fetches changesets, returned as GeoJSON. Params:
14 - **from**: date to search from (as YYYY-MM-DD)
15 - **to**: date to search to (as YYYY-MM-DD)
16 - **users**: comma separated list of usernames - searches for changesets created by users in list
17 - **involves**: comma separated list of usernames - searches for changesets where users `involved` have commented on that changeset
18 - **bbox**: Bounding box to search for changesets within
19 - **sort**: Operator plus field to sort by. eg. '-created_at'. Supported fields are: created_at, closed_at, discussion_count, num_changes, discussed_at
20 - **comment**: Text, returns changesets where the changeset comment contains _text_
21 - **discussion**: Text, returns changesets where discussion contains _text_
22 - **text**: Text, returns changesets where either changeset comment or discussion contains _text_
23 - **hasDiscussion**: Either 'true' or 'false': 'true' returns only changesets that contain discussions, and 'false' the inverse.
24 - **isUnreplied**: Either 'true' or 'false': 'true' returns changesets where there is a discussion but the changeset author has not replied.
25 - **offset**: Record number to start returning results at (default=0)
26 - **limit**: Number of results to return (default=20)
27