Fixing lots of errors in the documentation.

Gh-180
2011-11-30 13:01:26 -08:00 · 2011-11-30 13:01:26 -08:00 · 50b02ab258
commit 50b02ab258
parent 020335b989
17 changed files with 99 additions and 34 deletions
--- a/documentation/api/GetGroup.markdown
+++ b/documentation/api/GetGroup.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photo
+Open Photo API / Get Group
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/GetGroups.markdown
+++ b/documentation/api/GetGroups.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photo
+Open Photo API / Get Groups
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/GetPhotoNextPrevious.markdown
+++ b/documentation/api/GetPhotoNextPrevious.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photo
+Open Photo API / Get Next/Previous Photo
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/GetWebhook.markdown
+++ b/documentation/api/GetWebhook.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photo
+Open Photo API / Get Webhook
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostActionCreate.markdown
+++ b/documentation/api/PostActionCreate.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photos
+Open Photo API / Create Action
 =======================
 #### OpenPhoto, a photo service for the masses

@ -85,6 +85,7 @@ The response is in a standard [response envelope][Envelope].
        datePosted: "1318281477",
        status: 1
      }
+    }

 [Envelope]: Envelope.markdown
 [Action]: ../schemas/Action.markdown
--- a/documentation/api/PostActionDelete.markdown
+++ b/documentation/api/PostActionDelete.markdown
@ -1 +1,83 @@
-Not yet documented
+Open Photo API / Delete Action
+=======================
+#### OpenPhoto, a photo service for the masses
+
+----------------------------------------
+
+1. [Purpose][purpose]
+1. [Endpoint][endpoint]
+1. [Parameters][parameters]
+1. [Examples][examples]
+  * [Command line][example-cli]
+  * [PHP][example-php]
+1. [Response][response]
+  * [Sample][sample]
+
+----------------------------------------
+
+<a name="purpose"></a>
+### Purpose of the delete action API
+
+Use this API to delete an action on a photo. This includes comments and favorites.
+
+----------------------------------------
+
+<a name="endpoint"></a>
+### Endpoint
+
+_Authentication: required_
+
+    POST /action/photo/:targetId/delete.json
+
+<a name="parameters"></a>
+### Parameters
+
+_N/A_
+
+----------------------------------------
+
+<a name="examples"></a>
+### Examples
+
+<a name="example-cli"></a>
+#### Command Line (using [openphoto-php][openphoto-php])
+
+    ./openphoto -p -X POST -h current.openphoto.me -e /action/photo/a/delete.json
+
+<a name="example-php"></a>
+#### PHP (using [openphoto-php][openphoto-php])
+
+    $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
+    $response = $client->post("/action/photo/a/delete.json");
+
+----------------------------------------
+
+<a name="response"></a>
+### Response
+
+The response is in a standard [response envelope][Envelope].
+
+* _message_, A string describing the result. Don't use this for anything but reading.
+* _code_, _200_ on success
+* _result_, boolean
+
+<a name="sample"></a>
+#### Sample
+
+    {
+      "message":"",
+      "code":200,
+      "result": true
+    }
+
+[Envelope]: Envelope.markdown
+[Action]: ../schemas/Action.markdown
+[purpose]: #purpose
+[endpoint]: #endpoint
+[parameters]: #parameters
+[examples]: #examples
+[example-cli]: #example-cli
+[example-php]: #example-php
+[response]: #response
+[sample]: #sample
+[openphoto-php]: https://github.com/openphoto/openphoto-php
--- a/documentation/api/PostGroupCreate.markdown
+++ b/documentation/api/PostGroupCreate.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photos
+Open Photo API / Create Group
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostGroupDelete.markdown
+++ b/documentation/api/PostGroupDelete.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photos
+Open Photo API / Delete Group
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostGroupUpdate.markdown
+++ b/documentation/api/PostGroupUpdate.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photos
+Open Photo API / Update Group
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostPhotoDelete.markdown
+++ b/documentation/api/PostPhotoDelete.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photos
+Open Photo API / Delete Photo
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostPhotoUpdate.markdown
+++ b/documentation/api/PostPhotoUpdate.markdown
@ -1,4 +1,4 @@
-Open Photo API / Photo Upload
+Open Photo API / Update Photo
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostPhotoUpload.markdown
+++ b/documentation/api/PostPhotoUpload.markdown
@ -1,4 +1,4 @@
-Open Photo API / Photo Upload
+Open Photo API / Upload Photo
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostTagCreate.markdown
+++ b/documentation/api/PostTagCreate.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photos
+Open Photo API / Creae Tag
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostTagUpdate.markdown
+++ b/documentation/api/PostTagUpdate.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photos
+Open Photo API / Update Tag
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostWebhookDelete.markdown
+++ b/documentation/api/PostWebhookDelete.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photo
+Open Photo API / Delete Webhook
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/api/PostWebhookSubscribe.markdown
+++ b/documentation/api/PostWebhookSubscribe.markdown
@ -1,4 +1,4 @@
-Open Photo API / Get Photo
+Open Photo API / Create/Subscribe to Webhook
 =======================
 #### OpenPhoto, a photo service for the masses

--- a/documentation/guides/InstallationOSXMacports.markdown
+++ b/documentation/guides/InstallationOSXMacports.markdown
@ -41,24 +41,6 @@ This guide assumes you have [get it here][Macports installed]. If not you can .

 Download and install the source code. We recommend `~/Sites/yourdomain.com` but you can use any directory you'd like.

-#### Using git clone
-
-    apt-get install git-core
-    git clone git@github.com:openphoto/frontend.git /var/www/yourdomain.com
-    chown -R www-data:www-data /var/www/yourdomain.com
-
-#### Using tar
-
-    cd /var/www
-    wget https://github.com/openphoto/frontend/tarball/master -O openphoto.tar.gz
-    tar -zxvf openphoto.tar.gz
-    mv openphoto-frontend-* yourdomain.com
-    chown -R www-data:www-data yourdomain.com
-
-Assuming that this is a development machine you can make the config writable by the user Apache runs as. Most likely `www-data`.
-
-    mkdir /var/www/yourdomain.com/src/userdata
-    chown www-data:www-data /var/www/yourdomain.com/src/configs/generated
 #### Using git clone

    # install git if you don't have it already