diff --git a/doc/CHANNELING-API.txt b/doc/CHANNELING-API.txt index e65d7bc6..60606947 100644 --- a/doc/CHANNELING-API.txt +++ b/doc/CHANNELING-API.txt @@ -309,10 +309,10 @@ Additional types for session listing and notifications } - 'buddyPicture' can be in two formats: - 1. image of the user as Base64 encoded string of an image. + 'buddyPicture' can be in next formats: + 1. Base64 encoded string of an image. Example: data:image/jpeg;base64,/9j/4... - 2. url subpath to query REST API. Please refer to REST API for more info + 2. url subpath to query REST API. Please refer to REST API for more information Example: img:8nG33oDk8Yv8fvK6IphL/6vjI2NLigcET/picture.jpg Note: buddyPicture content needs to be in the format of HTML data urls'. diff --git a/doc/REST-API.txt b/doc/REST-API.txt index 7e51d09c..7f278ba5 100644 --- a/doc/REST-API.txt +++ b/doc/REST-API.txt @@ -154,13 +154,12 @@ Available end points with request methods and content-type: GET application/x-www-form-urlencoded details: - flags: at the moment the only know flag is s{icon_size_in_pixels}, + flags: at the moment the only known flag is s{icon_size_in_pixels}, the icons are always squares so only one dimension is needed example: s46 - imageid and idx: image id received via Channeling API (please refer to Channeling API for details) + imageid and idx: image id received via channeling API (please refer to channeling API for details) example: https://example.com/static/img/buddy/s46/8nG33oDk8Yv8fvK6IphL/6vjI2NLigcET/picture.jpg - Response 200: - {image} + Response 200: image