maestro-server/discovery-api

View on GitHub
app/controller/crawler.py

Summary

Maintainability
A
0 mins
Test Coverage
B
80%

from flask_restful import Resource

from app.services.privateAuth import private_auth


class Crawler(Resource):
    @private_auth
    def get(self):
        """
        @api {get} /crawler/ 3. Endpoints allowed
        @apiName GetCrawler
        @apiGroup Crawler

        @apiPermission JWT Private (MAESTRO_SECRETJWT_PRIVATE)
        @apiHeader (Header) {String} Authorization JWT {Token}

        @apiError (Error) PermissionError Token don`t have permission
        @apiError (Error) Unauthorized Invalid Token

        @apiSuccessExample {json} Success-Response:
        HTTP/1.1 200 OK
        {
            "resources": {
                "path": (string)
            }
        }
        """
        return {
            'resources':
                (
                    {"path": "/crawler/<datacenter>", "description": "List enabled datacenters"},
                    {"path": "/crawler/<datacenter>/<instance>/<task>/<type>",
                     "description": "Execute tasks, <instance> id connections instance, <tasks>: (server-list, dbs-list e etc),  <type>: (full, parcial or single)"}
                )
        }