Merge pull request #5667 from miqrogroove/patch-1

[friendica.git] / doc / api.md

diff --git a/doc/api.md b/doc/api.md
index c565d8699c0e8d26b2d0595008cb78491928a160..07813b6a7715c243f91f06cd4dc19e974e88552d 100644 (file)
--- a/doc/api.md
+++ b/doc/api.md
@@ -294,6 +294,85 @@ Friendica doesn't allow showing the friends of other users.
 
 ---
 
+### lists/ownerships (*; AUTH)
+
+#### Parameters
+
+* list_id: ID of the list
+* count: Items per page
+* page: Page number
+* since_id: Minimum ID
+* max_id: Maximum ID
+
+#### Unsupported parameters
+
+* slug
+* owner_screen_name
+* owner_id
+* include_entities
+* include_rts
+
+---
+
+### lists/destroy (POST; AUTH)
+
+#### Parameters
+
+* list_id: ID of the list
+
+#### Unsupported parameters
+
+* owner_screen_name
+* owner_id
+* slug
+
+---
+
+### lists/create (POST; AUTH)
+
+#### Parameters
+
+* name: name of the list
+
+#### Unsupported parameters
+
+* mode
+* description
+
+---
+
+### lists/update (POST; AUTH)
+
+#### Parameters
+
+* list_id: ID of the list
+* name: name of the list
+
+#### Unsupported parameters
+
+* slug
+* name
+* mode
+* description
+* owner_screen_name
+* owner_id
+
+---
+
+### lists/statuses (*; AUTH)
+
+#### Parameters
+
+* user_id: ID of the user for whom to return results.
+
+#### Unsupported parameters
+
+* screen_name
+* count
+* cursor
+
+---
+
 ### media/upload (POST,PUT; AUTH)
 
 #### Parameters
@@ -354,6 +433,7 @@ Friendica doesn't allow showing the friends of other users.
 #### Parameters
 
 * include_entities: "true" shows entities for pictures and links (Default: false)
+* count: how many items should be shown (Default: 20)
 
 ---
 
@@ -554,6 +634,73 @@ Friendica doesn't allow showing the friends of other users.
 * trim_user
 * contributor_details
 
+---
+
+### Return values for statuses/* api calls
+
+Returned status object is conform to GNU Social/Twitter api.
+
+Friendica adds some addictional fields:
+
+- owner: a user object, it's the owner of the item.
+- private: boolean, true if the item is marked as private
+- activities: map with activities related to the item. Every activity is a list of user objects.
+
+This properties are prefixed with "friendica_" in JSON responses and namespaced under "http://friendi.ca/schema/api/1/" in XML responses
+
+JSON:
+
+```json
+[
+       {
+               // ...
+               'friendica_owner' : {
+                       // user object
+               },
+               'friendica_private' : true,
+               'friendica_activities': {
+                       'like': [
+                               {
+                                       // user object 
+                               },
+                               // ...
+                       ],
+                       'dislike': [],
+                       'attendyes': [],
+                       'attendno': [],
+                       'attendmaybe': []
+               }
+       },
+       // ...
+]
+```
+
+XML:
+
+```xml
+<statuses xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" xmlns:friendica="http://friendi.ca/schema/api/1/" xmlns:georss="http://www.georss.org/georss">
+  <status>
+       <!-- ... -->
+       <friendica:owner><!-- user object --></friendica:owner>
+       <friendica:private>true</friendica:private>
+       <friendica:activities>
+               <friendica:like>
+               <user>
+                       <!-- user object -->
+               </user>
+               <!-- ... --->
+               </friendica:like>
+               <friendica:dislike/>
+               <friendica:attendyes/>
+               <friendica:attendno/>
+               <friendica:attendmaybe/>
+       </friendica:activities> 
+       </status>
+       <!-- ... -->
+</statuses>
+```
+
+
 ---
 
 ### statusnet/config (*)
@@ -692,6 +839,23 @@ On error:
 
 ---
 
+### account/update_profile (POST; AUTH)
+
+#### Parameters
+
+* name (optional): full name of the user
+* description (optional): a description of the user
+
+#### Unsupported parameters
+
+* url
+* location
+* profile_link_color
+* include_entities
+* skip_status
+
+---
+
 ### friendships/incoming (*; AUTH)
 
 #### Unsupported parameters
@@ -1205,7 +1369,6 @@ The following API calls from the Twitter API are not implemented in either Frien
 * friendships/lookup
 * account/settings
 * account/update_delivery_device
-* account/update_profile
 * blocks/ids
 * users/show
 * users/search
@@ -1221,7 +1384,6 @@ The following API calls from the Twitter API are not implemented in either Frien
 * users/suggestions/:slug/members
 * favorites/list
 * lists/list
-* lists/statuses
 * lists/members/destroy
 * lists/memberships
 * lists/subscribers
@@ -1232,13 +1394,9 @@ The following API calls from the Twitter API are not implemented in either Frien
 * lists/members/show
 * lists/members
 * lists/members/create
-* lists/destroy
-* lists/update
-* lists/create
 * lists/show
 * lists/subscriptions
 * lists/members/destroy_all
-* lists/ownerships
 * saved_searches/show/:id
 * saved_searches/create
 * saved_searches/destroy/:id