Skip to content

Commit b07bc55

Browse files
Andela DeveloperAndela Developer
Andela Developer
authored and
Andela Developer
committed
refactor swagger
1 parent 25921ec commit b07bc55

File tree

2 files changed

+0
-39
lines changed

2 files changed

+0
-39
lines changed

README.md

-38
Original file line numberDiff line numberDiff line change
@@ -52,44 +52,6 @@ Users are authenticated and validated using JSON web token (JWT).
5252
By generating a token on login, API endpoints and documents are protected from unauthorized access.
5353
Requests to protected routes are validated using the generated token.
5454

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-
9355
## Development
9456
Document Management System API is built with the following technologies;
9557
- EcmaScript6 (ES6)

package.json

-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@
8686
"gulp-exit": "0.0.2",
8787
"gulp-inject-modules": "^1.0.0",
8888
"gulp-istanbul": "^1.1.2",
89-
"gulp-jasmine-node": "^1.0.7",
9089
"gulp-load-plugins": "^1.5.0",
9190
"gulp-mocha": "^4.3.1",
9291
"gulp-nodemon": "^2.2.1",

0 commit comments

Comments
 (0)