From d08eb2cc1cf83d058f795efd5fc2772088859859 Mon Sep 17 00:00:00 2001 From: Jaisen Mathai Date: Mon, 3 Oct 2011 15:33:18 -0700 Subject: [PATCH] Adding placeholders for all the API endpoints. Gh-180 --- documentation/api/Api.markdown | 44 +++++++++++++++++-- documentation/api/GetGroup.markdown | 1 + documentation/api/GetGroups.markdown | 1 + .../api/GetPhotoNextPrevious.markdown | 1 + documentation/api/PostActionCreate.markdown | 1 + documentation/api/PostActionDelete.markdown | 1 + documentation/api/PostGroupCreate.markdown | 1 + documentation/api/PostGroupDelete.markdown | 1 + documentation/api/PostGroupUpdate.markdown | 1 + documentation/api/PostPhotoDelete.markdown | 1 + documentation/api/PostTag.markdown | 0 11 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 documentation/api/GetGroup.markdown create mode 100644 documentation/api/GetGroups.markdown create mode 100644 documentation/api/GetPhotoNextPrevious.markdown create mode 100644 documentation/api/PostActionCreate.markdown create mode 100644 documentation/api/PostActionDelete.markdown create mode 100644 documentation/api/PostGroupCreate.markdown create mode 100644 documentation/api/PostGroupDelete.markdown create mode 100644 documentation/api/PostGroupUpdate.markdown create mode 100644 documentation/api/PostPhotoDelete.markdown create mode 100644 documentation/api/PostTag.markdown diff --git a/documentation/api/Api.markdown b/documentation/api/Api.markdown index b54f56ec..985c5fff 100644 --- a/documentation/api/Api.markdown +++ b/documentation/api/Api.markdown @@ -24,25 +24,63 @@ Every API endpoint returns a JSON response in a [standard envelope][Envelope]. ### API Endpoints +#### Test / diagnostics endpoints 1. [GET /hello.json][GetHelloWorld] 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] 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] 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] Get a user's tags. 1. [POST /tag/:id/update.json][PostTag] 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 [GetHelloWorld]: GetHelloWorld.markdown +[PostActionCreate]: PostActionCreate.markdown +[PostActionDelete]: PostActionDelete.markdown +[PostPhotoDelete]: PostPhotoDelete.markdown [GetPhotos]: GetPhotos.markdown [GetPhoto]: GetPhoto.markdown -[GetTags]: GetTags.markdown [PostPhotoUpload]: PostPhotoUpload.markdown +[GetPhotoNextPrevious]: GetPhotoNextPrevious.markdown +[GetTags]: GetTags.markdown [PostTag]: PostTag.markdown +[PostGroupCreate]: PostGroupCreate.markdown +[PostGroupDelete]: PostGroupDelete.markdown +[PostGroupUpdate]: PostGroupUpdate.markdown +[GetGroup]: GetGroup.markdown +[GetGroups]: GetGroups.markdown [authentication]: Authentication.markdown [oauth1.0a]: http://oauth.net/core/1.0a/ diff --git a/documentation/api/GetGroup.markdown b/documentation/api/GetGroup.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/GetGroup.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/GetGroups.markdown b/documentation/api/GetGroups.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/GetGroups.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/GetPhotoNextPrevious.markdown b/documentation/api/GetPhotoNextPrevious.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/GetPhotoNextPrevious.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/PostActionCreate.markdown b/documentation/api/PostActionCreate.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/PostActionCreate.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/PostActionDelete.markdown b/documentation/api/PostActionDelete.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/PostActionDelete.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/PostGroupCreate.markdown b/documentation/api/PostGroupCreate.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/PostGroupCreate.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/PostGroupDelete.markdown b/documentation/api/PostGroupDelete.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/PostGroupDelete.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/PostGroupUpdate.markdown b/documentation/api/PostGroupUpdate.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/PostGroupUpdate.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/PostPhotoDelete.markdown b/documentation/api/PostPhotoDelete.markdown new file mode 100644 index 00000000..40173eab --- /dev/null +++ b/documentation/api/PostPhotoDelete.markdown @@ -0,0 +1 @@ +Not yet documented diff --git a/documentation/api/PostTag.markdown b/documentation/api/PostTag.markdown new file mode 100644 index 00000000..e69de29b