X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2Fapi.md;h=ccd2e7a7ee9490dbf60d852485256da157344bc8;hb=10395429a7d88a86b21230aa7719a4f1855778d1;hp=58413b2e64df08ceab343c9fc51535d35a945383;hpb=939364f9a0b40eaa0c87e111074122ff3ff12323;p=friendica.git
diff --git a/doc/api.md b/doc/api.md
index 58413b2e64..ccd2e7a7ee 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -654,9 +654,11 @@ Returned status object is conform to GNU Social/Twitter api.
Friendica adds some addictional fields:
+- author: a user object, it's the author of the item. In case of a reshare for legacy reasons the "user" field doesn't show the real author. This field always contains the real author of a post.
- 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.
+- comments: comment numbers
This properties are prefixed with "friendica_" in JSON responses and namespaced under "http://friendi.ca/schema/api/1/" in XML responses
@@ -666,6 +668,9 @@ JSON:
[
{
// ...
+ 'friendica_author' : {
+ // user object
+ },
'friendica_owner' : {
// user object
},
@@ -681,7 +686,8 @@ JSON:
'attendyes': [],
'attendno': [],
'attendmaybe': []
- }
+ },
+ 'friendica_comments': 12
},
// ...
]
@@ -707,6 +713,7 @@ XML:
+ 21
@@ -751,12 +758,12 @@ Friendica doesn't allow showing followers of other users.
#### Parameters
* q: search query
-* friendica_tag: search hashtag (optional; query condition only accept one of the two [ q | friendica_tag ] )
* page: the page number (starting at 1) to return
* rpp: the number of statuses to return per page
* count: alias for the rpp parameter
* since_id: returns statuses with ids greater than the given id
* max_id: returns statuses with ids lower or equal to the given id
+* exclude_replies: don't show replies (default: false)
#### Unsupported parameters