knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-09-20 07:16:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update API docs of media with missing api (#1975)

Browse source
This commit is contained in:
Bowrna 2024-08-06 11:41:13 +05:30 committed by GitHub
parent 1e6e97e750
commit e4dcb066d9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 41 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
docs/docs/content/apis/media.md
View file

@ -1,8 +1,9 @@
# API / Media
Method | Endpoint | Description
-------|------------------------------------------------|------------------------------
-------|------------------------------------------------------|---------------------------------
GET | [/api/media](#get-apimedia) | Get uploaded media file
GET | [/api/media/{media_id}](#get-apimediamedia_id) | Get specific uploaded media file
POST | [/api/media](#post-apimedia) | Upload media file
DELETE | [/api/media/{media_id}](#delete-apimediamedia_id) | Delete uploaded media file
@ -35,7 +36,42 @@ curl -u "username:password" -X GET 'http://localhost:9000/api/media' \
]
}
```
______________________________________________________________________
#### GET /api/media/{media_id}
Retrieve a specific media.
##### Parameters
| Name | Type | Required | Description |
|:--------------|:----------|:---------|:-----------------|
| media_id | Number | Yes | Media ID. |
##### Example Request
```shell
curl -u 'username:password' 'http://localhost:9000/api/media/7'
```
##### Example Response
```json
{
"data":
{
"id": 7,
"uuid": "62e32e97-d6ca-4441-923f-b62607000dd1",
"filename": "ResumeB.pdf",
"content_type": "application/pdf",
"created_at": "2024-08-06T11:28:53.888257+05:30",
"thumb_url": null,
"provider": "filesystem",
"meta": {},
"url": "http://localhost:9000/uploads/ResumeB.pdf"
}
}
```
______________________________________________________________________
#### POST /api/media