source: bookmarks/trunk/api @ 89

Last change on this file since 89 was 89, checked in by peter, 7 years ago

issue #8: more notes about the deletion API

File size: 1.0 KB
Line 
1GET /
2  Lists the bookmarks
3
4  Params:
5    format=json|xbel|text|csv|html
6    tag={tag} (repeatable)
7    limit={limit}
8    offset={offset} (only if limit is given)
9
10GET /{id}
11  Gets a individual bookmark
12
13GET /{id}/{field}
14  Gets an individual field of an individual bookmark
15
16GET /feed
17  Gets an Atom feed of the bookmarks
18
19  Params:
20    tag={tag} (repeatable)
21
22POST /
23  Create or update a bookmark
24
25POST /{id}
26  Update a bookmark
27
28== TODO ==
29
30PUT /{id}
31  Create or update a bookmark; requires the entire resource representation to be given in JSON or XBEL
32
33DELETE /{id}
34  Delete a bookmark
35
36  -- bookmarks that have been deleted
37  create table deleted_bookmarks (
38      id integer,
39      dtime integer
40  );
41  create view active_bookmarks as select * from bookmarks where id not in (select id from deleted_bookmarks)
42
43  insert into deleted_bookmarks (id) values (?)  <-- {id}
44
45  then a request to /{id} checks the deleted_bookmarks table and issues a 410 (cacheable) if it is in there
46
47PUT /{id}/{field}
48  Set a single field of a bookmark
Note: See TracBrowser for help on using the repository browser.