Force avatar update for Contact Advanced page

[friendica.git] / doc / API-Friendica.md

diff --git a/doc/API-Friendica.md b/doc/API-Friendica.md
index 2e33a887da170d96beefdd28396f4d2c010ba748..013dd08f59584ebb349e758d961d99e78e97b978 100644 (file)
--- a/doc/API-Friendica.md
+++ b/doc/API-Friendica.md
@@ -435,7 +435,7 @@ json:
 
 ```json
        {
-               "id": "photo id"
+               "id": "photo id",
                "created": "date(YYYY-MM-DD HH:MM:SS)",
                "edited": "date(YYYY-MM-DD HH:MM:SS)",
                "title": "photo title",
@@ -447,7 +447,7 @@ json:
                "width": "number",
                "profile": "1 if is profile photo",
                "link": {
-                       "<scale>": "url to image"
+                       "<scale>": "url to image",
                        ...
                },
                // if 'scale' is set
@@ -489,11 +489,11 @@ json:
 ```json
        [
                {
-                       id: "resource_id",
-                       album: "album name",
-                       filename: "original file name",
-                       type: "image mime type",
-                       thumb: "url to thumb sized image"
+                       "id": "resource_id",
+                       "album": "album name",
+                       "filename": "original file name",
+                       "type": "image mime type",
+                       "thumb": "url to thumb sized image"
                },
                ...
        ]
@@ -645,17 +645,12 @@ On error:
 
 ### GET api/friendica/profile/show
 
-Returns the [Profile](help/API-Entities#Profile) data of all profiles or a single profile of the authenticated user.
-
-#### Parameters
-
-* `profile_id` (optional): id of the profile to be returned. If omitted all profiles are returned by default.
+Returns the [Profile](help/API-Entities#Profile) data of the authenticated user.
 
 #### Return values
 
 On success: Array of:
 
-* `multi_profiles`: true if user has activated multi_profiles
 * `global_dir`: URL of the global directory set in server settings
 * `friendica_owner`: user data of the authenticated user
 * `profiles`: array of the profile data
@@ -665,6 +660,23 @@ HTTP 403 Forbidden: when no authentication was provided
 HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user
 
 General description of profile data in API returns:
+- hide_friends: true if friends are hidden
+- profile_photo
+- profile_thumb
+- publish: true if published on the server's local directory
+- net_publish: true if published to global_dir
+- fullname
+- date_of_birth
+- description
+- xmpp
+- homepage
+- address
+- locality
+- region
+- postal_code
+- country
+- pub_keywords
+- custom_fields: list of public custom fields
 
 ---