Parcourir la source

Create docs for user creation route

Lee Morgan il y a 1 mois
Parent
commit
d77dd8d1ea
3 fichiers modifiés avec 415 ajouts et 0 suppressions
  1. 6 0
      docs/openapi.yaml
  2. 58 0
      docs/paths/user/create.yaml
  3. 351 0
      docs/redoc-static.html

+ 6 - 0
docs/openapi.yaml

@@ -28,3 +28,9 @@ components:
       $ref: "./components/responses/500.yaml"
   securitySchemes:
     $ref: "./components/security.yaml"
+
+paths:
+  #Users
+  /user:
+    post:
+      $ref: "./paths/user/create.yaml"

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

@@ -0,0 +1,58 @@
+operationId: userCreate
+summary: Create
+security: []
+description: New 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 address of new user
+            example: john.smith@mail.com
+          password:
+            type: string
+            description: Password for user
+            example: password123
+          confirm_password:
+            type: string
+            description: Confirmation password
+            example: password123
+          url:
+            type: string
+            format: url
+            description: User validation. Create hidden input, empty by default. Fails if it is anything other than an empty string.
+            example: ""
+          time:
+            type: string
+            format: date
+            description: User validation. Create hidden input and autofill a date on page load. Server checks time from page load.
+            example: 2026-05-24T15:33:03.365Z
+
+responses:
+  "200":
+    description: "New user created (always returns '{success: true}')"
+    content:
+      applicaton/json:
+        schema:
+          type: object
+          properties:
+            success:
+              type: boolean
+  "400":
+    $ref: "#/components/responses/400"
+  "500":
+    $ref: "#/components/responses/500"

Fichier diff supprimé car celui-ci est trop grand
+ 351 - 0
docs/redoc-static.html


Certains fichiers n'ont pas été affichés car il y a eu trop de fichiers modifiés dans ce diff