aboutsummaryrefslogtreecommitdiff
path: root/umapyoi_net_docs/outfit.rst
diff options
context:
space:
mode:
Diffstat (limited to 'umapyoi_net_docs/outfit.rst')
-rw-r--r--umapyoi_net_docs/outfit.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/umapyoi_net_docs/outfit.rst b/umapyoi_net_docs/outfit.rst
new file mode 100644
index 0000000..6ddac9c
--- /dev/null
+++ b/umapyoi_net_docs/outfit.rst
@@ -0,0 +1,25 @@
+Outfit Endpoints
+================
+
+:ref:`routingtable`
+
+An outfit is otherwise called "Character" on GameTora, but umapyoi.net makes a distinction between characters and their outfits.
+A character might have multiple outfits.
+
+Endpoints
+---------
+.. http:get:: /api/v1/outfit
+
+ Returns all outfit IDs. (Each support card has an id and gametora identifier.)
+
+.. http:get:: /api/v1/outfit/(int:outfit_id)
+
+ Returns outfit data by ID.
+
+.. http:get:: /api/v1/outfit/character/(int:chara_id)
+
+ Returns outfit data belonging to a given character ID (game_id).
+
+.. http:get:: /api/v1/outfit/(int:outfit_id)/gametora
+
+ Redirect to the GameTora page of an outfit.