Add new Friendica Photo Album GET endpoints to documentation

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

diff --git a/doc/API-Entities.md b/doc/API-Entities.md
index e369cb4ffdaad218a922ec8258175fcb7fae2353..0242f4ab0a503f32fc20e8a78bf5368ffa6b4d13 100644 (file)
--- a/doc/API-Entities.md
+++ b/doc/API-Entities.md
@@ -410,13 +410,13 @@ Ex: Wed May 23 06:01:13 +0000 2007
 </tr>
 
 <tr>
-<td><code>startTime</code></td>
+<td><code>start_time</code></td>
 <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
 <td></td>
 </tr>
 
 <tr>
-<td><code>endTime</code></td>
+<td><code>end_time</code></td>
 <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
 <td>Optional (null date is <code>0001-01-01 00:00:00</code></td>
 </tr>
@@ -439,12 +439,6 @@ Ex: Wed May 23 06:01:13 +0000 2007
 <td>Optional. Location.</td>
 </tr>
 
-<tr>
-<td><code>adjust</code></td>
-<td>Boolean</td>
-<td>???</td>
-</tr>
-
 <tr>
 <td><code>ignore</code></td>
 <td>Boolean</td>
@@ -771,7 +765,7 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
 <li>64: Unused</li>
 <li>128: Mention</li>
 <li>256: Tag added to a post</li>
-<li>512: Poke</li>
+<li>512: Poke (Obsolete)</li>
 <li>1024: New post</li>
 <li>16384: System email</li>
 <li>32768: System event</li>
@@ -914,6 +908,13 @@ Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tw
 <td>Resource ID (32 hex chars)</td>
 </tr>
 
+<tr>
+<td><code>media-id</code></td>
+<td>String (Integer) </td>
+<td>ID used for attaching to a Mastodon Post Status</td>
+</tr>
+
+
 <tr>
 <td><code>created</code></td>
 <td>String (Date)</td>
@@ -1007,6 +1008,14 @@ Mutually exclusive with <code>data</code> <code>datasize</code>.
 </td>
 </tr>
 
+<tr>
+<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
+</td>
+</tr>
+
 <tr>
 <td><code>datasize</code></td>
 <td>Integer</td>
@@ -1046,6 +1055,58 @@ Mutually exclusive with <code>link</code>.
 </tbody>
 </table>
 
+## Photo Scale
+
+<table class="table table-condensed table-striped table-bordered">
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Type</th>
+<th align="center">Nullable</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><code>id</code></td>
+<td>String (Integer)</td>
+<td>Row ID of this photo scale</td>
+</tr>
+
+<tr>
+<td><code>scale</code></td>
+<td>Integer</td>
+<td>Scale number</td>
+</tr>
+
+<tr>
+<td><code>link</code></td>
+<td>String (URL)</td>
+<td>URL to this scale's image</td>
+</tr>
+
+<tr>
+<td><code>height</code></td>
+<td>Integer</td>
+<td>Image height in pixels</td>
+</tr>
+
+<tr>
+<td><code>width</code></td>
+<td>Integer</td>
+<td>Image width in pixels</td>
+</tr>
+
+<tr>
+<td><code>size</code></td>
+<td>Integer</td>
+<td>Image size in bytes</td>
+</tr>
+
+</tbody>
+</table>
+
+
 ## Photo List Item
 
 <table class="table table-condensed table-striped table-bordered">
@@ -1109,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">