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:
paranarimasu authored and Maniload committed 2024-03-21 22:28:39 +01:00
1 parent 63e16135a9
commit fa3c714de4
43 files changed
+1077 -26

No files matched your search

+4
View File
@@ -40,6 +40,10 @@ The page force delete endpoint hard deletes a page and returns a confirmation me
The page index endpoint displays a listing of page resources.
**[Page Restore](/document/page/restore/)**
The page restore endpoint restores a soft deleted page and returns the restored page resource.
**[Page Show](/document/page/show/)**
The page show endpoint returns a page resource.
+47
View File
@@ -0,0 +1,47 @@
---
title: Page Restore
---
# Page Restore Endpoint
The page restore endpoint restores a soft deleted page and returns the restored page resource.
For example, the `/restore/page/encoding` endpoint will restore the soft deleted Encoding page and return the restored Encoding resource.
## URL
```sh
PATCH /restore/page/{slug}
```
## Authentication
**Required Permission**: restore page
**Roles with Permission**: Wiki Editor, Admin
## Parameters
None
## Response
```json
{
page: {
id: id,
name: "name",
slug: "slug",
body: "body",
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/page/encoding
```