Skip to content

Commit 99c9c4e

Browse files
ComputerEliteComputerElite
committed
fix api docs
1 parent fd2f2d4 commit 99c9c4e

2 files changed

Lines changed: 96 additions & 97 deletions

File tree

‎OculusDB/ApiDocs/api_raw.json‎

Lines changed: 95 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -364,39 +364,6 @@
364364
}
365365
],
366366
"endpoints": [
367-
{
368-
"url": "/api/v2/config",
369-
"method": "GET",
370-
"description": "Gets the OculusDB config, needs authorization",
371-
"parameters": [],
372-
"exampleUrl": "/api/v2/admin/config",
373-
"exampleResponse": {}
374-
},
375-
{
376-
"url": "/api/v2/config",
377-
"method": "POST",
378-
"description": "Updates the OculusDB config, needs authorization",
379-
"parameters": [],
380-
"exampleUrl": "/api/v2/admin/config",
381-
"exampleResponse": {}
382-
},
383-
{
384-
"url": "/api/v2/admin/users",
385-
"method": "GET",
386-
"description": "Gets the OculusDB user config, needs authorization",
387-
"parameters": [],
388-
"exampleUrl": "/api/v2/admin/users",
389-
"exampleResponse": {}
390-
},
391-
{
392-
"url": "/api/v2/admin/users",
393-
"method": "POST",
394-
"description": "Updates the OculusDB user config, needs authorization",
395-
"parameters": [],
396-
"exampleUrl": "/api/v2/admin/users",
397-
"exampleResponse": {}
398-
},
399-
400367
{
401368
"url": "/api/v2/blocked/blockedapps",
402369
"method": "GET",
@@ -406,42 +373,6 @@
406373
"exampleResponse": {}
407374
},
408375

409-
{
410-
"url": "/api/v2/blocked/unblockapp",
411-
"method": "DELETE",
412-
"description": "Deletes an app from the blocked list, needs authorization",
413-
"parameters": [],
414-
"exampleUrl": "",
415-
"exampleResponse": {}
416-
},
417-
418-
{
419-
"url": "/api/v2/blocked/blockapp",
420-
"method": "GET",
421-
"description": "Blocks an app, needs authorization",
422-
"parameters": [],
423-
"exampleUrl": "",
424-
"exampleResponse": {}
425-
},
426-
427-
{
428-
"url": "/api/v2/scraping/createnode",
429-
"method": "POST",
430-
"description": "Creates a scraping node, needs authorization",
431-
"parameters": [{
432-
"name": "id",
433-
"description": "Id of the scraping node",
434-
"required": true
435-
},
436-
{
437-
"name": "name",
438-
"description": "Name of the scraping node",
439-
"required": true
440-
}],
441-
"exampleUrl": "",
442-
"exampleResponse": {}
443-
},
444-
445376
{
446377
"url": "/api/v2/scraping/scrape",
447378
"method": "POST",
@@ -468,23 +399,6 @@
468399
"exampleResponse": {}
469400
},
470401

471-
{
472-
"url": "/api/v2/aliases/add",
473-
"method": "POST",
474-
"description": "Adds aliases for versions to OculusDB, needs authorization",
475-
"parameters": [],
476-
"exampleUrl": "",
477-
"exampleResponse": {}
478-
},
479-
{
480-
"url": "/api/v2/login",
481-
"method": "POST",
482-
"description": "Logs you in as admin or user and thus gives you more permissions via the token you get",
483-
"parameters": [],
484-
"exampleUrl": "",
485-
"exampleResponse": {}
486-
},
487-
488402
{
489403
"url": "/api/v2/emergency/checkaccess",
490404
"method": "POST",
@@ -544,16 +458,6 @@
544458
"exampleUrl": "/api/v2/applicationanalytics/2448060205267927",
545459
"exampleResponse": {}
546460
},
547-
{
548-
"url": "/api/v2/wip/explore",
549-
"method": "GET",
550-
"description": "wip",
551-
"parameters": [
552-
553-
],
554-
"exampleUrl": "/api/v2/wip/explore",
555-
"exampleResponse": {}
556-
},
557461
{
558462
"url": "/api/v2/allapps",
559463
"method": "GET",
@@ -795,6 +699,101 @@
795699
"parameters": [],
796700
"exampleUrl": "",
797701
"exampleResponse": {}
702+
},
703+
704+
{
705+
"url": "/api/v2/blocked/unblockapp",
706+
"method": "DELETE",
707+
"description": "Deletes an app from the blocked list, needs authorization",
708+
"parameters": [],
709+
"exampleUrl": "",
710+
"exampleResponse": {}
711+
},
712+
713+
{
714+
"url": "/api/v2/blocked/blockapp",
715+
"method": "POST",
716+
"description": "Blocks an app, needs authorization",
717+
"parameters": [],
718+
"exampleUrl": "",
719+
"exampleResponse": {}
720+
},
721+
722+
{
723+
"url": "/api/v2/scraping/createnode?name=<name>&id=<id>",
724+
"method": "POST",
725+
"description": "Creates a scraping node, needs authorization",
726+
"parameters": [{
727+
"name": "id",
728+
"description": "Id of the scraping node",
729+
"required": true
730+
},
731+
{
732+
"name": "name",
733+
"description": "Name of the scraping node",
734+
"required": true
735+
}],
736+
"exampleUrl": "",
737+
"exampleResponse": {}
738+
},
739+
{
740+
"url": "/api/v2/wip/explore",
741+
"method": "GET",
742+
"description": "wip",
743+
"parameters": [
744+
745+
],
746+
"exampleUrl": "/api/v2/wip/explore",
747+
"exampleResponse": {}
748+
},
749+
750+
{
751+
"url": "/api/v2/aliases/add",
752+
"method": "POST",
753+
"description": "Adds aliases for versions to OculusDB, needs authorization",
754+
"parameters": [],
755+
"exampleUrl": "",
756+
"exampleResponse": {}
757+
},
758+
{
759+
"url": "/api/v2/login",
760+
"method": "POST",
761+
"description": "Logs you in as admin or user and thus gives you more permissions via the token you get",
762+
"parameters": [],
763+
"exampleUrl": "",
764+
"exampleResponse": {}
765+
},
766+
{
767+
"url": "/api/v2/admin/config",
768+
"method": "GET",
769+
"description": "Gets the OculusDB config, needs authorization",
770+
"parameters": [],
771+
"exampleUrl": "/api/v2/admin/config",
772+
"exampleResponse": {}
773+
},
774+
{
775+
"url": "/api/v2/admin/config",
776+
"method": "POST",
777+
"description": "Updates the OculusDB config, needs authorization",
778+
"parameters": [],
779+
"exampleUrl": "/api/v2/admin/config",
780+
"exampleResponse": {}
781+
},
782+
{
783+
"url": "/api/v2/admin/users",
784+
"method": "GET",
785+
"description": "Gets the OculusDB user config, needs authorization",
786+
"parameters": [],
787+
"exampleUrl": "/api/v2/admin/users",
788+
"exampleResponse": {}
789+
},
790+
{
791+
"url": "/api/v2/admin/users",
792+
"method": "POST",
793+
"description": "Updates the OculusDB user config, needs authorization",
794+
"parameters": [],
795+
"exampleUrl": "/api/v2/admin/users",
796+
"exampleResponse": {}
798797
}
799798
]
800799
}

‎OculusDB/frontend/src/Components/APIDocs/APIDocs.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ let APIDocs = () => {
117117
</For>
118118

119119
<h2>Example Request</h2>
120-
<p>{ item.method } { item.url }</p>
120+
<p>{ item.method } { item.exampleUrl }</p>
121121

122122
<div ref={( el ) => responseElementList.push(el)}></div>
123123
</div>

0 commit comments

Comments
 (0)