summaryrefslogtreecommitdiff
path: root/goodgame/src/docs/unit.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'goodgame/src/docs/unit.yaml')
-rw-r--r--goodgame/src/docs/unit.yaml25
1 files changed, 25 insertions, 0 deletions
diff --git a/goodgame/src/docs/unit.yaml b/goodgame/src/docs/unit.yaml
new file mode 100644
index 0000000..908d0c7
--- /dev/null
+++ b/goodgame/src/docs/unit.yaml
@@ -0,0 +1,25 @@
+paths:
+ /:
+ post:
+ tags:
+ - Units
+ summary: creates a new set of units
+ produces:
+ - application/json
+ parameters:
+ - in: body
+ name: generate units
+ description: It generates a random set of users and saves them to the DB
+ required: false
+ schema:
+ type: "object"
+ properties:
+ amount:
+ type: integer
+ responses:
+ 201:
+ description: An object with the units created
+ 422:
+ description: An object with input errors
+ 400:
+ description: An object with processing errors