Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Signorini
Signorini committed Dec 22, 2018
1 parent 96821c7 commit b95f9d6
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/api_data.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/api_data.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ { "type": "get", "url": "/crawler/", "title": "3. Endpoints allowed", "name": "GetCrawler", "group": "Crawler", "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n \"resources\": {\n \"path\": (string)\n }\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawler.py", "groupTitle": "Crawler" }, { "type": "get", "url": "/crawler/<datacenter>", "title": "4. Resources allowed by provider", "name": "GetCrawlerDC", "group": "Crawler", "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n \"resource\": (object) {\n \"<api name>\": (string)\n }\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawlerDcs.py", "groupTitle": "Crawler" }, { "type": "get", "url": "/crawler/<datacenter>/<instance>/<task>", "title": "1. Health check", "name": "GetCrawlerInstance", "group": "Crawler", "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n 'datacenter': <string>,\n 'instance': <string>,\n 'task': <string>\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawlerApp.py", "groupTitle": "Crawler" }, { "type": "put", "url": "/crawler/<datacenter>/<instance>/<task>", "title": "2. Execute crawler", "name": "PostDatacenterCrawler", "group": "Crawler", "description": "<p>Used to run jobs, all jobs execute in workers tasks. All task is process by discovery-worker</p>", "parameter": { "fields": { "Query": [ { "group": "Query", "type": "String", "optional": false, "field": "instance", "description": "<p>Instance ID of connection.</p>" }, { "group": "Query", "type": "String", "optional": false, "field": "task", "description": "<p>Task (server-list, db-list)</p>" }, { "group": "Query", "type": "String", "optional": false, "field": "datacenter", "description": "<p>Datacenter name (AWS, OpenStack)</p>" } ] } }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n[{\n 'name': (string)\n}]", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawlerApp.py", "groupTitle": "Crawler" }, { "type": "get", "url": "/", "title": "Ping", "name": "GetPing", "group": "Ping", "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 201 OK\n{\n app: (String)\n description: (String)\n version: (String)\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/home.py", "groupTitle": "Ping" }]
[ { "type": "get", "url": "/crawler/", "title": "3. Endpoints allowed", "name": "GetCrawler", "group": "Crawler", "permission": [ { "name": "JWT Private (MAESTRO_SECRETJWT_PRIVATE)" } ], "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>JWT {Token}</p>" } ] } }, "error": { "fields": { "Error": [ { "group": "Error", "optional": false, "field": "PermissionError", "description": "<p>Token don`t have permission</p>" }, { "group": "Error", "optional": false, "field": "Unauthorized", "description": "<p>Invalid Token</p>" } ] } }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n \"resources\": {\n \"path\": (string)\n }\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawler.py", "groupTitle": "Crawler" }, { "type": "get", "url": "/crawler/<datacenter>", "title": "4. Resources allowed by provider", "name": "GetCrawlerDC", "group": "Crawler", "permission": [ { "name": "JWT Private (MAESTRO_SECRETJWT_PRIVATE)" } ], "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>JWT {Token}</p>" } ] } }, "error": { "fields": { "Error": [ { "group": "Error", "optional": false, "field": "PermissionError", "description": "<p>Token don`t have permission</p>" }, { "group": "Error", "optional": false, "field": "Unauthorized", "description": "<p>Invalid Token</p>" } ] } }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n \"resource\": (object) {\n \"<api name>\": (string)\n }\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawlerDcs.py", "groupTitle": "Crawler" }, { "type": "get", "url": "/crawler/<datacenter>/<instance>/<task>", "title": "1. Health check", "name": "GetCrawlerInstance", "group": "Crawler", "permission": [ { "name": "JWT Private (MAESTRO_SECRETJWT_PRIVATE)" } ], "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>JWT {Token}</p>" } ] } }, "error": { "fields": { "Error": [ { "group": "Error", "optional": false, "field": "PermissionError", "description": "<p>Token don`t have permission</p>" }, { "group": "Error", "optional": false, "field": "Unauthorized", "description": "<p>Invalid Token</p>" } ] } }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n 'datacenter': <string>,\n 'instance': <string>,\n 'task': <string>\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawlerApp.py", "groupTitle": "Crawler" }, { "type": "put", "url": "/crawler/<datacenter>/<instance>/<task>", "title": "2. Execute crawler", "name": "PostDatacenterCrawler", "group": "Crawler", "description": "<p>Used to run jobs, all jobs execute in workers tasks. All task is process by discovery-worker</p>", "parameter": { "fields": { "Query": [ { "group": "Query", "type": "String", "optional": false, "field": "instance", "description": "<p>Instance ID of connection.</p>" }, { "group": "Query", "type": "String", "optional": false, "field": "task", "description": "<p>Task (server-list, db-list)</p>" }, { "group": "Query", "type": "String", "optional": false, "field": "datacenter", "description": "<p>Datacenter name (AWS, OpenStack)</p>" } ] } }, "permission": [ { "name": "JWT Private (MAESTRO_SECRETJWT_PRIVATE)" } ], "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "<p>JWT {Token}</p>" } ] } }, "error": { "fields": { "Error": [ { "group": "Error", "optional": false, "field": "PermissionError", "description": "<p>Token don`t have permission</p>" }, { "group": "Error", "optional": false, "field": "Unauthorized", "description": "<p>Invalid Token</p>" } ] } }, "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n[{\n 'name': (string)\n}]", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/crawlerApp.py", "groupTitle": "Crawler" }, { "type": "get", "url": "/", "title": "Ping", "name": "GetPing", "group": "Ping", "success": { "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 201 OK\n{\n app: (String)\n description: (String)\n version: (String)\n}", "type": "json" } ] }, "version": "0.0.0", "filename": "app/controller/home.py", "groupTitle": "Ping" }]
Expand Down

0 comments on commit b95f9d6

Please sign in to comment.