@@ -52,44 +52,6 @@ Users are authenticated and validated using JSON web token (JWT).
52
52
By generating a token on login, API endpoints and documents are protected from unauthorized access.
53
53
Requests to protected routes are validated using the generated token.
54
54
55
- ## Endpoints
56
-
57
- ** Users**
58
-
59
- Request type | Endpoint | Action
60
- ------------ | -------- | ------
61
- POST | [ /users] ( #create-user ) | Create a new user
62
- GET | [ /users] ( #get-all-users ) | Get all users
63
- GET | [ /users/: id ] ( #get-user ) | Get details of a specific user
64
- GET | [ /users/login] ( #login ) | To log a user in
65
- GET | [ /users/?limit={integer}&offset={integer}] ( #pagination ) | Pagination for users
66
- GET | [ /search/users/?q={username}] ( #search-user ) | To search for a user
67
- GET | [ /users/: id /documents] ( #user-documents ) | Retrieve all documents created by a user
68
- PUT | [ /users/: id ] ( #edit-user ) | Edit user details
69
- DELETE | [ /users/: id ] ( #delete-user ) | Delete a user from database
70
-
71
- ** Roles**
72
-
73
- Request type | Endpoint | Action
74
- ------------ | -------- | ------
75
- POST | [ /roles] ( #create-role ) | Create a new role
76
- GET | [ /roles] ( #get-all-roles ) | Get all created roles
77
- GET | [ /role/: id ] ( #get-role ) | Get a specific role
78
- PUT | [ /role/: id ] ( #edit-role ) | Edit a specific role
79
- DELETE | [ /role/: id ] ( #delete-role ) | Delete a specific role
80
-
81
- ** Documents**
82
-
83
- Request type | Endpoint | Action
84
- ------------ | -------- | ------
85
- POST | [ /documents] ( #create-document ) | Create a new document
86
- GET | [ /documents] ( #get-all-documents ) | Retrieve all documents
87
- GET | [ /documents/: id ] ( #get-document ) | Retrieve a specific document
88
- GET | [ /documents/?limit={integer}&offset={integer}] ( #pagination ) | Pagination for documents
89
- GET | [ /search/documents/?q={title}] ( #search-document ) | Search documents using key terms
90
- PUT | [ /documents/: id ] ( #edit-document ) | Update a specific document
91
- DELETE | [ /documents/: id ] ( #delete-document ) | Remove a specific document from storage
92
-
93
55
## Development
94
56
Document Management System API is built with the following technologies;
95
57
- EcmaScript6 (ES6)
0 commit comments