Ver Fonte

Create docs for user registration path.

Lee Morgan há 2 meses atrás
pai
commit
dbe6872ad0
2 ficheiros alterados com 403 adições e 0 exclusões
  1. 48 0
      docs/paths/user/create.yaml
  2. 355 0
      docs/redoc-static.html

+ 48 - 0
docs/paths/user/create.yaml

@@ -0,0 +1,48 @@
+operationId: userCreate
+summary: Create
+security: []
+description: User registration
+tags: [User]
+requestBody:
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - name
+          - email
+          - password
+          - confirm_password
+        properties:
+          name:
+            type: string
+            description: Name of new user
+            example: John Smith
+          email:
+            type: string
+            format: email
+            description: Email of new user
+            example: john.smith@mail.com
+          password:
+            type: string
+            description: Password for new user
+            example: johnsmith123
+          confirm_password:
+            type: string
+            description: Confirmation of password
+            example: johnsmith123
+
+responses:
+  "200":
+    description: "New user created (always returns '{success: true}')"
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            success:
+              type: boolean
+  "400":
+    $ref: "#/components/responses/400"
+  "500":
+    $ref: "#/components/responses/500"

Diff do ficheiro suprimidas por serem muito extensas
+ 355 - 0
docs/redoc-static.html


Alguns ficheiros não foram mostrados porque muitos ficheiros mudaram neste diff