Permalink
Browse files

Organised api sections in readme

  • Loading branch information...
1 parent c0928b3 commit f5d864535d0cc11ba5a9bd49b493c45913fec95d @andzdroid committed Jun 17, 2011
Showing with 47 additions and 35 deletions.
  1. +47 −35 README.md
View
@@ -29,7 +29,7 @@ This makes GET request to the API endpoint specified by `api name`.
Some API endpoints require arguments such as a site ID, or post ID, and these should be passed as the parameters after the api name.
-The `options` parameter is used for POST and PUT requests, where you will want to include body data. For more info on which options are available to each type of request, see the [Posterous API docs](http://posterous.com/api).
+The `options` parameter is used for POST and PUT requests, where you will want to include body data. For more info on which options are available to each type of request, see the [Posterous API docs](http://posterous.com/api). If there are no options, you must pass `null` to the function.
The callback function will be used to return error messages or request results.
@@ -58,120 +58,132 @@ All API methods have the same callback:
# APIs
-## User (GET)
+## Users
+### User (GET)
Get the current user's information.
-## Users (POST)
+### Users (POST)
Create a new user (only for platform users of Posterous).
-## Subscriptions (GET)
+## Subscriptions
+### Subscriptions (GET)
The user's current subscriptions.
-## SubscriptionPosts (GET)
+### SubscriptionPosts (GET)
The posts from the user's subscribed sites.
-## Sites (GET, POST)
+## Sites
+### Sites (GET, POST)
List the user's Posterous sites, or create new sites.
-## Site (GET, PUT, DELETE)
+### Site (GET, PUT, DELETE)
__Args:__ site ID
Get a single Posterous site, update it, or delete it.
-## Photos (GET)
+### Photos (GET)
__Args:__ site ID
Get 20 random photos from the user's sites.
-## Subscribe (GET)
+### Subscribe (GET)
__Args:__ site ID
Subscribe the current user to a site.
-## Unsubscribe (GET)
+### Unsubscribe (GET)
__Args:__ site ID
Unsubscribe the current user from a site.
-## HeaderImage (POST, DELETE)
+### HeaderImage (POST, DELETE)
__Args:__ site ID
Upload a new header image, or delete it.
-## SiteProfile (GET, POST, PUT, DELETE)
+## Site Profiles
+### SiteProfile (GET, POST, PUT, DELETE)
__Args:__ site ID
Get, create, update, delete a site's profile.
-## SiteProfileImage (PUT, DELETE)
+### SiteProfileImage (PUT, DELETE)
__Args:__ site ID
Upload or delete a site's profile image.
-## Tags (GET)
+## Site Tags
+### Tags (GET)
__Args:__ site ID
Get the list of tags for a site.
-## Contributors (GET, POST)
+## Site Contributors
+### Contributors (GET, POST)
__Args:__ site ID
Get the list of contributors, or add a new contributor.
-## Contributor (DELETE)
+### Contributor (DELETE)
__Args:__ site ID, contributor ID
Delete a contributor from a site.
-## Subscribers (GET, POST)
+## Site Subscribers
+### Subscribers (GET, POST)
__Args:__ site ID
Get a list of subscribers to a site, or add a new subscriber (Platform users only).
-## Subscriber (DELETE)
+### Subscriber (DELETE)
__Args:__ site ID, subscriber ID
Remove a subscriber from a site.
-## ExternalSites (GET)
+## External Autopost Sites
+### ExternalSites (GET)
__Args:__ site ID
Get a list of external autopost sites.
-## ExternalSite (GET, DELETE)
+### ExternalSite (GET, DELETE)
__Args:__ site ID, external site ID
Get or delete a single external autopost site.
-## Theme (GET, POST)
+## Site Theme
+### Theme (GET, POST)
__Args:__ site ID
Get the theme for a site, or create a new theme.
-## AllPosts (GET)
+## Posts
+### AllPosts (GET)
Get a list of public posts.
-## Posts (GET, POST)
+### Posts (GET, POST)
__Args:__ site ID
Get a list of posts belonging to a site, or create a new post.
-## PublicPosts (GET)
-__Args:__ site ID
-Get a list of a site's public posts.
-
-## Post (GET, PUT, DELETE)
+### Post (GET, PUT, DELETE)
__Args:__ site ID, post ID
Get a single post, update it or delete it.
-## PostPhotos (GET)
+### PublicPosts (GET)
+__Args:__ site ID
+Get a list of a site's public posts.
+
+### PostPhotos (GET)
__Args:__ site ID, post ID
Get photos from a post.
-## PostVideos (GET)
+### PostVideos (GET)
__Args:__ site ID, post ID
Get videos from a post.
-## PostAudioFiles (GET)
+### PostAudioFiles (GET)
__Args:__ site ID, post ID
Get audo files from a post.
-## Comments (GET, POST)
+## Post Comments
+### Comments (GET, POST)
__Args:__ site ID, post ID
Get a list of comments from a post, or create a new comment.
-## Comment (GET, PUT, DELETE)
+### Comment (GET, PUT, DELETE)
__Args:__ site ID, post ID, comment ID
Get a single comment from a post, update it, or delete it.
-## Likes (GET, POST)
+## Post Likes
+### Likes (GET, POST)
__Args:__ site ID, post ID
Get a list of likes for a post, or add a new like.
-## Like (GET, DELETE)
+### Like (GET, DELETE)
__Args:__ site ID, post ID, like ID
Get a single like for a post, or delete it.

0 comments on commit f5d8645

Please sign in to comment.