Merge pull request #13268 from MrPetovan/task/normalize-item-action-label

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

diff --git a/doc/API-Entities.md b/doc/API-Entities.md
index 6c3e94a39b627df649d58133dc30aac75178b5d2..de3eac9b9af1c5ed3fc3139108247a05d87ad154 100644 (file)
--- a/doc/API-Entities.md
+++ b/doc/API-Entities.md
@@ -454,7 +454,7 @@ Ex: Wed May 23 06:01:13 +0000 2007
 <tr>
 <td><code>allow_gid</code></td>
 <td>String (angle-brackets escaped integers)</td>
-<td>Optional. List of allowed group ids</td>
+<td>Optional. List of allowed circle ids</td>
 </tr>
 
 <tr>
@@ -466,7 +466,7 @@ Ex: Wed May 23 06:01:13 +0000 2007
 <tr>
 <td><code>deny_gid</code></td>
 <td>String (angle-brackets escaped integers)</td>
-<td>Optional. List of disallowed group ids</td>
+<td>Optional. List of disallowed circle ids</td>
 </tr>
 
 </tbody>
@@ -583,7 +583,7 @@ Ex: Wed May 23 06:01:13 +0000 2007
 <tr>
 <td><code>friendica_owner</code></td>
 <td>
- 
+
 <a href="help/API-Entities#Contact">Contact</a></td>
 <td align="center">No</td>
 </tr>
@@ -911,7 +911,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
 <tr>
 <td><code>media-id</code></td>
 <td>String (Integer) </td>
-<td>ID used for attaching to a Mastodon Post Status</td>
+<td>ID used for attaching images to a Mastodon Post Status</td>
 </tr>
 
 
@@ -984,7 +984,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
 <tr>
 <td><code>allow_gid</code></td>
 <td>String (ACL)</td>
-<td>List of contact group ids wrapped in angle brackets allowed to access the photo.</td>
+<td>List of contact circle ids wrapped in angle brackets allowed to access the photo.</td>
 </tr>
 
 <tr>
@@ -996,7 +996,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
 <tr>
 <td><code>deny_gid</code></td>
 <td>String (ACL)</td>
-<td>List of contact group ids wrapped in angle brackets forbidden to access the photo.</td>
+<td>List of contact circle ids wrapped in angle brackets forbidden to access the photo.</td>
 </tr>
 
 <tr>
@@ -1012,7 +1012,7 @@ Mutually exclusive with <code>data</code> <code>datasize</code>.
 <td><code>scales</code></td>
 <td>Array of Photo Scales</td>
 <td>
-List of Scale objects listing the id, scale, link, etc. of each scale
+List of the various resized versions of the Photo
 </td>
 </tr>
 
@@ -1170,6 +1170,40 @@ Mutually exclusive with <code>link</code>.
 </tbody>
 </table>
 
+
+## Photo Album
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>name</code></td>
+<td>String</td>
+<td>The name of the photo album</td>
+</tr>
+
+<tr>
+<td><code>created</code></td>
+<td>String (Date)</td>
+<td>The creation date of the album. Format <code>YYYY-MM-DD HH:MM:SS</code></td>
+</tr>
+
+<tr>
+<td><code>count</code></td>
+<td>Integer</td>
+<td>The number of images in the album</td>
+</tr>
+
+</tbody>
+</table>
+
 ## Private message
 
 <table class="table table-condensed table-striped table-bordered">
@@ -1507,4 +1541,4 @@ Unused
 
 ## User Mention
 
-Unused
\ No newline at end of file
+Unused