Closed azharanees closed 5 years ago
IN DEVELOPMENT
scan project endpoint to scan the code using sonarqube scanner.
General components of the application that this PR will affect:
POST CODE
URL
http://localhost:3000/upload/code
Method:
POST
URL Params
No Params
Required:
code field of type file
Optional:
No Optional fields
Data Params
code param of File Type
code
File
Success Response:
[ File is uploaded ]
Sample Call: $ curl -F ‘data=@path/to/local/file’ UPLOAD_ADDRESS
GET USERS
http://localhost:3000/
GET
No Required fields
No Data Params
[ { "_id": "xxxxxxxxxxxxxxx", "title": "Hello, now from the in-memory database!" } ]
Sample Call:
curl http://localhost:3000/
ADD USER
{ "name": "testUser", "email": "test@test.com" }
[ { "message": "New user added." } ]
curl -X POST -H 'Content-Type: application/json' -d '{ "title": "Pizza", "price": 10.5 }' http://localhost:3000/
UPDATE USER
PUT
id=[integer]
{ "name": String, "email": String, "country" : String, }
String
[ { "message": "User updated." } ]
curl -X PUT -H 'Content-Type: application/json' -d '{ "price": 12.5 }' http://localhost:3000/5858754545
DELETE USER
DELETE
Data Params No data params
[ { "message": "User deleted." } ]
curl -X DELETE http://localhost:3000/5654654
API
Status
IN DEVELOPMENT
Description
scan project endpoint to scan the code using sonarqube scanner.
Todo
Impacted Areas in Application
General components of the application that this PR will affect:
Risk Assessment Framework API
POST CODE
URL
http://localhost:3000/upload/code
Method:
POSTURL Params
No Params
Required:
code field of type file
Optional:
No Optional fields
Data Params
codeparam ofFileTypeSuccess Response:
Content:
[ File is uploaded ]Sample Call: $ curl -F ‘data=@path/to/local/file’ UPLOAD_ADDRESS
GET USERS
URL
http://localhost:3000/
Method:
GETURL Params
No Params
Required:
No Required fields
Optional:
No Optional fields
Data Params
No Data Params
Success Response:
Content:
[ { "_id": "xxxxxxxxxxxxxxx", "title": "Hello, now from the in-memory database!" } ]Sample Call:
curl http://localhost:3000/
ADD USER
URL
http://localhost:3000/
Method:
POSTURL Params
No Params
Required:
No Required fields
Optional:
No Optional fields
Data Params
{ "name": "testUser", "email": "test@test.com" }
Success Response:
Content:
[ { "message": "New user added." } ]Sample Call:
curl -X POST -H 'Content-Type: application/json' -d '{ "title": "Pizza", "price": 10.5 }' http://localhost:3000/UPDATE USER
URL
http://localhost:3000/
Method:
PUTURL Params
id=[integer]Required:
id=[integer]Optional:
No Optional fields
Data Params
{ "name":
String, "email":String, "country" :String, }Success Response:
Content:
[ { "message": "User updated." } ]Sample Call:
curl -X PUT -H 'Content-Type: application/json' -d '{ "price": 12.5 }' http://localhost:3000/5858754545DELETE USER
URL
http://localhost:3000/
Method:
DELETEURL Params
id=[integer]Required:
id=[integer]Optional:
No Optional fields
Data Params No data params
Success Response:
Content:
[ { "message": "User deleted." } ]Sample Call:
curl -X DELETE http://localhost:3000/5654654