jeena/tent.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Fixed some details on the App-Server doc page.

Browse source 
* The URL parameters for the pagination of the followings were at the
wrong location.
* The formating was inconsistent between some of the paragraphs.
This commit is contained in:
Quentin Calvez 2012-10-14 22:30:39 +02:00
parent ec76d0f1d5
commit 79d3333c6d
1 changed files with 11 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

17
content/docs/app-server.md
View file

@ -26,6 +26,13 @@ Apps can tell a server to follow another entity.
{create_following example}
### GET /followings
Apps can also retrieve a list of the entities currently being followed.
{get_followings example}
#### URL Parameters
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. |
| `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
@ -73,6 +74,7 @@ GET parameters can be used to filter and paginate the returned followers.
| `since_id` | Followers since a specific entity identifier. |
| `limit` | The number of followers to return (defaults to the maximum of 50). |
### GET /followers/:id
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}
### 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.
{create_post example}
### GET /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}
### 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.