Merge pull request #123 from quentez/master

Fixed the position of the URL parameters for the followings pagination.
This commit is contained in:
Jonathan Rudenberg 2012-10-14 13:34:13 -07:00
commit bc1db81977

View file

@ -26,6 +26,13 @@ Apps can tell a server to follow another entity.
{create_following example} {create_following example}
### GET /followings
Apps can also retrieve a list of the entities currently being followed.
{get_followings example}
#### URL Parameters #### URL Parameters
GET parameters can be used to filter and paginate the returned followings. GET parameters can be used to filter and paginate the returned followings.
@ -36,12 +43,6 @@ GET parameters can be used to filter and paginate the returned followings.
| `since_id` | Followings since a specific entity identifier. | | `since_id` | Followings since a specific entity identifier. |
| `limit` | The number of followings to return (defaults to the maximum of 50). | | `limit` | The number of followings to return (defaults to the maximum of 50). |
### GET /followings
Apps can also retrieve a list of the entities currently being followed.
{get_followings example}
### GET /followings/:id ### GET /followings/:id
@ -73,6 +74,7 @@ GET parameters can be used to filter and paginate the returned followers.
| `since_id` | Followers since a specific entity identifier. | | `since_id` | Followers since a specific entity identifier. |
| `limit` | The number of followers to return (defaults to the maximum of 50). | | `limit` | The number of followers to return (defaults to the maximum of 50). |
### GET /followers/:id ### GET /followers/:id
Apps can request information on a specific follower. Apps can request information on a specific follower.
@ -87,12 +89,14 @@ the follower of the user's new posts. The follower will still be able to get th
{delete_follower example} {delete_follower example}
### POST /posts ### POST /posts
Apps can create posts by sending them to the server. The server will then send notifications to any entities with permission to see the post and who either requested the post type in their following request or who were mentioned in the post. Apps can create posts by sending them to the server. The server will then send notifications to any entities with permission to see the post and who either requested the post type in their following request or who were mentioned in the post.
{create_post example} {create_post example}
### GET /posts ### GET /posts
Apps can retrieve posts. If the request is not authenticated this will return the user's own public posts. Apps can retrieve posts. If the request is not authenticated this will return the user's own public posts.
@ -125,6 +129,7 @@ Apps can retrieve a specific post.
{get_post example} {get_post example}
### Post Attachments ### Post Attachments
Apps can create a new post with an attachment and send both to the server. Files and binary data are usually transferred as attachments to posts. Apps can create a new post with an attachment and send both to the server. Files and binary data are usually transferred as attachments to posts.