Adding placeholders for all the API endpoints.
Gh-180
This commit is contained in:
parent
2ce1aeb219
commit
d08eb2cc1c
11 changed files with 50 additions and 3 deletions
|
@ -24,25 +24,63 @@ Every API endpoint returns a JSON response in a [standard envelope][Envelope].
|
||||||
|
|
||||||
### API Endpoints
|
### API Endpoints
|
||||||
|
|
||||||
|
#### Test / diagnostics endpoints
|
||||||
1. [GET /hello.json][GetHelloWorld]
|
1. [GET /hello.json][GetHelloWorld]
|
||||||
Test endpoint.
|
Test endpoint.
|
||||||
1. [GET /photos/list.json][GetPhotos]
|
|
||||||
Get a list of the user's photos.
|
#### Action endpoings (comments, favorites, etc)
|
||||||
|
1. [POST /action/:id/:type/create.json][PostActionCreate]
|
||||||
|
Create an action.
|
||||||
|
1. [POST /action/:id/delete.json][PostActionDelete]
|
||||||
|
Delete an action.
|
||||||
|
|
||||||
|
#### Photo endpoints
|
||||||
|
1. [POST /photos/:id/delete.json][PostPhotoDelete]
|
||||||
|
Delete a user's photo.
|
||||||
|
1. [POST /photos/:id/update.json][PostPhotoUpdate]
|
||||||
|
Update data on a user's photo.
|
||||||
1. [GET /photo/:id/view.json][GetPhoto]
|
1. [GET /photo/:id/view.json][GetPhoto]
|
||||||
Get a user's photo.
|
Get a user's photo.
|
||||||
|
1. [GET /photos/list.json][GetPhotos]
|
||||||
|
Get a list of the user's photos.
|
||||||
1. [POST /photo/upload.json][PostPhotoUpload]
|
1. [POST /photo/upload.json][PostPhotoUpload]
|
||||||
Upload a new photo.
|
Upload a new photo.
|
||||||
|
1. [POST /photo/:id/nextprevious.json][GetPhotoNextPrevious]
|
||||||
|
Get the next and previous photo.
|
||||||
|
|
||||||
|
#### Tag endpoints
|
||||||
1. [GET /tags/list.json][GetTags]
|
1. [GET /tags/list.json][GetTags]
|
||||||
Get a user's tags.
|
Get a user's tags.
|
||||||
1. [POST /tag/:id/update.json][PostTag]
|
1. [POST /tag/:id/update.json][PostTag]
|
||||||
Modify meta data for a user's tag.
|
Modify meta data for a user's tag.
|
||||||
|
|
||||||
|
#### Group endpoints
|
||||||
|
1. [POST /group/create.json][PostGroupCreate]
|
||||||
|
Create a group.
|
||||||
|
1. [POST /group/delete.json][PostGroupDelete]
|
||||||
|
Delete a group.
|
||||||
|
1. [POST /group/update.json][PostGroupUpdate]
|
||||||
|
Update a group.
|
||||||
|
1. [GET /group/:id/view.json][GetGroup]
|
||||||
|
Get a group.
|
||||||
|
1. [GET /group/list.json][GetGroups]
|
||||||
|
Get a listing of a user's groups.
|
||||||
|
|
||||||
[Envelope]: Envelope.markdown
|
[Envelope]: Envelope.markdown
|
||||||
[GetHelloWorld]: GetHelloWorld.markdown
|
[GetHelloWorld]: GetHelloWorld.markdown
|
||||||
|
[PostActionCreate]: PostActionCreate.markdown
|
||||||
|
[PostActionDelete]: PostActionDelete.markdown
|
||||||
|
[PostPhotoDelete]: PostPhotoDelete.markdown
|
||||||
[GetPhotos]: GetPhotos.markdown
|
[GetPhotos]: GetPhotos.markdown
|
||||||
[GetPhoto]: GetPhoto.markdown
|
[GetPhoto]: GetPhoto.markdown
|
||||||
[GetTags]: GetTags.markdown
|
|
||||||
[PostPhotoUpload]: PostPhotoUpload.markdown
|
[PostPhotoUpload]: PostPhotoUpload.markdown
|
||||||
|
[GetPhotoNextPrevious]: GetPhotoNextPrevious.markdown
|
||||||
|
[GetTags]: GetTags.markdown
|
||||||
[PostTag]: PostTag.markdown
|
[PostTag]: PostTag.markdown
|
||||||
|
[PostGroupCreate]: PostGroupCreate.markdown
|
||||||
|
[PostGroupDelete]: PostGroupDelete.markdown
|
||||||
|
[PostGroupUpdate]: PostGroupUpdate.markdown
|
||||||
|
[GetGroup]: GetGroup.markdown
|
||||||
|
[GetGroups]: GetGroups.markdown
|
||||||
[authentication]: Authentication.markdown
|
[authentication]: Authentication.markdown
|
||||||
[oauth1.0a]: http://oauth.net/core/1.0a/
|
[oauth1.0a]: http://oauth.net/core/1.0a/
|
||||||
|
|
1
documentation/api/GetGroup.markdown
Normal file
1
documentation/api/GetGroup.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/GetGroups.markdown
Normal file
1
documentation/api/GetGroups.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/GetPhotoNextPrevious.markdown
Normal file
1
documentation/api/GetPhotoNextPrevious.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/PostActionCreate.markdown
Normal file
1
documentation/api/PostActionCreate.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/PostActionDelete.markdown
Normal file
1
documentation/api/PostActionDelete.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/PostGroupCreate.markdown
Normal file
1
documentation/api/PostGroupCreate.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/PostGroupDelete.markdown
Normal file
1
documentation/api/PostGroupDelete.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/PostGroupUpdate.markdown
Normal file
1
documentation/api/PostGroupUpdate.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
1
documentation/api/PostPhotoDelete.markdown
Normal file
1
documentation/api/PostPhotoDelete.markdown
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Not yet documented
|
0
documentation/api/PostTag.markdown
Normal file
0
documentation/api/PostTag.markdown
Normal file
Loading…
Add table
Add a link
Reference in a new issue