docs: Add umapyoi.net API documentation

1 files changed, 53 insertions, 0 deletions

diff --git a/umapyoi_net_docs/character.rst b/umapyoi_net_docs/character.rst
new file mode 100644
index 0000000..c0a3fa2
--- /dev/null
+++ b/umapyoi_net_docs/character.rst
@@ -0,0 +1,53 @@
+Character Endpoints
+====================
+
+:ref:`routingtable`
+
+
+Sources
+-------
+English translation of character profiles:
+
+- `GameTora <https://gametora.com/umamusume>`_
+- `Noccu's Translation Project <https://github.com/noccu/umamusu-translate>`_
+
+
+Endpoints
+---------
+.. http:get:: /api/v1/character
+
+    Returns all character IDs.
+
+
+.. http:get:: /api/v1/character/info
+
+    Returns all characters' information.
+
+
+.. http:get:: /api/v1/character/list
+
+    Returns all characters' information needed for the list.
+
+
+.. http:get:: /api/v1/character/(int:chara_id)
+
+    Returns info of a character by ID.
+
+
+.. http:get:: /api/v1/character/images/(int:chara_id)
+
+    Returns a character's images by ID.
+
+
+.. http:get:: /api/v1/character/movies/(int:chara_id)
+
+    Returns a character's movies by ID.
+
+
+.. http:get:: /api/v1/character/context/(int:row_number)
+
+    Returns the row_number of the characters around given row_number.
+
+.. http:get:: /api/v1/character/currentbirthdays
+
+    Returns info about characters who currently have a birthday and the next day a character has a birthday.