Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2024-12-22 22:00:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add new Friendica Photo Album GET endpoints to documentation

Browse source
This commit is contained in:
Hank Grabowski 2023-02-22 22:35:24 -05:00
parent a8661f1eff
commit d64ae9bef2
2 changed files with 120 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
doc/API-Entities.md
View file

@ -1170,6 +1170,40 @@ Mutually exclusive with <code>link</code>.
</tbody> </tbody>
</table> </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 ## Private message
<table class="table table-condensed table-striped table-bordered"> <table class="table table-condensed table-striped table-bordered">

88
doc/API-Friendica.md
View file

@ -665,8 +665,8 @@ On success:
```json ```json
{ {
"result": "updated", "result": "updated",
"message":"album 'abc' with all containing photos has been renamed to 'xyz'." "message":"album 'abc' with all containing photos has been renamed to 'xyz'."
} }
``` ```
@ -676,8 +676,92 @@ On error:
* 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available" * 400 BADREQUEST: "no albumname specified", "no new albumname specified", "album not available"
* 500 INTERNALSERVERERROR: "unknown error - updating in database failed" * 500 INTERNALSERVERERROR: "unknown error - updating in database failed"
### GET api/friendica/photoalbums
Get a list of photo albums for the user
#### Parameters
None
#### Return values
On success a list of photo album objects:
```json
[
{
"name": "Wall Photos",
"created": "2023-01-22 02:03:19",
"count": 4
},
{
"name": "Profile photos",
"created": "2022-11-20 14:40:06",
"count": 1
}
]
```
### GET api/friendica/photoalbum
Get a list of images in a photo album
#### Parameters
* `album` (Required): name of the album to be deleted
* `limit` (Optional): Maximum number of items to get, defaults to 50, max 500
* `offset`(Optional): Offset in results to page through total items, defaults to 0
* `latest_first` (Optional): Reverse the order so the most recent images are first, defaults to false
#### Return values
On success:
* JSON return with the list of Photo items
**Example:**
`https://<server>/api/friendica/photoalbum?album=Wall Photos&limit=10&offset=2`
```json
[
{
"created": "2023-02-14 14:31:06",
"edited": "2023-02-14 14:31:14",
"title": "",
"desc": "",
"album": "Wall Photos",
"filename": "image.png",
"type": "image/png",
"height": 835,
"width": 693,
"datasize": 119523,
"profile": 0,
"allow_cid": "",
"deny_cid": "",
"allow_gid": "",
"deny_gid": "",
"id": "899184972463eb9b2ae3dc2580502826",
"scale": 0,
"media-id": 52,
"scales": [
{
"id": 52,
"scale": 0,
"link": "https://<server>/photo/899184972463eb9b2ae3dc2580502826-0.png",
"width": 693,
"height": 835,
"size": 119523
},
...
],
"thumb": "https://<server>/photo/899184972463eb9b2ae3dc2580502826-2.png"
},
...
]
```
--- ---
### GET api/friendica/profile/show ### GET api/friendica/profile/show
Returns the [Profile](help/API-Entities#Profile) data of the authenticated user. Returns the [Profile](help/API-Entities#Profile) data of the authenticated user.