X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2Fapi.md;h=ccd2e7a7ee9490dbf60d852485256da157344bc8;hb=10395429a7d88a86b21230aa7719a4f1855778d1;hp=2715f44462ea2392e7cc20ddde78362df97ac74d;hpb=53c7e50f1242eea39209738c9388c473e24eb7b5;p=friendica.git
diff --git a/doc/api.md b/doc/api.md
index 2715f44462..ccd2e7a7ee 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -379,6 +379,18 @@ Friendica doesn't allow showing the friends of other users.
* media: image data
+#### Return values
+
+Object of:
+
+* media_id: a media identifier (integer)
+* media_id_string: a media identifier (string)
+* size: size in byte
+* image.w: image width
+* image.h: image height
+* image.image_type: image mime type
+* image.friendica_preview_url: image preview url
+
---
### oauth/request_token (*)
@@ -642,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
@@ -654,6 +668,9 @@ JSON:
[
{
// ...
+ 'friendica_author' : {
+ // user object
+ },
'friendica_owner' : {
// user object
},
@@ -669,7 +686,8 @@ JSON:
'attendyes': [],
'attendno': [],
'attendmaybe': []
- }
+ },
+ 'friendica_comments': 12
},
// ...
]
@@ -695,6 +713,7 @@ XML:
+ 21
@@ -744,6 +763,7 @@ Friendica doesn't allow showing followers of other users.
* 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