mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-11 01:34:06 +02:00
feat: vitepress migration (#43)
This commit is contained in:
paranarimasu
@@ -13,7 +13,7 @@ The AnimeThemes API provides access to our repository resources for your develop
|
||||
|
||||
This is the repository for the [**AnimeThemes.moe API documentation**](https://api-docs.animethemes.moe/).
|
||||
|
||||
This project is powered by [**VuePress**](https://vuepress.vuejs.org/), a minimalistic static site generator.
|
||||
This project is powered by [**VitePress**](https://vitepress.vuejs.org/), a Vite & Vue Powered Static Site Generator.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -23,9 +23,9 @@ In the project root directory, install dependencies.
|
||||
|
||||
In the project root directory, start the local development server.
|
||||
|
||||
`npm run dev`
|
||||
`npm run docs:dev`
|
||||
|
||||
That's it! The local development server should be running at `localhost:8080`.
|
||||
That's it! The local development server should be running at `localhost:3000`.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
@@ -0,0 +1,274 @@
|
||||
import 'dotenv/config';
|
||||
|
||||
export default {
|
||||
base: process.env.VITEPRESS_BASE,
|
||||
lang: 'en-US',
|
||||
lastUpdated: true,
|
||||
title: 'AnimeThemes',
|
||||
description: 'AnimeThemes API Documentation',
|
||||
themeConfig: {
|
||||
logo: '/logo.svg',
|
||||
siteTitle: 'AnimeThemes API Documentation',
|
||||
socialLinks: [
|
||||
{ icon: 'discord', link: 'https://discordapp.com/invite/m9zbVyQ' },
|
||||
{ icon: 'github', link: 'https://github.com/AnimeThemes' },
|
||||
{ icon: 'twitter', link: 'https://twitter.com/AnimeThemesMoe' }
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
text: 'Introduction',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'JSON:API', link: '/jsonapi/' },
|
||||
{ text: 'Rate Limiting', link: '/ratelimiting/' },
|
||||
{ text: 'Authentication', link: '/authentication/' },
|
||||
{ text: 'Validation', link: '/validation/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Anime',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/anime/' },
|
||||
{ text: 'Destroy', link: '/anime/destroy/' },
|
||||
{ text: 'Force Delete', link: '/anime/forceDelete/' },
|
||||
{ text: 'Index', link: '/anime/index/' },
|
||||
{ text: 'Show', link: '/anime/show/' },
|
||||
{ text: 'Store', link: '/anime/store/' },
|
||||
{ text: 'Update', link: '/anime/update/' },
|
||||
{ text: 'Year Index', link: '/animeyear/index/' },
|
||||
{ text: 'Year Show', link: '/animeyear/show/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Anime Image',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/animeimage/' },
|
||||
{ text: 'Destroy', link: '/animeimage/destroy/' },
|
||||
{ text: 'Index', link: '/animeimage/index/' },
|
||||
{ text: 'Show', link: '/animeimage/show/' },
|
||||
{ text: 'Store', link: '/animeimage/store/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Anime Synonym',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/animesynonym/' },
|
||||
{ text: 'Destroy', link: '/animesynonym/destroy/' },
|
||||
{ text: 'Force Delete', link: '/animesynonym/forceDelete/' },
|
||||
{ text: 'Index', link: '/animesynonym/index/' },
|
||||
{ text: 'Show', link: '/animesynonym/show/' },
|
||||
{ text: 'Store', link: '/animesynonym/store/' },
|
||||
{ text: 'Update', link: '/animesynonym/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Anime Theme',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/animetheme/' },
|
||||
{ text: 'Destroy', link: '/animetheme/destroy/' },
|
||||
{ text: 'Force Delete', link: '/animetheme/forceDelete/' },
|
||||
{ text: 'Index', link: '/animetheme/index/' },
|
||||
{ text: 'Show', link: '/animetheme/show/' },
|
||||
{ text: 'Store', link: '/animetheme/store/' },
|
||||
{ text: 'Update', link: '/animetheme/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Anime Theme Entry',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/animethemeentry/' },
|
||||
{ text: 'Destroy', link: '/animethemeentry/destroy/' },
|
||||
{ text: 'Force Delete', link: '/animethemeentry/forceDelete/' },
|
||||
{ text: 'Index', link: '/animethemeentry/index/' },
|
||||
{ text: 'Show', link: '/animethemeentry/show/' },
|
||||
{ text: 'Store', link: '/animethemeentry/store/' },
|
||||
{ text: 'Update', link: '/animethemeentry/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Announcement',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/announcement/' },
|
||||
{ text: 'Destroy', link: '/announcement/destroy/' },
|
||||
{ text: 'Force Delete', link: '/announcement/forceDelete/' },
|
||||
{ text: 'Index', link: '/announcement/index/' },
|
||||
{ text: 'Show', link: '/announcement/show/' },
|
||||
{ text: 'Store', link: '/announcement/store/' },
|
||||
{ text: 'Update', link: '/announcement/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Artist',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/artist/' },
|
||||
{ text: 'Destroy', link: '/artist/destroy/' },
|
||||
{ text: 'Force Delete', link: '/artist/forceDelete/' },
|
||||
{ text: 'Index', link: '/artist/index/' },
|
||||
{ text: 'Show', link: '/artist/show/' },
|
||||
{ text: 'Store', link: '/artist/store/' },
|
||||
{ text: 'Update', link: '/artist/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Audio',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/audio/' },
|
||||
{ text: 'Destroy', link: '/audio/destroy/' },
|
||||
{ text: 'Force Delete', link: '/audio/forceDelete/' },
|
||||
{ text: 'Index', link: '/audio/index/' },
|
||||
{ text: 'Show', link: '/audio/show/' },
|
||||
{ text: 'Store', link: '/audio/store/' },
|
||||
{ text: 'Update', link: '/audio/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Balance',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/balance/' },
|
||||
{ text: 'Destroy', link: '/balance/destroy/' },
|
||||
{ text: 'Force Delete', link: '/balance/forceDelete/' },
|
||||
{ text: 'Index', link: '/balance/index/' },
|
||||
{ text: 'Show', link: '/balance/show/' },
|
||||
{ text: 'Store', link: '/balance/store/' },
|
||||
{ text: 'Update', link: '/balance/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Feature Flags',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/config/flags/' },
|
||||
{ text: 'Show', link: '/config/flags/show/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Global Search',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Search', link: '/search/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Image',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/image/' },
|
||||
{ text: 'Destroy', link: '/image/destroy/' },
|
||||
{ text: 'Force Delete', link: '/image/forceDelete/' },
|
||||
{ text: 'Index', link: '/image/index/' },
|
||||
{ text: 'Show', link: '/image/show/' },
|
||||
{ text: 'Store', link: '/image/store/' },
|
||||
{ text: 'Update', link: '/image/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Page',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/page/' },
|
||||
{ text: 'Destroy', link: '/page/destroy/' },
|
||||
{ text: 'Force Delete', link: '/page/forceDelete/' },
|
||||
{ text: 'Index', link: '/page/index/' },
|
||||
{ text: 'Show', link: '/page/show/' },
|
||||
{ text: 'Store', link: '/page/store/' },
|
||||
{ text: 'Update', link: '/page/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Resource',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/resource/' },
|
||||
{ text: 'Destroy', link: '/resource/destroy/' },
|
||||
{ text: 'Force Delete', link: '/resource/forceDelete/' },
|
||||
{ text: 'Index', link: '/resource/index/' },
|
||||
{ text: 'Show', link: '/resource/show/' },
|
||||
{ text: 'Store', link: '/resource/store/' },
|
||||
{ text: 'Update', link: '/resource/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Series',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/series/' },
|
||||
{ text: 'Destroy', link: '/series/destroy/' },
|
||||
{ text: 'Force Delete', link: '/series/forceDelete/' },
|
||||
{ text: 'Index', link: '/series/index/' },
|
||||
{ text: 'Show', link: '/series/show/' },
|
||||
{ text: 'Store', link: '/series/store/' },
|
||||
{ text: 'Update', link: '/series/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Song',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/song/' },
|
||||
{ text: 'Destroy', link: '/song/destroy/' },
|
||||
{ text: 'Force Delete', link: '/song/forceDelete/' },
|
||||
{ text: 'Index', link: '/song/index/' },
|
||||
{ text: 'Show', link: '/song/show/' },
|
||||
{ text: 'Store', link: '/song/store/' },
|
||||
{ text: 'Update', link: '/song/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Studio',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/studio/' },
|
||||
{ text: 'Destroy', link: '/studio/destroy/' },
|
||||
{ text: 'Force Delete', link: '/studio/forceDelete/' },
|
||||
{ text: 'Index', link: '/studio/index/' },
|
||||
{ text: 'Show', link: '/studio/show/' },
|
||||
{ text: 'Store', link: '/studio/store/' },
|
||||
{ text: 'Update', link: '/studio/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Transaction',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/transaction/' },
|
||||
{ text: 'Destroy', link: '/transaction/destroy/' },
|
||||
{ text: 'Force Delete', link: '/transaction/forceDelete/' },
|
||||
{ text: 'Index', link: '/transaction/index/' },
|
||||
{ text: 'Show', link: '/transaction/show/' },
|
||||
{ text: 'Store', link: '/transaction/store/' },
|
||||
{ text: 'Update', link: '/transaction/update/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Wiki Config',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/config/wiki/' },
|
||||
{ text: 'Show', link: '/config/wiki/show/' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Video',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/video/' },
|
||||
{ text: 'Destroy', link: '/video/destroy/' },
|
||||
{ text: 'Force Delete', link: '/video/forceDelete/' },
|
||||
{ text: 'Index', link: '/video/index/' },
|
||||
{ text: 'Show', link: '/video/show/' },
|
||||
{ text: 'Store', link: '/video/store/' },
|
||||
{ text: 'Update', link: '/video/update/' },
|
||||
]
|
||||
},
|
||||
]
|
||||
}
|
||||
}
|
||||
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
@@ -1,568 +0,0 @@
|
||||
require('dotenv').config()
|
||||
|
||||
module.exports = {
|
||||
base: process.env.VUEPRESS_BASE,
|
||||
description: 'AnimeThemes API Documentation',
|
||||
theme: 'api',
|
||||
themeConfig: {
|
||||
sidebar: {
|
||||
'home': {
|
||||
title: 'Introduction',
|
||||
to: '/',
|
||||
children: [
|
||||
{
|
||||
title: 'JSON:API',
|
||||
to: '/jsonapi'
|
||||
},
|
||||
{
|
||||
title: 'Rate Limiting',
|
||||
to: '/ratelimiting'
|
||||
},
|
||||
{
|
||||
title: 'Authentication',
|
||||
to: '/authentication'
|
||||
},
|
||||
{
|
||||
title: 'Validation',
|
||||
to: '/validation'
|
||||
}
|
||||
]
|
||||
},
|
||||
'anime': {
|
||||
title: 'Resource',
|
||||
to: '/anime',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/anime/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/anime/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/anime/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/anime/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/anime/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/anime/update/',
|
||||
},
|
||||
{
|
||||
title: 'Year Index',
|
||||
to: '/animeyear/index/'
|
||||
},
|
||||
{
|
||||
title: 'Year Show',
|
||||
to: '/animeyear/show/'
|
||||
},
|
||||
]
|
||||
},
|
||||
'animeimage': {
|
||||
title: 'Resource',
|
||||
to: '/animeimage',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/animeimage/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/animeimage/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/animeimage/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/animeimage/store/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'animesynonym': {
|
||||
title: 'Resource',
|
||||
to: '/animesynonym',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/animesynonym/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/animesynonym/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/animesynonym/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/animesynonym/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/animesynonym/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/animesynonym/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'animetheme': {
|
||||
title: 'Resource',
|
||||
to: '/animetheme',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/animetheme/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/animetheme/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/animetheme/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/animetheme/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/animetheme/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/animetheme/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'animethemeentry': {
|
||||
title: 'Resource',
|
||||
to: '/animethemeentry',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/animethemeentry/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/animethemeentry/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/animethemeentry/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/animethemeentry/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/animethemeentry/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/animethemeentry/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'announcement': {
|
||||
title: 'Resource',
|
||||
to: '/announcement',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/announcement/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/announcement/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/announcement/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/announcement/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/announcement/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/announcement/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'artist': {
|
||||
title: 'Resource',
|
||||
to: '/artist',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/artist/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/artist/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/artist/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/artist/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/artist/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/artist/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'audio': {
|
||||
title: 'Resource',
|
||||
to: '/audio',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/audio/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/audio/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/audio/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/audio/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/audio/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/audio/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'balance': {
|
||||
title: 'Resource',
|
||||
to: '/balance',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/balance/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/balance/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/balance/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/balance/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/balance/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/balance/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'configflags': {
|
||||
title: 'Resource',
|
||||
to: '/config/flags',
|
||||
children: [
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/config/flags/show/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'configwiki': {
|
||||
title: 'Resource',
|
||||
to: '/config/wiki',
|
||||
children: [
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/config/wiki/show/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'image': {
|
||||
title: 'Resource',
|
||||
to: '/image',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/image/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/image/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/image/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/image/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/image/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/image/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'page': {
|
||||
title: 'Resource',
|
||||
to: '/page',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/page/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/page/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/page/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/page/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/page/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/page/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'resource': {
|
||||
title: 'Resource',
|
||||
to: '/resource',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/resource/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/resource/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/resource/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/resource/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/resource/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/resource/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'series': {
|
||||
title: 'Resource',
|
||||
to: '/series',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/series/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/series/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/series/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/series/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/series/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/series/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'song': {
|
||||
title: 'Resource',
|
||||
to: '/song',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/song/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/song/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/song/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/song/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/song/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/song/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'studio': {
|
||||
title: 'Resource',
|
||||
to: '/studio',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/studio/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/studio/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/studio/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/studio/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/studio/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/studio/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'transaction': {
|
||||
title: 'Resource',
|
||||
to: '/transaction',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/transaction/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/transaction/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/transaction/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/transaction/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/transaction/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/transaction/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'video': {
|
||||
title: 'Resource',
|
||||
to: '/video',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/video/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Force Delete',
|
||||
to: '/video/forceDelete/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/video/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/video/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/video/store/',
|
||||
},
|
||||
{
|
||||
title: 'Update',
|
||||
to: '/video/update/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'wiki': {
|
||||
title: 'Global Search',
|
||||
to: '/search'
|
||||
}
|
||||
}
|
||||
},
|
||||
title: 'AnimeThemes'
|
||||
}
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Destroy Endpoint
|
||||
|
||||
The anime destroy endpoint soft deletes an anime and returns the deleted anime resource.
|
||||
@@ -44,14 +42,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/anime/bakemonogatari
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Force Delete Endpoint
|
||||
|
||||
The anime force delete endpoint hard deletes an anime and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/anime/bakemonogatari
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
```
|
||||
@@ -18,7 +18,7 @@ For example, Bakemonogatari is an anime production with five opening sequences a
|
||||
| name | String | No | The primary title of the anime |
|
||||
| slug | String | No | The URL slug & route key of the resource |
|
||||
| year | Integer | Yes | The premiere year of the anime |
|
||||
| season | Enum | Yes | The premiere season of the anime {Winter, Spring, Summer, Fall} |
|
||||
| season | Enum | Yes | The premiere season of the anime [Winter, Spring, Summer, Fall] |
|
||||
| synopsis | String | Yes | The brief summary of the anime |
|
||||
| created_at | Date | No | The date that the resource was created |
|
||||
| updated_at | Date | No | The date that the resource was last modified |
|
||||
@@ -30,6 +30,7 @@ For example, Bakemonogatari is an anime production with five opening sequences a
|
||||
* animethemes
|
||||
* animethemes.animethemeentries
|
||||
* animethemes.animethemeentries.videos
|
||||
* animethemes.animethemeentries.videos.audio
|
||||
* animethemes.song
|
||||
* animethemes.song.artists
|
||||
* images
|
||||
@@ -63,10 +64,10 @@ The anime store endpoint creates a new anime and returns the new anime resource.
|
||||
|
||||
The anime update endpoint updates an anime and returns the updated anime resource.
|
||||
|
||||
**[Year Show](/year/show/)**
|
||||
**[Year Show](/animeyear/show/)**
|
||||
|
||||
The year show endpoint return a listing of anime resources for a given year grouped by season and ordered by name.
|
||||
|
||||
**[Year Index](/year/index/)**
|
||||
**[Year Index](/animeyear/index/)**
|
||||
|
||||
The year index endpoint returns a list of unique years from all anime resources.
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Index Endpoint
|
||||
|
||||
The anime index endpoint returns a listing of anime resources.
|
||||
@@ -58,7 +56,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
@@ -95,14 +93,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/anime/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
```
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Show Endpoint
|
||||
|
||||
The anime show endpoint returns an anime resource.
|
||||
@@ -47,14 +45,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/anime/bakemonogatari
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
```
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Store Endpoint
|
||||
|
||||
The anime store endpoint creates a new anime and returns the new anime resource.
|
||||
@@ -27,10 +25,10 @@ POST /anime
|
||||
| Name | Required | Rules |
|
||||
| :------: | :------: | :----------------------------------------------------- |
|
||||
| name | Yes | string, max:192 |
|
||||
| season | Yes | EnumValue {Winter, Spring, Summer, Fall} |
|
||||
| season | Yes | EnumValue [Winter, Spring, Summer, Fall] |
|
||||
| slug | Yes | string, max:192, alpha_dash, unique |
|
||||
| synopsis | No | string, max:65535 |
|
||||
| year | Yes | integer, digits:4, min:1960, max:{current year + 1} |
|
||||
| year | Yes | integer, digits:4, min:1960, max:[current year + 1] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -50,14 +48,8 @@ POST /anime
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/anime/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
```
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Update Endpoint
|
||||
|
||||
The anime update endpoint updates an anime and returns the updated anime resource.
|
||||
@@ -27,10 +25,10 @@ PUT|PATCH /anime/{slug}
|
||||
| Name | Required | Rules |
|
||||
| :------: | :------: | :----------------------------------------------------- |
|
||||
| name | No | string, max:192 |
|
||||
| season | No | EnumValue {Winter, Spring, Summer, Fall} |
|
||||
| season | No | EnumValue [Winter, Spring, Summer, Fall] |
|
||||
| slug | No | string, max:192, alpha_dash, unique |
|
||||
| synopsis | No | string, max:65535 |
|
||||
| year | No | integer, digits:4, min:1960, max:{current year + 1} |
|
||||
| year | No | integer, digits:4, min:1960, max:[current year + 1] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -50,14 +48,8 @@ PUT|PATCH /anime/{slug}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/anime/bakemonogatari
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
```
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Image Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Destroy Endpoint
|
||||
|
||||
The anime image destroy endpoint deletes an anime image and returns the deleted anime image resource.
|
||||
@@ -37,14 +35,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeimage/bakemonogatari/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Image Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Index Endpoint
|
||||
|
||||
The anime image index endpoint returns a listing of anime image resources.
|
||||
@@ -71,14 +69,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animeimage/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Image Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Show Endpoint
|
||||
|
||||
The anime image show endpoint returns an anime image resource.
|
||||
@@ -35,14 +33,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animeimage/bakemonogatari/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Image Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Store Endpoint
|
||||
|
||||
The anime image store endpoint creates a new anime image and returns the new anime image resource.
|
||||
@@ -40,14 +38,8 @@ POST /animeimage
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeimage/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Synonym Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Synonym Destroy Endpoint
|
||||
|
||||
The anime synonym destroy endpoint soft deletes an anime synonym and returns the deleted anime synonym resource.
|
||||
@@ -40,14 +38,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/animesynonym/1523
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Synonym Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Synonym Force Delete Endpoint
|
||||
|
||||
The anime synonym force delete endpoint hard deletes an anime synonym and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/animesynonym/1523
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Synonym Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Synonym Index Endpoint
|
||||
|
||||
The anime synonym index endpoint returns a listing of anime synonym resources.
|
||||
@@ -50,7 +48,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
@@ -83,14 +81,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animesynonym/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Synonym Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Synonym Show Endpoint
|
||||
|
||||
The anime synonym show endpoint returns an anime synonym resource.
|
||||
@@ -43,14 +41,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animesynonym/1523
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Synonym Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Synonym Store Endpoint
|
||||
|
||||
The anime synonym store endpoint creates a new anime synonym and returns the new anime synonym resource.
|
||||
@@ -43,14 +41,8 @@ POST /animesynonym
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/animesynonym/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Synonym Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Synonym Update Endpoint
|
||||
|
||||
The anime synonym update endpoint updates an anime synonym and returns the updated anime synonym resource.
|
||||
@@ -43,14 +41,8 @@ PUT|PATCH /animesynonym/{id}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/animesynonym/1523
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Destroy Endpoint
|
||||
|
||||
The anime theme destroy endpoint soft deletes an anime theme and returns the deleted anime theme resource.
|
||||
@@ -43,14 +41,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/animetheme/3373
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Force Delete Endpoint
|
||||
|
||||
The anime theme force delete endpoint hard deletes an anime theme and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/animetheme/3373
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -15,7 +15,7 @@ For example, the anime Bakemonogatari has five OP anime themes and one ED anime
|
||||
| Name | Type | Nullable | Description |
|
||||
| :--------: | :-----: | :------: | :--------------------------------------------------------------- |
|
||||
| id | Integer | No | The primary key of the resource |
|
||||
| type | Enum | Yes | The type of the sequence {OP, ED} |
|
||||
| type | Enum | Yes | The type of the sequence [OP, ED] |
|
||||
| sequence | Integer | Yes | The numeric ordering of the theme |
|
||||
| group | String | Yes | Used to distinguish sequence belongs to dubs, rebroadcasts, etc. |
|
||||
| slug | String | No | The URL slug & route key of the resource |
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Index Endpoint
|
||||
|
||||
The anime theme index endpoint returns a listing of anime theme resources.
|
||||
@@ -64,7 +62,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
@@ -100,14 +98,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animetheme/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Show Endpoint
|
||||
|
||||
The anime theme show endpoint returns an anime theme resource.
|
||||
@@ -46,14 +44,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animetheme/3373
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Store Endpoint
|
||||
|
||||
The anime theme store endpoint creates a new anime theme and returns the new anime theme resource.
|
||||
@@ -27,7 +25,7 @@ POST /animetheme
|
||||
| Name | Required | Rules |
|
||||
| :------: | :------: | :-------------------------- |
|
||||
| anime_id | Yes | integer, Anime ID exists |
|
||||
| type | Yes | EnumValue {OP, ED} |
|
||||
| type | Yes | EnumValue [OP, ED] |
|
||||
| sequence | No | integer, min:0 |
|
||||
| group | No | string, max:192 |
|
||||
| slug | Yes | string, max:192, alpha_dash |
|
||||
@@ -50,14 +48,8 @@ POST /animetheme
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/animetheme/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Update Endpoint
|
||||
|
||||
The anime theme update endpoint updates an anime theme and returns the updated anime theme resource.
|
||||
@@ -27,7 +25,7 @@ PUT|PATCH /animetheme/{id}
|
||||
| Name | Required | Rules |
|
||||
| :------: | :------: | :-------------------------- |
|
||||
| anime_id | No | integer, Anime ID exists |
|
||||
| type | No | EnumValue {OP, ED} |
|
||||
| type | No | EnumValue [OP, ED] |
|
||||
| sequence | No | integer, min:0 |
|
||||
| group | No | string, max:192 |
|
||||
| slug | No | string, max:192, alpha_dash |
|
||||
@@ -50,14 +48,8 @@ PUT|PATCH /animetheme/{id}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/animetheme/3373
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Entry Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Entry Destroy Endpoint
|
||||
|
||||
The anime theme entry destroy endpoint soft deletes an anime theme entry and returns the deleted anime theme entry resource.
|
||||
@@ -44,14 +42,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/animethemeentry/3822
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
+1
-9
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Entry Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Entry Force Delete Endpoint
|
||||
|
||||
The anime theme entry force delete endpoint hard deletes an anime theme entry and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/animethemeentry/3822
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Entry Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Entry Index Endpoint
|
||||
|
||||
The anime theme entry index endpoint returns a listing of anime theme entry resources.
|
||||
@@ -58,7 +56,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
@@ -95,14 +93,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animethemeentry/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Entry Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Entry Show Endpoint
|
||||
|
||||
The anime theme entry show endpoint returns an anime theme entry resource.
|
||||
@@ -47,14 +45,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animethemeentry/3822
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Entry Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Entry Store Endpoint
|
||||
|
||||
The anime theme entry store endpoint creates a new anime theme entry and returns the new anime theme entry resource.
|
||||
@@ -51,14 +49,8 @@ POST /animethemeentry
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/animethemeentry/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Anime Theme Entry Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Theme Entry Update Endpoint
|
||||
|
||||
The anime theme entry update endpoint updates an anime theme entry and returns the updated anime theme entry resource.
|
||||
@@ -51,14 +49,8 @@ PUT|PATCH /animethemeentry/{id}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/animethemeentry/3822
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Year Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Year Index Endpoint
|
||||
|
||||
The year index endpoint returns a list of unique years from all anime resources.
|
||||
@@ -33,14 +31,8 @@ None
|
||||
]
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animeyear/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Year Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Year Show Endpoint
|
||||
|
||||
The year show endpoint return a listing of anime resources for a given year grouped by season and ordered by name.
|
||||
@@ -90,14 +88,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animeyear/2000
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Announcement Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Announcement Destroy Endpoint
|
||||
|
||||
The announcement destroy endpoint soft deletes an announcement and returns the deleted announcement resource.
|
||||
@@ -40,14 +38,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/announcement/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Announcement Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Announcement Force Delete Endpoint
|
||||
|
||||
The announcement force delete endpoint hard deletes an announcement and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/announcement/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Announcement Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Announcement Index Endpoint
|
||||
|
||||
The announcement index endpoint returns a listing of announcement resources.
|
||||
@@ -48,7 +46,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -80,14 +78,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/announcement/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Announcement Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Announcement Show Endpoint
|
||||
|
||||
The announcement show endpoint returns an announcement resource.
|
||||
@@ -38,14 +36,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/announcement/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Announcement Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Announcement Store Endpoint
|
||||
|
||||
The announcement store endpoint creates a new announcement and returns the new announcement resource.
|
||||
@@ -42,14 +40,8 @@ POST /announcement
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/announcement/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Announcement Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Announcement Update Endpoint
|
||||
|
||||
The announcement update endpoint updates an announcement and returns the updated announcement resource.
|
||||
@@ -42,14 +40,8 @@ PUT|PATCH /announcement/{id}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/announcement/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Artist Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Artist Destroy Endpoint
|
||||
|
||||
The artist destroy endpoint soft deletes an artist and returns the deleted artist resource.
|
||||
@@ -41,14 +39,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/artist/chiwa_saito
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Artist Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Artist Force Delete Endpoint
|
||||
|
||||
The artist force delete endpoint hard deletes an artist and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/artist/chiwa_saito
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Artist Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Artist Index Endpoint
|
||||
|
||||
The artist index endpoint returns a listing of artist resources.
|
||||
@@ -52,7 +50,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
@@ -86,14 +84,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/artist/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Artist Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Artist Show Endpoint
|
||||
|
||||
The artist show endpoint returns an artist resource.
|
||||
@@ -44,14 +42,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/artist/chiwa_saito
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Artist Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Artist Store Endpoint
|
||||
|
||||
The artist store endpoint creates a new artist and returns the new artist resource.
|
||||
@@ -44,14 +42,8 @@ POST /artist
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/artist/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Artist Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Artist Update Endpoint
|
||||
|
||||
The artist update endpoint updates an artist and returns the updated artist resource.
|
||||
@@ -44,14 +42,8 @@ PUT|PATCH /artist/{slug}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/artist/chiwa_saito
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Audio Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Audio Destroy Endpoint
|
||||
|
||||
The audio destroy endpoint soft deletes an audio and returns the deleted audio resource.
|
||||
@@ -45,14 +43,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/audio/Bakemonogatari-OP1.ogg
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Audio Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Audio Force Delete Endpoint
|
||||
|
||||
The audio force delete endpoint hard deletes an audio and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/audio/Bakemonogatari-OP1.ogg
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Audio Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Audio Index Endpoint
|
||||
|
||||
The audio index endpoint returns a listing of audio resources.
|
||||
@@ -57,7 +55,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -94,14 +92,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/audio/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Audio Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Audio Show Endpoint
|
||||
|
||||
The audio show endpoint returns an audio resource.
|
||||
@@ -48,14 +46,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/audio/Bakemonogatari-OP1.ogg
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Audio Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Audio Store Endpoint
|
||||
|
||||
The audio store endpoint creates a new audio and returns the new audio resource.
|
||||
@@ -51,14 +49,8 @@ POST /audio
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/audio/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Audio Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Audio Update Endpoint
|
||||
|
||||
The audio update endpoint updates an audio and returns the updated audio resource.
|
||||
@@ -46,14 +44,8 @@ PUT|PATCH /audio/{basename}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/audio/Bakemonogatari-OP1.ogg
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Balance Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Balance Destroy Endpoint
|
||||
|
||||
The balance destroy endpoint soft deletes a balance and returns the deleted balance resource.
|
||||
@@ -44,14 +42,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/balance/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Balance Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Balance Force Delete Endpoint
|
||||
|
||||
The balance force delete endpoint hard deletes a balance and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/balance/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -14,8 +14,8 @@ A balance API resource represents an account balance against usage or upcoming c
|
||||
| :-------------------: | :-----: | :------: | :------------------------------------------------------------------------------------------------------- |
|
||||
| id | Integer | No | The primary key of the resource |
|
||||
| date | Date | No | The given month that the account balance applies to |
|
||||
| service | Enum | No | The service that is billing AnimeThemes {Other, DigitalOcean, AWS, Hover, WalkerServers} |
|
||||
| frequency | Enum | No | The frequency that AnimeThemes is billed by the service {Once, Annually, Biannually, Quarterly, Monthly} |
|
||||
| service | Enum | No | The service that is billing AnimeThemes [Other, DigitalOcean, AWS, Hover, WalkerServers] |
|
||||
| frequency | Enum | No | The frequency that AnimeThemes is billed by the service [Once, Annually, Biannually, Quarterly, Monthly] |
|
||||
| usage | Decimal | No | The amount of services consumed by AnimeThemes in the billing period |
|
||||
| month_to_date_balance | Decimal | No | The balance of the AnimeThemes account with consideration to usage |
|
||||
| created_at | Date | No | The date that the resource was created |
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Balance Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Balance Index Endpoint
|
||||
|
||||
The balance index endpoint returns a listing of balance resources.
|
||||
@@ -56,7 +54,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -92,14 +90,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/balance/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Balance Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Balance Show Endpoint
|
||||
|
||||
The balance show endpoint returns a balance resource.
|
||||
@@ -42,14 +40,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/balance/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Balance Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Balance Store Endpoint
|
||||
|
||||
The balance store endpoint creates a new balance and returns the new balance resource.
|
||||
@@ -27,8 +25,8 @@ POST /balance
|
||||
| Name | Required | Rules |
|
||||
| :-------------------: | :------: | :--------------------------------------------------------- |
|
||||
| date | Yes | date_format:Y-m-d |
|
||||
| service | Yes | EnumValue {Other, DigitalOcean, AWS, Hover, WalkerServers} |
|
||||
| frequency | Yes | EnumValue {Once, Annually, Biannually, Quarterly, Monthly} |
|
||||
| service | Yes | EnumValue [Other, DigitalOcean, AWS, Hover, WalkerServers] |
|
||||
| frequency | Yes | EnumValue [Once, Annually, Biannually, Quarterly, Monthly] |
|
||||
| usage | Yes | regex:/^\-?\d+(\.\d{1,2})?$/ |
|
||||
| month_to_date_balance | Yes | regex:/^\-?\d+(\.\d{1,2})?$/ |
|
||||
|
||||
@@ -50,14 +48,8 @@ POST /balance
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/balance/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Balance Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Balance Update Endpoint
|
||||
|
||||
The balance update endpoint updates a balance and returns the updated balance resource.
|
||||
@@ -27,8 +25,8 @@ PUT|PATCH /balance/{id}
|
||||
| Name | Required | Rules |
|
||||
| :-------------------: | :------: | :--------------------------------------------------------- |
|
||||
| date | No | date_format:Y-m-d |
|
||||
| service | No | EnumValue {Other, DigitalOcean, AWS, Hover, WalkerServers} |
|
||||
| frequency | No | EnumValue {Once, Annually, Biannually, Quarterly, Monthly} |
|
||||
| service | No | EnumValue [Other, DigitalOcean, AWS, Hover, WalkerServers] |
|
||||
| frequency | No | EnumValue [Once, Annually, Biannually, Quarterly, Monthly] |
|
||||
| usage | No | regex:/^\-?\d+(\.\d{1,2})?$/ |
|
||||
| month_to_date_balance | No | regex:/^\-?\d+(\.\d{1,2})?$/ |
|
||||
|
||||
@@ -50,14 +48,8 @@ PUT|PATCH /balance/{id}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/balance/1
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Flags Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Flags Show Endpoint
|
||||
|
||||
The flags show endpoint returns the flags resource.
|
||||
@@ -37,14 +35,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/config/flags
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Wiki Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Wiki Show Endpoint
|
||||
|
||||
The wiki show endpoint returns the wiki resource.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/config/wiki
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Image Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Image Destroy Endpoint
|
||||
|
||||
The image destroy endpoint soft deletes an image and returns the deleted image resource.
|
||||
@@ -44,14 +42,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/image/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Image Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Image Force Delete Endpoint
|
||||
|
||||
The image force delete endpoint hard deletes an image resource and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/image/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -12,17 +12,17 @@ For example, the Bakemonogatari anime has two images to represent small and larg
|
||||
|
||||
### Fields
|
||||
|
||||
| Name | Type | Nullable | Description |
|
||||
| :--------: | :-----: | :------: | :------------------------------------------------------------------------- |
|
||||
| id | Integer | No | The primary key of the resource |
|
||||
| path | String | No | The path of the file in storage |
|
||||
| size | Integer | No | The size of the file in storage in Bytes |
|
||||
| mimetype | String | No | The media type of the file in storage |
|
||||
| facet | Enum | Yes | The component that the resource is intended for {Small Cover, Large Cover} |
|
||||
| link | String | No | The URL to stream the file from storage |
|
||||
| created_at | Date | No | The date that the resource was created |
|
||||
| updated_at | Date | No | The date that the resource was last modified |
|
||||
| deleted_at | Date | Yes | The date that the resource was deleted |
|
||||
| Name | Type | Nullable | Description |
|
||||
| :--------: | :-----: | :------: | :-------------------------------------------------------------------------------- |
|
||||
| id | Integer | No | The primary key of the resource |
|
||||
| path | String | No | The path of the file in storage |
|
||||
| size | Integer | No | The size of the file in storage in Bytes |
|
||||
| mimetype | String | No | The media type of the file in storage |
|
||||
| facet | Enum | Yes | The component that the resource is intended for [Small Cover, Large Cover, Grill] |
|
||||
| link | String | No | The URL to stream the file from storage |
|
||||
| created_at | Date | No | The date that the resource was created |
|
||||
| updated_at | Date | No | The date that the resource was last modified |
|
||||
| deleted_at | Date | Yes | The date that the resource was deleted |
|
||||
|
||||
### Allowed Include Paths
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Image Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Image Index Endpoint
|
||||
|
||||
The image index endpoint returns a listing of image resources.
|
||||
@@ -55,7 +53,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
@@ -92,14 +90,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/image/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Image Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Image Show Endpoint
|
||||
|
||||
The image show endpoint returns an image resource.
|
||||
@@ -47,14 +45,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/image/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Image Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Image Store Endpoint
|
||||
|
||||
The image store endpoint creates a new image and returns the new image resource.
|
||||
@@ -27,7 +25,7 @@ POST /image
|
||||
| Name | Required | Rules |
|
||||
| :---: | :------: | :------------------------------------------ |
|
||||
| file | Yes | image |
|
||||
| facet | Yes | EnumValue {Small Cover, Large Cover, Grill} |
|
||||
| facet | Yes | EnumValue [Small Cover, Large Cover, Grill] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -47,14 +45,8 @@ POST /image
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" -F "file=@lorem_ipsum.jpg" https://api.animethemes.moe/image/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Image Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Image Update Endpoint
|
||||
|
||||
The image update endpoint updates an image and returns the updated image resource.
|
||||
@@ -26,7 +24,7 @@ PUT|PATCH /image/{id}
|
||||
|
||||
| Name | Required | Rules |
|
||||
| :---: | :------: | :------------------------------------------ |
|
||||
| facet | No | EnumValue {Small Cover, Large Cover, Grill} |
|
||||
| facet | No | EnumValue [Small Cover, Large Cover, Grill] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -46,14 +44,8 @@ PUT|PATCH /image/{id}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/image/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -32,7 +32,7 @@ The AnimeThemes API uses form requests to validate query parameters.
|
||||
|
||||
## Terms of Use
|
||||
|
||||
The AnimeThemes API applies the [**AnimeThemes Terms of Service**](/terms-of-service).
|
||||
The AnimeThemes API applies the [**AnimeThemes Terms of Service**](https://app.animethemes.moe/terms-of-service).
|
||||
|
||||
## Resources
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 160 86.6" class="h-6" fill="currentColor"><polygon points="56.25 32.48 56.25 75.78 75 86.6 75 0 0 43.3 18.75 54.13 56.25 32.48"/><polygon points="103.75 32.48 141.25 54.13 160 43.3 85 0 85 86.6 103.75 75.78 103.75 32.48"/></svg>
|
||||
|
After Width: | Height: | Size: 282 B |
@@ -2,8 +2,6 @@
|
||||
title: Page Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Page Destroy Endpoint
|
||||
|
||||
The page destroy endpoint soft deletes a page and returns the deleted page resource.
|
||||
@@ -42,14 +40,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/page/encoding
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Page Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Page Force Delete Endpoint
|
||||
|
||||
The page force delete endpoint hard deletes a page and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/page/encoding
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Page Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Page Index Endpoint
|
||||
|
||||
The page index endpoint returns a listing of page resources.
|
||||
@@ -50,7 +48,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -83,14 +81,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/page/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Page Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Page Show Endpoint
|
||||
|
||||
The page show endpoint returns a page resource.
|
||||
@@ -42,14 +40,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/page/encoding
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Page Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Page Store Endpoint
|
||||
|
||||
The page store endpoint creates a new page and returns the new page resource.
|
||||
@@ -46,14 +44,8 @@ POST /page
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/page/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Page Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Page Update Endpoint
|
||||
|
||||
The page update endpoint updates a page and returns the updated page resource.
|
||||
@@ -46,14 +44,8 @@ PUT|PATCH /page/{slug}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/page/encoding
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Resource Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Resource Destroy Endpoint
|
||||
|
||||
The resource destroy endpoint soft deletes an external resource and returns the deleted external resource.
|
||||
@@ -43,14 +41,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/resource/1083
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Resource Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Resource Force Delete Endpoint
|
||||
|
||||
The resource force delete endpoint hard deletes an external resource and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/resource/1083
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -17,7 +17,7 @@ For example, the Bakemonogatari anime has MyAnimeList, AniList and AniDB resourc
|
||||
| id | Integer | No | The primary key of the resource |
|
||||
| link | String | Yes | The URL of the external site |
|
||||
| external_id | Integer | Yes | The primary key of the resource in the external site |
|
||||
| site | Enum | Yes | The external site that the resource belongs to {Official Website, Twitter, AniDB, Anilist, Anime-Planet, Anime News Network, Kitsu, MyAnimeList, Wikipedia} |
|
||||
| site | Enum | Yes | The external site that the resource belongs to [Official Website, Twitter, AniDB, Anilist, Anime-Planet, Anime News Network, Kitsu, MyAnimeList, Wikipedia] |
|
||||
| as | String | Yes | Used to distinguish resources that map to the same artist or anime |
|
||||
| created_at | Date | No | The date that the resource was created |
|
||||
| updated_at | Date | No | The date that the resource was last modified |
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Resource Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Resource Index Endpoint
|
||||
|
||||
The resource index endpoint returns a listing of external resources.
|
||||
@@ -53,7 +51,7 @@ None
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status {With, Without, Only} |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
@@ -89,14 +87,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/resource/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Resource Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Resource Show Endpoint
|
||||
|
||||
The resource show endpoint returns an external resource.
|
||||
@@ -46,14 +44,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/resource/1083
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Resource Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Resource Store Endpoint
|
||||
|
||||
The resource store endpoint creates a new external resource and returns the new external resource.
|
||||
@@ -28,7 +26,7 @@ POST /resource
|
||||
| :---------: | :------: | :--------------------------------------------------------------------------------------------------------------------- |
|
||||
| link | Yes | max:192, url, link matches site |
|
||||
| external_id | No | integer, min:0 |
|
||||
| site | Yes | EnumValue {Official Website, Twitter, AniDB, Anilist, Anime-Planet, Anime News Network, Kitsu, MyAnimeList, Wikipedia} |
|
||||
| site | Yes | EnumValue [Official Website, Twitter, AniDB, Anilist, Anime-Planet, Anime News Network, Kitsu, MyAnimeList, Wikipedia] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -47,14 +45,8 @@ POST /resource
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/resource/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Resource Update
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Resource Update Endpoint
|
||||
|
||||
The resource update endpoint updates an external resource and returns the updated external resource.
|
||||
@@ -28,7 +26,7 @@ PUT|PATCH /resource/{id}
|
||||
| :---------: | :------: | :--------------------------------------------------------------------------------------------------------------------- |
|
||||
| link | No | max:192, url, link matches site |
|
||||
| external_id | No | integer, min:0 |
|
||||
| site | No | EnumValue {Official Website, Twitter, AniDB, Anilist, Anime-Planet, Anime News Network, Kitsu, MyAnimeList, Wikipedia} |
|
||||
| site | No | EnumValue [Official Website, Twitter, AniDB, Anilist, Anime-Planet, Anime News Network, Kitsu, MyAnimeList, Wikipedia] |
|
||||
|
||||
## Response
|
||||
|
||||
@@ -47,14 +45,8 @@ PUT|PATCH /resource/{id}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/resource/1083
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Global Search
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Global Search Endpoint
|
||||
|
||||
The global search endpoint returns a listing of wiki resources that match a given search term.
|
||||
@@ -114,14 +112,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/search?q=
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Series Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Series Destroy Endpoint
|
||||
|
||||
The series destroy endpoint soft deletes a series and returns the deleted series resource.
|
||||
@@ -41,14 +39,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/series/monogatari
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -2,8 +2,6 @@
|
||||
title: Series Force Delete
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Series Force Delete Endpoint
|
||||
|
||||
The series force delete endpoint hard deletes a series and returns a confirmation message.
|
||||
@@ -34,14 +32,8 @@ None
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
## Example
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/series/monogatari
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user