feat: Add request examples

HawAPI · Aug 9, 2023 · b25df03 · b25df03
1 parent 27d0449
commit b25df03
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 0 deletions.
diff --git a/Examples/Actor-By-Character.md b/Examples/Actor-By-Character.md
@@ -0,0 +1,22 @@
+---
+label: Actor by character
+icon: square
+---
+
+# Actor by character
+
+How to request actor from specific character
+
+## Terminal
+
+### Equals
+
+```sh Terminal
+curl {{url}}/api/{{api_version}}/actors?character=/api/v1/characters/50fa9f0c-65bc-451f-90a2-8b864a21bef0
+```
+
+### Like
+
+```sh Terminal
+curl {{url}}/api/{{api_version}}/actors?character=*50fa9f0c-65bc-451f-90a2-8b864a21bef0
+```
diff --git a/Examples/Episodes-By-Season.md b/Examples/Episodes-By-Season.md
@@ -0,0 +1,22 @@
+---
+label: Episodes by season
+icon: square
+---
+
+# Episodes by season
+
+How to request all episodes from specific season
+
+## Terminal
+
+### Equals
+
+```sh Terminal
+curl {{url}}/api/{{api_version}}/episodes?seasons=/api/v1/seasons/50fa9f0c-65bc-451f-90a2-8b864a21bef0
+```
+
+### Like
+
+```sh Terminal
+curl {{url}}/api/{{api_version}}/episodes?seasons=*50fa9f0c-65bc-451f-90a2-8b864a21bef0
+```
diff --git a/Examples/index.yml b/Examples/index.yml
@@ -0,0 +1,2 @@
+icon: project-roadmap
+order: 2