From 014a345b10de6521cc3e5c74abf87cfd063eb6d8 Mon Sep 17 00:00:00 2001 From: Maniload <1999mani@gmail.com> Date: Tue, 5 Mar 2024 00:25:01 +0100 Subject: [PATCH] clean: Removed wiki config section --- docs/.vitepress/config.js | 17 --------------- docs/config/index.md | 15 ------------- docs/config/wiki/index.md | 25 ---------------------- docs/config/wiki/show/index.md | 39 ---------------------------------- 4 files changed, 96 deletions(-) delete mode 100644 docs/config/index.md delete mode 100644 docs/config/wiki/index.md delete mode 100644 docs/config/wiki/show/index.md diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 657ca9c..ca29bad 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -63,13 +63,6 @@ export default { { text: 'User', link: '/auth/user/' } ], }, - { - text: 'Config', - items: [ - { text: 'Index', link: '/config/' }, - { text: 'Wiki', link: '/config/wiki/' } - ] - }, { text: 'Document', items: [ @@ -213,16 +206,6 @@ export default { ] } ], - '/config/': [ - { - text: 'Wiki Config', - collapsed: true, - items: [ - { text: 'Resource', link: '/config/wiki/' }, - { text: 'Show', link: '/config/wiki/show/' } - ] - } - ], '/document/': [ { text: 'Page', diff --git a/docs/config/index.md b/docs/config/index.md deleted file mode 100644 index a5226c4..0000000 --- a/docs/config/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Config ---- - -# Config - ---- - -Config API resources pertain to site configuration. - -## Resources - -**[Wiki](/config/wiki/)** - -The config wiki API resource contains the list of settings that impact animethemes-web functionalities. \ No newline at end of file diff --git a/docs/config/wiki/index.md b/docs/config/wiki/index.md deleted file mode 100644 index 034e269..0000000 --- a/docs/config/wiki/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Wiki ---- - -# Wiki - ---- - -The config wiki API resource contains the list of settings that impact animethemes-web functionalities. - -## Fields - -| Name | Type | Nullable | Default | Description | -| :------------: | :----: | :------: | :-----: | :-------------------------------------------------------------------- | -| featured_theme | String | Yes | Yes | The theme played in the background on the homepage of the wiki client | - -## Allowed Include Paths - -None - -### Endpoints - -**[Wiki Show](/config/wiki/show/)** - -The Wiki Show endpoint return the wiki resource. \ No newline at end of file diff --git a/docs/config/wiki/show/index.md b/docs/config/wiki/show/index.md deleted file mode 100644 index 15db4d7..0000000 --- a/docs/config/wiki/show/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Wiki Show ---- - -# Wiki Show Endpoint - -The wiki show endpoint returns the wiki resource. - -## URL - -```sh -GET /config/wiki -``` - -## Authentication - -None - -## Parameters - -| Name | Required | Description | -| :-----: | :------: | :------------------------------------------------------ | -| fields | No | Sparse fieldsets for resource types | - -## Response - -```json -{ - wiki: { - featured_theme: "featured_theme", - } -} -``` - -## Example - -```bash -curl https://api.animethemes.moe/config/wiki -```