mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-10-16 07:50:37 +02:00
feat: add documentation for restore endpoints (#52)
* feat: add documentation for restore endpoints * fix: missing prefix on playlist restore route
This commit is contained in:
1 parent
63e16135a9
commit
fa3c714de4
43 files changed
+1077
-26
No files matched your search
@@ -38,6 +38,10 @@ The announcement force delete endpoint hard deletes an announcement and returns
|
||||
|
||||
The announcement index endpoint displays a listing of announcement resources.
|
||||
|
||||
**[Announcement Restore](/admin/announcement/restore/)**
|
||||
|
||||
The announcement restore endpoint restores a soft deleted announcement and returns the restored announcement resource.
|
||||
|
||||
**[Announcement Show](/admin/announcement/show/)**
|
||||
|
||||
The announcement show endpoint returns an announcement resource.
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Announcement Restore
|
||||
---
|
||||
|
||||
# Announcement Restore Endpoint
|
||||
|
||||
The announcement restore endpoint restores a soft deleted announcement and returns the restored announcement resource.
|
||||
|
||||
For example, the `/restore/announcement/1` endpoint will restore the soft deleted announcement of id '1' and return the restored announcement resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PATCH /restore/announcement/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: restore announcement
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
None
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
announcement: {
|
||||
id: id,
|
||||
content: "content",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/restore/announcement/1
|
||||
```
|
||||
@@ -39,6 +39,10 @@ The dump force delete endpoint hard deletes a dump and returns a confirmation me
|
||||
|
||||
The dump index endpoint displays a listing of dump resources.
|
||||
|
||||
**[Dump Restore](/admin/dump/restore/)**
|
||||
|
||||
The dump restore endpoint restores a soft deleted dump and returns the restored dump resource.
|
||||
|
||||
**[Dump Show](/admin/dump/show/)**
|
||||
|
||||
The dump show endpoint returns a dump resource.
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Dump Restore
|
||||
---
|
||||
|
||||
# Dump Restore Endpoint
|
||||
|
||||
The dump restore endpoint restores a soft deleted dump and returns the restored dump resource.
|
||||
|
||||
For example, the `/restore/dump/1` endpoint will restore the soft deleted dump of id '1' and return the restored dump resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PATCH /restore/dump/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: restore dump
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
None
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
dump: {
|
||||
id: id,
|
||||
path: "path",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_at",
|
||||
link: "link
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/restore/dump/1
|
||||
```
|
||||
Reference in new issue
Block a user