updated README

cdalton713 · Nov 28, 2020 · 8162ebb · 8162ebb
1 parent 6b81670
commit 8162ebb
Showing 1 changed file with 55 additions and 44 deletions.
diff --git a/api/README.md b/api/README.md
@@ -65,96 +65,107 @@ client handles all routing on https://lsu-it-support-demo.herokuapp.com excludin
 
 # API Routes
 
-## technician
+Check https://lsu-it-support-demo.herokuapp.com/api/docs for schema DTO definitions
 
-```
-POST /api/tech
-```
+## Ticket
 
-```
-GET /api/tech
-```
+Create new user, ticket, and device
 
 ```
-GET /api/tech/{id}
-```
+POST /api/ticket
+req: body: {createCombinedDTO}
+res: body: {CombinedDTO}
 
 ```
-PUT /api/tech/{id}
-```
+
+Get all tickets with user/ticket/device info
 
 ```
-DELETE /api/tech/{id}
+GET /api/ticket
+req: none
+res: body: {CombinedDTO[]}
 ```
 
-## ticket
+Get all opened tickets with user/ticket/device info
 
 ```
-POST /api/ticket
+GET /api/ticket/opened
+req: none
+res: body: {CombinedDTO[]}
 ```
 
+Get all closed tickets with user/ticket/device info
+
 ```
-GET /api/ticket
+GET /api/ticket/closed
+req: none
+res: body: {CombinedDTO[]}
 ```
 
+Get one ticket by ticket_id with user/ticket/device info
+
 ```
-GET /api/ticket/{id}
+GET /api/ticket/{ticket_id}
+req: none
+res: body: {CombineDTO}
 ```
 
+Update ticket
+
 ```
+/* NOT WORKING */
 PUT /api/ticket/{id}
 ```
 
-```
-POST /api/ticket/work
-```
+## User
 
-```
-GET /api/ticket/work
-```
+Create new user
 
 ```
-GET /api/ticket/work/{id}
+POST /api/user
+req: body: {CreateUserDTO}
+res: body: {UserDTO}
 ```
 
-```
-PUT /api/ticket/work/{id}
-```
+Get all users
 
 ```
-DELETE /api/ticket/work/{id}
+GET /api/user
+res: body: {UserDTO[]}
 ```
 
-```
-POST /api/ticket/assign
-```
+Get all users who are admins
 
 ```
-GET /api/ticket/assign
+GET /api/user/admin
+res: body: {UserDTO[]}
 ```
 
-```
-GET /api/ticket/assign/{id}
-```
+Get all users who are not admins
 
 ```
-PUT /api/ticket/assign/{id}
+GET /api/user/student
+res: body: {UserDTO[]}
 ```
 
+Get user by lsu_id
+
 ```
-DELETE /api/ticket/assign/{id}
+GET /api/user/{lsu_id}
+res: body: {UserDTO}
 ```
 
-## Customer
+Update user
 
 ```
-POST /api/customer
+/* NOT WORKING */
+PUT /api/user/{lsu_id}
 ```
 
-```
-GET /api/customer
-```
+## Assign
 
-```
-GET /api/customer/{id}
-```
+TODO
+
+## Work
+
+TODO