|
| 1 | +/** |
| 2 | + * @api {GET} /api/v1/randomCodes GET: get the random Code files |
| 3 | + * @apiName randomCodes |
| 4 | + * @apiDescription api to get the Random Code files present in code base |
| 5 | + * @apiVersion 1.0.0 |
| 6 | + * |
| 7 | + * @apiGroup randomCodes |
| 8 | + * @apiSuccess (200 Success Response) {Number} status 200 (Status Code) |
| 9 | + * @apiSuccess (200 Success Response) {Object} codeObject1 First CodeObject |
| 10 | + * @apiSuccess (200 Success Response) {Object} codeObject2 Second CodeObject |
| 11 | + * @apiSuccess (200 Success Response) {String} accessToken Access Token for the secured APIs |
| 12 | + * @apiSuccess (CodeObject) {String} codeId unique code Id |
| 13 | + * @apiSuccess (CodeObject) {Number} codeRating current code rating of the file |
| 14 | + * @apiSuccess (CodeObject) {String} codeUrl file URL of the code file |
| 15 | + * @apiSuccess (CodeObject) {String} codeName file name of the code file |
| 16 | + * @apiSuccess (CodeObject) {String} content content of the code file |
| 17 | + * |
| 18 | + * @apiSuccessExample {json} Success Response Example |
| 19 | + * |
| 20 | + * { |
| 21 | + * "status": 200, |
| 22 | + * "codeObject1": { |
| 23 | + * "codeId": "9f6ca40579efdee44097ccf62c93fa192b6efb2b", |
| 24 | + * "codeRating": 45, |
| 25 | + * "codeUrl": "https://api.github.com/repos/<path>/CodeBase/UnixTimeStampToHumanReadableFormat.cpp", |
| 26 | + * "codeName": "UnixTimeStampToHumanReadableFormat.cpp", |
| 27 | + * "content": "#include<bits/stdc++.h>\n\nusing namespace std;\n......." |
| 28 | + * }, |
| 29 | + * "codeObject2": { |
| 30 | + * "codeId": "55dfc162f8163243c9c7e155e9a9a26b9528be73", |
| 31 | + * "codeRating": 2361, |
| 32 | + * "codeUrl": "https://api.github.com/repos/<path>/CodeBase/SelectionSort.java", |
| 33 | + * "codeName": "SelectionSort.java", |
| 34 | + * "content": "public class SelectionSort{public static void main(String[] args){......." |
| 35 | + * }, |
| 36 | + * "accessToken": "96d3371e-9da8-4261-b8a6-ea9b8e68f770" |
| 37 | + * } |
| 38 | + * |
| 39 | + * @apiError (4xx Error Response) {Number} 429 Too many requests, please try again later!!! |
| 40 | + * @apiError (4xx Error Response) {Number} 405 Method not Allowed |
| 41 | + * @apiError (4xx Error Response) {Number} 404 No results found |
| 42 | + * @apiError (4xx Error Response) {Number} 400 Bad Request |
| 43 | + * @apiError (500 Error Response) {Number} 500 Internal Server Error |
| 44 | + **/ |
| 45 | +/** |
| 46 | + * @api {PUT} /api/v1/rateCode PUT: rate the code file |
| 47 | + * @apiName rateCode |
| 48 | + * @apiDescription api to rate the Random Code files present in code base |
| 49 | + * @apiVersion 1.0.0 |
| 50 | + * @apiBody {Number} winner Marked winner 1 or 2 |
| 51 | + * @apiBody {String} codeId1 code Id for code 1 |
| 52 | + * @apiBody {String} codeId2 code Id for code 2 |
| 53 | + * @apiBody {String} codeRatingEngineToken Access token received from randomCodes request |
| 54 | + * |
| 55 | + * @apiGroup rateCode |
| 56 | + * @apiSuccess (200 Success Response) {Object} update1 First UpdatedCodeObject |
| 57 | + * @apiSuccess (200 Success Response) {Object} update2 Second UpdatedCodeObject |
| 58 | + * @apiSuccess (200 Success Response) {Number} status 200 (Status Code) |
| 59 | + * @apiSuccess (200 Success Response) {String} message Code Ratings are updated |
| 60 | + * @apiSuccess (UpdatedCodeObject) {String} codeId unique code Id |
| 61 | + * @apiSuccess (UpdatedCodeObject) {Number} codeRating updated code rating of the file |
| 62 | + * @apiSuccess (UpdatedCodeObject) {String} codeUrl file URL of the code file |
| 63 | + * @apiSuccess (UpdatedCodeObject) {String} codeName file name of the code file |
| 64 | + * @apiSuccess (UpdatedCodeObject) {String} userName user name of the contributed user |
| 65 | + * |
| 66 | + * @apiSuccessExample {json} Success Response Example |
| 67 | + * |
| 68 | + * { |
| 69 | + * "update1": { |
| 70 | + * "codeId": "55dfc162f8163243c9c7e155e9a9a26b9528be73", |
| 71 | + * "codeRating": 2369, |
| 72 | + * "codeUrl": "https://api.github.com/repos/..../CodeBase/SelectionSort.java", |
| 73 | + * "codeName": "SelectionSort.java", |
| 74 | + * "userName": "GauravWalia19", |
| 75 | + * }, |
| 76 | + * "update2": { |
| 77 | + * "codeId": "489e8fe91b2db73cc0f8f78b831fabb1b927d2b5", |
| 78 | + * "codeRating": 2235, |
| 79 | + * "codeUrl": "https://api.github.com/repos/..../CodeBase/LinearSearch.c", |
| 80 | + * "codeName": "LinearSearch.c", |
| 81 | + * "userName": "GauravWalia19", |
| 82 | + * }, |
| 83 | + * "status": 200, |
| 84 | + * "message": "Code Ratings are updated" |
| 85 | + * } |
| 86 | + * |
| 87 | + * @apiError (4xx Error Response) {Number} 429 Too many requests, please try again later!!! |
| 88 | + * @apiError (4xx Error Response) {Number} 405 Method not Allowed |
| 89 | + * @apiError (4xx Error Response) {Number} 401 Invalid Token !! Please send the valid token |
| 90 | + * @apiError (4xx Error Response) {Number} 400 Bad Request |
| 91 | + * @apiError (500 Error Response) {Number} 500 Internal Server Error |
| 92 | + **/ |
| 93 | +/** |
| 94 | + * @api {GET} /api/v1/searchUser GET: searching the user name |
| 95 | + * @apiName searchUser |
| 96 | + * @apiDescription search and return the code rating for the specific user |
| 97 | + * @apiVersion 1.0.0 |
| 98 | + * @apiBody {String} codeRatingEngineToken Access token received from randomCodes request |
| 99 | + * @apiQuery {String} username Username to search |
| 100 | + * @apiQuery {Boolean} sendContent Whether content is needed from the API or not |
| 101 | + * |
| 102 | + * @apiGroup searchUser |
| 103 | + * @apiSuccess (200 Success Response) {Number} status 200 (Status Code) |
| 104 | + * @apiSuccess (200 Success Response) {Array} userCodeBaseFiles CodeBaseFile |
| 105 | + * |
| 106 | + * @apiSuccess (CodeBaseFile) {String} _id unique mongo Id |
| 107 | + * @apiSuccess (CodeBaseFile) {String} codeId unique code Id |
| 108 | + * @apiSuccess (CodeBaseFile) {Number} codeRating current code rating of the file |
| 109 | + * @apiSuccess (CodeBaseFile) {String} codeUrl file URL of the code file |
| 110 | + * @apiSuccess (CodeBaseFile) {String} codeName file name of the code file |
| 111 | + * @apiSuccess (CodeBaseFile) {String} userName user name of the contributed user |
| 112 | + * @apiSuccess (CodeBaseFile) {String} content content of the code file |
| 113 | + * |
| 114 | + * @apiSuccessExample {json} Success Response Example |
| 115 | + * |
| 116 | + * { |
| 117 | + * "status": 200, |
| 118 | + * "userCodeBaseFiles": [ |
| 119 | + * { |
| 120 | + * "_id": "60d877a541d44f4a2350d1b1", |
| 121 | + * "codeId": "55dfc162f8163243c9c7e155e9a9a26b9528be73", |
| 122 | + * "codeRating": 2384, |
| 123 | + * "codeUrl": "https://api.github.com/repos/..../CodeBase/SelectionSort.java?ref=master", |
| 124 | + * "codeName": "SelectionSort.java", |
| 125 | + * "userName": "GauravWalia19", |
| 126 | + * "__v": 0, |
| 127 | + * "content": "Scanner in = new Scanner(System.in)" |
| 128 | + * } |
| 129 | + * ] |
| 130 | + * } |
| 131 | + * |
| 132 | + * @apiError (4xx Error Response) {Number} 429 Too many requests, please try again later!!! |
| 133 | + * @apiError (4xx Error Response) {Number} 405 Method not Allowed |
| 134 | + * @apiError (4xx Error Response) {Number} 404 No Code Base file found for the respective user |
| 135 | + * @apiError (4xx Error Response) {Number} 401 Invalid Token !! Please send the valid token |
| 136 | + * @apiError (4xx Error Response) {Number} 400 Bad Request |
| 137 | + * @apiError (500 Error Response) {Number} 500 Internal Server Error |
| 138 | + **/ |
0 commit comments