AnimeThemes/animethemes-api-docs
1
0 Fork 0
mirror of https://github.com/AnimeThemes/animethemes-api-docs.git synced 2026-11-05 13:54:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

first pass on remaining endpoints

Browse Source
This commit is contained in:
paranarimasu committed 2021-06-29 23:06:37 -05:00
1 parent 272624f7a9
commit 65d1e186aa
43 files changed
+2411 -86
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/anime/README.md
+9 -7
View File
@@ -6,7 +6,9 @@ title: Anime
---
An Anime API Resource represents a production with at least one opening or ending sequence.
An anime API resource represents a production with at least one opening or ending sequence.
For example, Bakemonogatari is an anime production with five opening sequences and one ending sequence.
### Fields
@@ -37,16 +39,16 @@ An Anime API Resource represents a production with at least one opening or endin
**[Anime Show](/anime/show/)**
The Anime Show endpoint returns an Anime Resource.
The anime show endpoint returns an anime resource.
**[Anime Index](/anime/index/)**
The Anime Index endpoint displays a listing of Anime Resources.
The anime index endpoint displays a listing of anime resources.
**Year Show**
**[Year Show](/year/show/)**
The Year Show endpoint
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/)**
The Year Index endpoint
The year index endpoint returns a list of unique years from all anime resources.
docs/anime/index/README.md
+3 -3
View File
@@ -6,7 +6,7 @@ title: Anime Index
# Anime Index Endpoint
The Anime Index endpoint returns a listing of Anime Resources.
The anime index endpoint returns a listing of anime resources.
## URL
@@ -21,7 +21,7 @@ GET /api/anime/
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| sort | No | The list of fields to sort the anime resources |
| sort | No | The list of fields to sort the resources. Ignored if search query is present. |
| q | No | The query to search for matching anime resources |
| page[size] | No | The number of anime resources to display for the current page |
| page[number] | No | The page of anime resources to display |
@@ -62,7 +62,7 @@ Status: 200
synopsis: "synopsis",
created_at: "created_at",
updated_at: "updated_at",
deleted_at: "deleted_at",
deleted_at: "deleted_at"
},
...
],
docs/anime/show/README.md
+4 -2
View File
@@ -6,7 +6,9 @@ title: Anime Show
# Anime Show Endpoint
The Anime Show endpoint returns an Anime Resource.
The anime show endpoint returns an anime resource.
For example, the `/api/anime/bakemonogatari` endpoint will return the Bakemonogatari resource for the Bakemonogatari anime.
## URL
@@ -37,7 +39,7 @@ Status: 200
synopsis: "synopsis",
created_at: "created_at",
updated_at: "updated_at",
deleted_at: "deleted_at",
deleted_at: "deleted_at"
}
}
```