Skip to content

Commit be25018

Browse files
pierreTkleinpierreTklein
committed
Fix header name
1 parent 2eeaad2 commit be25018

5 files changed

Lines changed: 147 additions & 147 deletions

File tree

‎docs/api/api_data.js‎

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -666,6 +666,78 @@ define({
666666
"url": "https://api.mchacks.ca/api/auth/password/forgot"
667667
}]
668668
},
669+
{
670+
"type": "get",
671+
"url": "/auth/rolebindings/:id",
672+
"title": "retrieve rolebindings for a user given by their user id :id",
673+
"name": "getRoleBindings",
674+
"group": "Authentication",
675+
"version": "0.0.8",
676+
"parameter": {
677+
"fields": {
678+
"param": [{
679+
"group": "param",
680+
"type": "ObjectId",
681+
"optional": false,
682+
"field": "id",
683+
"description": "<p>MongoId of an account</p>"
684+
}]
685+
}
686+
},
687+
"success": {
688+
"fields": {
689+
"Success 200": [{
690+
"group": "Success 200",
691+
"type": "string",
692+
"optional": false,
693+
"field": "message",
694+
"description": "<p>Success message</p>"
695+
},
696+
{
697+
"group": "Success 200",
698+
"type": "object",
699+
"optional": false,
700+
"field": "data",
701+
"description": "<p>Rolebindings object</p>"
702+
}
703+
]
704+
},
705+
"examples": [{
706+
"title": "Success-Response: ",
707+
"content": "{\n \"message\": \"Successfully retrieved role bindings\",\n \"data\": {\n accountId:\"5beca4ab2e069a34f91697b2\"\n id:\"5beca4ae2e069a34f91698b1\"\n roles: [\n {\n _id:\"5beca4ab2e069a34f91697d9\",\n name:\"hacker\",\n routes: [\n {_id: \"5beca4ae2e069a34f9169852\", requestType: \"POST\", uri: \"/api/auth/login\"},\n {_id: \"5beca4ae2e069a34f9169851\", requestType: \"POST\", uri: \"/api/auth/logout\"},\n {_id: \"5beca4ae2e069a34f9169850\", requestType: \"GET\", uri: \"/api/auth/rolebindings/:self\"},\n {_id: \"5beca4ae2e069a34f916984f\", requestType: \"GET\", uri: \"/api/account/self\"},\n {_id: \"5beca4ae2e069a34f916984e\", requestType: \"GET\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984d\", requestType: \"PATCH\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984c\", requestType: \"POST\", uri: \"/api/hacker/\"},\n {_id: \"5beca4ae2e069a34f916984b\", requestType: \"GET\", uri: \"/api/hacker/:self\"},\n {_id: \"5beca4ae2e069a34f916984a\", requestType: \"GET\", uri: \"/api/hacker/:self/resume\"},\n {_id: \"5beca4ae2e069a34f9169849\", requestType: \"PATCH\", uri: \"/api/hacker/:self\"}\n ]\n }\n ]\n }\n }",
708+
"type": "object"
709+
}]
710+
},
711+
"error": {
712+
"fields": {
713+
"Error 4xx": [{
714+
"group": "Error 4xx",
715+
"type": "string",
716+
"optional": false,
717+
"field": "message",
718+
"description": "<p>Error message</p>"
719+
},
720+
{
721+
"group": "Error 4xx",
722+
"type": "object",
723+
"optional": false,
724+
"field": "data",
725+
"description": "<p>empty</p>"
726+
}
727+
]
728+
},
729+
"examples": [{
730+
"title": "Error-Response: ",
731+
"content": "{\"message\": \"Role Bindings not found\", \"data\": {}}",
732+
"type": "object"
733+
}]
734+
},
735+
"filename": "routes/api/auth.js",
736+
"groupTitle": "Authentication",
737+
"sampleRequest": [{
738+
"url": "https://api.mchacks.ca/api/auth/rolebindings/:id"
739+
}]
740+
},
669741
{
670742
"type": "get",
671743
"url": "/auth/roles",
@@ -966,78 +1038,6 @@ define({
9661038
"url": "https://api.mchacks.ca/api/auth/password/reset"
9671039
}]
9681040
},
969-
{
970-
"type": "get",
971-
"url": "/auth/rolebindings/:id",
972-
"title": "retrieve rolebindings for a user given by their user id :id",
973-
"name": "getRoleBindings",
974-
"group": "Auth",
975-
"version": "0.0.8",
976-
"parameter": {
977-
"fields": {
978-
"param": [{
979-
"group": "param",
980-
"type": "ObjectId",
981-
"optional": false,
982-
"field": "id",
983-
"description": "<p>MongoId of an account</p>"
984-
}]
985-
}
986-
},
987-
"success": {
988-
"fields": {
989-
"Success 200": [{
990-
"group": "Success 200",
991-
"type": "string",
992-
"optional": false,
993-
"field": "message",
994-
"description": "<p>Success message</p>"
995-
},
996-
{
997-
"group": "Success 200",
998-
"type": "object",
999-
"optional": false,
1000-
"field": "data",
1001-
"description": "<p>Rolebindings object</p>"
1002-
}
1003-
]
1004-
},
1005-
"examples": [{
1006-
"title": "Success-Response: ",
1007-
"content": "{\n \"message\": \"Successfully retrieved role bindings\",\n \"data\": {\n accountId:\"5beca4ab2e069a34f91697b2\"\n id:\"5beca4ae2e069a34f91698b1\"\n roles: [\n {\n _id:\"5beca4ab2e069a34f91697d9\",\n name:\"hacker\",\n routes: [\n {_id: \"5beca4ae2e069a34f9169852\", requestType: \"POST\", uri: \"/api/auth/login\"},\n {_id: \"5beca4ae2e069a34f9169851\", requestType: \"POST\", uri: \"/api/auth/logout\"},\n {_id: \"5beca4ae2e069a34f9169850\", requestType: \"GET\", uri: \"/api/auth/rolebindings/:self\"},\n {_id: \"5beca4ae2e069a34f916984f\", requestType: \"GET\", uri: \"/api/account/self\"},\n {_id: \"5beca4ae2e069a34f916984e\", requestType: \"GET\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984d\", requestType: \"PATCH\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984c\", requestType: \"POST\", uri: \"/api/hacker/\"},\n {_id: \"5beca4ae2e069a34f916984b\", requestType: \"GET\", uri: \"/api/hacker/:self\"},\n {_id: \"5beca4ae2e069a34f916984a\", requestType: \"GET\", uri: \"/api/hacker/:self/resume\"},\n {_id: \"5beca4ae2e069a34f9169849\", requestType: \"PATCH\", uri: \"/api/hacker/:self\"}\n ]\n }\n ]\n }\n }",
1008-
"type": "object"
1009-
}]
1010-
},
1011-
"error": {
1012-
"fields": {
1013-
"Error 4xx": [{
1014-
"group": "Error 4xx",
1015-
"type": "string",
1016-
"optional": false,
1017-
"field": "message",
1018-
"description": "<p>Error message</p>"
1019-
},
1020-
{
1021-
"group": "Error 4xx",
1022-
"type": "object",
1023-
"optional": false,
1024-
"field": "data",
1025-
"description": "<p>empty</p>"
1026-
}
1027-
]
1028-
},
1029-
"examples": [{
1030-
"title": "Error-Response: ",
1031-
"content": "{\"message\": \"Role Bindings not found\", \"data\": {}}",
1032-
"type": "object"
1033-
}]
1034-
},
1035-
"filename": "routes/api/auth.js",
1036-
"groupTitle": "Auth",
1037-
"sampleRequest": [{
1038-
"url": "https://api.mchacks.ca/api/auth/rolebindings/:id"
1039-
}]
1040-
},
10411041
{
10421042
"type": "patch",
10431043
"url": "/hacker/checkin/:id",

‎docs/api/api_data.json‎

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -665,6 +665,78 @@
665665
"url": "https://api.mchacks.ca/api/auth/password/forgot"
666666
}]
667667
},
668+
{
669+
"type": "get",
670+
"url": "/auth/rolebindings/:id",
671+
"title": "retrieve rolebindings for a user given by their user id :id",
672+
"name": "getRoleBindings",
673+
"group": "Authentication",
674+
"version": "0.0.8",
675+
"parameter": {
676+
"fields": {
677+
"param": [{
678+
"group": "param",
679+
"type": "ObjectId",
680+
"optional": false,
681+
"field": "id",
682+
"description": "<p>MongoId of an account</p>"
683+
}]
684+
}
685+
},
686+
"success": {
687+
"fields": {
688+
"Success 200": [{
689+
"group": "Success 200",
690+
"type": "string",
691+
"optional": false,
692+
"field": "message",
693+
"description": "<p>Success message</p>"
694+
},
695+
{
696+
"group": "Success 200",
697+
"type": "object",
698+
"optional": false,
699+
"field": "data",
700+
"description": "<p>Rolebindings object</p>"
701+
}
702+
]
703+
},
704+
"examples": [{
705+
"title": "Success-Response: ",
706+
"content": "{\n \"message\": \"Successfully retrieved role bindings\",\n \"data\": {\n accountId:\"5beca4ab2e069a34f91697b2\"\n id:\"5beca4ae2e069a34f91698b1\"\n roles: [\n {\n _id:\"5beca4ab2e069a34f91697d9\",\n name:\"hacker\",\n routes: [\n {_id: \"5beca4ae2e069a34f9169852\", requestType: \"POST\", uri: \"/api/auth/login\"},\n {_id: \"5beca4ae2e069a34f9169851\", requestType: \"POST\", uri: \"/api/auth/logout\"},\n {_id: \"5beca4ae2e069a34f9169850\", requestType: \"GET\", uri: \"/api/auth/rolebindings/:self\"},\n {_id: \"5beca4ae2e069a34f916984f\", requestType: \"GET\", uri: \"/api/account/self\"},\n {_id: \"5beca4ae2e069a34f916984e\", requestType: \"GET\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984d\", requestType: \"PATCH\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984c\", requestType: \"POST\", uri: \"/api/hacker/\"},\n {_id: \"5beca4ae2e069a34f916984b\", requestType: \"GET\", uri: \"/api/hacker/:self\"},\n {_id: \"5beca4ae2e069a34f916984a\", requestType: \"GET\", uri: \"/api/hacker/:self/resume\"},\n {_id: \"5beca4ae2e069a34f9169849\", requestType: \"PATCH\", uri: \"/api/hacker/:self\"}\n ]\n }\n ]\n }\n }",
707+
"type": "object"
708+
}]
709+
},
710+
"error": {
711+
"fields": {
712+
"Error 4xx": [{
713+
"group": "Error 4xx",
714+
"type": "string",
715+
"optional": false,
716+
"field": "message",
717+
"description": "<p>Error message</p>"
718+
},
719+
{
720+
"group": "Error 4xx",
721+
"type": "object",
722+
"optional": false,
723+
"field": "data",
724+
"description": "<p>empty</p>"
725+
}
726+
]
727+
},
728+
"examples": [{
729+
"title": "Error-Response: ",
730+
"content": "{\"message\": \"Role Bindings not found\", \"data\": {}}",
731+
"type": "object"
732+
}]
733+
},
734+
"filename": "routes/api/auth.js",
735+
"groupTitle": "Authentication",
736+
"sampleRequest": [{
737+
"url": "https://api.mchacks.ca/api/auth/rolebindings/:id"
738+
}]
739+
},
668740
{
669741
"type": "get",
670742
"url": "/auth/roles",
@@ -965,78 +1037,6 @@
9651037
"url": "https://api.mchacks.ca/api/auth/password/reset"
9661038
}]
9671039
},
968-
{
969-
"type": "get",
970-
"url": "/auth/rolebindings/:id",
971-
"title": "retrieve rolebindings for a user given by their user id :id",
972-
"name": "getRoleBindings",
973-
"group": "Auth",
974-
"version": "0.0.8",
975-
"parameter": {
976-
"fields": {
977-
"param": [{
978-
"group": "param",
979-
"type": "ObjectId",
980-
"optional": false,
981-
"field": "id",
982-
"description": "<p>MongoId of an account</p>"
983-
}]
984-
}
985-
},
986-
"success": {
987-
"fields": {
988-
"Success 200": [{
989-
"group": "Success 200",
990-
"type": "string",
991-
"optional": false,
992-
"field": "message",
993-
"description": "<p>Success message</p>"
994-
},
995-
{
996-
"group": "Success 200",
997-
"type": "object",
998-
"optional": false,
999-
"field": "data",
1000-
"description": "<p>Rolebindings object</p>"
1001-
}
1002-
]
1003-
},
1004-
"examples": [{
1005-
"title": "Success-Response: ",
1006-
"content": "{\n \"message\": \"Successfully retrieved role bindings\",\n \"data\": {\n accountId:\"5beca4ab2e069a34f91697b2\"\n id:\"5beca4ae2e069a34f91698b1\"\n roles: [\n {\n _id:\"5beca4ab2e069a34f91697d9\",\n name:\"hacker\",\n routes: [\n {_id: \"5beca4ae2e069a34f9169852\", requestType: \"POST\", uri: \"/api/auth/login\"},\n {_id: \"5beca4ae2e069a34f9169851\", requestType: \"POST\", uri: \"/api/auth/logout\"},\n {_id: \"5beca4ae2e069a34f9169850\", requestType: \"GET\", uri: \"/api/auth/rolebindings/:self\"},\n {_id: \"5beca4ae2e069a34f916984f\", requestType: \"GET\", uri: \"/api/account/self\"},\n {_id: \"5beca4ae2e069a34f916984e\", requestType: \"GET\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984d\", requestType: \"PATCH\", uri: \"/api/account/:self\"},\n {_id: \"5beca4ae2e069a34f916984c\", requestType: \"POST\", uri: \"/api/hacker/\"},\n {_id: \"5beca4ae2e069a34f916984b\", requestType: \"GET\", uri: \"/api/hacker/:self\"},\n {_id: \"5beca4ae2e069a34f916984a\", requestType: \"GET\", uri: \"/api/hacker/:self/resume\"},\n {_id: \"5beca4ae2e069a34f9169849\", requestType: \"PATCH\", uri: \"/api/hacker/:self\"}\n ]\n }\n ]\n }\n }",
1007-
"type": "object"
1008-
}]
1009-
},
1010-
"error": {
1011-
"fields": {
1012-
"Error 4xx": [{
1013-
"group": "Error 4xx",
1014-
"type": "string",
1015-
"optional": false,
1016-
"field": "message",
1017-
"description": "<p>Error message</p>"
1018-
},
1019-
{
1020-
"group": "Error 4xx",
1021-
"type": "object",
1022-
"optional": false,
1023-
"field": "data",
1024-
"description": "<p>empty</p>"
1025-
}
1026-
]
1027-
},
1028-
"examples": [{
1029-
"title": "Error-Response: ",
1030-
"content": "{\"message\": \"Role Bindings not found\", \"data\": {}}",
1031-
"type": "object"
1032-
}]
1033-
},
1034-
"filename": "routes/api/auth.js",
1035-
"groupTitle": "Auth",
1036-
"sampleRequest": [{
1037-
"url": "https://api.mchacks.ca/api/auth/rolebindings/:id"
1038-
}]
1039-
},
10401040
{
10411041
"type": "patch",
10421042
"url": "/hacker/checkin/:id",

‎docs/api/api_project.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ define({
99
"apidoc": "0.3.0",
1010
"generator": {
1111
"name": "apidoc",
12-
"time": "2018-12-07T22:15:54.263Z",
12+
"time": "2018-12-07T22:17:55.822Z",
1313
"url": "http://apidocjs.com",
1414
"version": "0.17.6"
1515
}

‎docs/api/api_project.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"apidoc": "0.3.0",
1010
"generator": {
1111
"name": "apidoc",
12-
"time": "2018-12-07T22:15:54.263Z",
12+
"time": "2018-12-07T22:17:55.822Z",
1313
"url": "http://apidocjs.com",
1414
"version": "0.17.6"
1515
}

‎routes/api/auth.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ module.exports = {
202202
/**
203203
* @api {get} /auth/rolebindings/:id retrieve rolebindings for a user given by their user id :id
204204
* @apiName getRoleBindings
205-
* @apiGroup Auth
205+
* @apiGroup Authentication
206206
* @apiVersion 0.0.8
207207
*
208208
* @apiParam (param) {ObjectId} id MongoId of an account

0 commit comments

Comments
 (0)