feat: add code to swagger-v2

wri · Apr 22, 2024 · 8ca2c3f · 8ca2c3f
1 parent b8bd082
commit 8ca2c3f
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 81 deletions.
diff --git a/openapi-src/V2/definitions/RegistrationUsersCreate.yml b/openapi-src/V2/definitions/RegistrationUsersCreate.yml
diff --git a/openapi-src/V2/definitions/RegistrationUsersRead.yml b/openapi-src/V2/definitions/RegistrationUsersRead.yml
diff --git a/resources/docs/swagger-v2.yml b/resources/docs/swagger-v2.yml
@@ -43997,6 +43997,84 @@ definitions:
     properties:
       email_address:
         type: string
+  RoleUserCreate:
+    title: RoleUserCreate
+    type: object
+    properties:
+      first_name:
+        type: string
+      last_name:
+        type: string
+      email_address:
+        type: string
+      password:
+        type: string
+      job_role:
+        type: string
+      facebook:
+        type: string
+      twitter:
+        type: string
+      instagram:
+        type: string
+      linkedin:
+        type: string
+      phone_number:
+        type: string
+      whatsapp_phone:
+        type: string
+      callback_url:
+        type: string
+  RoleUserRead:
+    title: RoleUserRead
+    type: object
+    properties:
+      id:
+        type: integer
+      organisation_id:
+        type: integer
+      organisation_name:
+        type: string
+      my_organisation:
+        $ref: '#/definitions/V2AdminOrganisationRead'
+      my_monitoring_organisations:
+        type: array
+        items:
+          $ref: '#/definitions/V2MonitoringOrganisationRead'
+      first_name:
+        type: string
+      last_name:
+        type: string
+      email_address:
+        type: string
+      email_address_verified_at:
+        type: string
+        format: date-time
+      role:
+        type: string
+      last_logged_in_at:
+        type: string
+        format: date-time
+      job_role:
+        type: string
+      facebook:
+        type: string
+      twitter:
+        type: string
+      instagram:
+        type: string
+      linkedin:
+        type: string
+      avatar:
+        type: string
+      phone_number:
+        type: string
+      whatsapp_phone:
+        type: string
+      has_ppc_projects:
+        type: boolean
+      has_terrafund_projects:
+        type: boolean
 paths:
   '/v2/tree-species/{entity}/{UUID}':
     get:
@@ -93529,6 +93607,7 @@ paths:
         - V2 Sites
         - V2 Nurseries
         - Exports
+        - Roles here
       parameters:
         - type: string
           name: ENTITY
@@ -93544,3 +93623,24 @@ paths:
           description: OK
           schema:
             type: file
+  /users-register:
+    post:
+      summary: Create a user role
+      tags:
+        - Users Roles
+      security: []
+      consumes:
+        - application/json
+      produces:
+        - application/json
+      parameters:
+        - name: Body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/RoleUserCreate'
+      responses:
+        '201':
+          description: Created
+          schema:
+            $ref: '#/definitions/RoleUserRead'  
diff --git a/routes/api.php b/routes/api.php
@@ -126,7 +126,7 @@
     Route::get('/auth/refresh', [AuthController::class, 'refreshAction']);
 
     Route::post('/users', [UsersController::class, 'createAction']);
-    Route::post('/register-user', [UsersRoleController::class, 'createAction']);
+    Route::post('/users-register', [UsersRoleController::class, 'createAction']);
 });
 
 Route::patch('/auth/verify', [AuthController::class, 'verifyAction']);