rapportsystem-backend.API Namespace Reference

Functions
	serve_index ()

Variables
	current_directory = os.getcwd()
	app = Flask(__name__,static_url_path='', static_folder='doc_files')
	supports_credentials
dict	authorizations
	api
	user_post = api.namespace('api/user/post', description='POST Endpoints')
	user_get = api.namespace('api/user/get', description='GET Endpoints')
	admin_post = api.namespace('api/admin/post', description='POST Endpoints')
	admin_get = api.namespace('api/admin/get', description='GET Endpoints')
	leader_post = api.namespace('api/leader/post', description='POST Endpoints')
	leader_get = api.namespace('api/leader/get', description='GET Endpoints')
	operator_post = api.namespace('api/operator/post', description='POST Endpoints')
	operator_get = api.namespace('api/operator/get', description='GET Endpoints')
	host
	debug
	True
	port

Function Documentation

serve_index()

rapportsystem-backend.API.serve_index

(

)

Definition at line 105 of file API.py.

Variable Documentation

admin_get

rapportsystem-backend.API.admin_get = api.namespace('api/admin/get', description='GET Endpoints')

Definition at line 89 of file API.py.

admin_post

rapportsystem-backend.API.admin_post = api.namespace('api/admin/post', description='POST Endpoints')

Definition at line 88 of file API.py.

api

rapportsystem-backend.API.api

Initial value:

=  Api(app,
          version='1.0',
          title='RapportSystem API Doc',
          description='Overview of the API endpoints.\n\nUsage:\n- Log in\n- Go to authorize\n- Type in the *Bearer* space access_token\n- Use the API\n\n<a href="https://bjorgeh.github.io/rapportsystem-backend/doc_files/index.html">Link to API documentation</a>',
          doc='/api/',
          authorizations=authorizations, 
          security='Bearer Auth'
        )

Definition at line 74 of file API.py.

app

rapportsystem-backend.API.app = Flask(__name__,static_url_path='', static_folder='doc_files')

Definition at line 52 of file API.py.

authorizations

dict rapportsystem-backend.API.authorizations

Initial value:

=  {
    'Bearer Auth': {
        'type': 'apiKey',
        'in': 'header',
        'name': 'Authorization',
        'description': 'Type in the *Bearer* space token'
    },
}

Definition at line 64 of file API.py.

current_directory

rapportsystem-backend.API.current_directory = os.getcwd()

Definition at line 10 of file API.py.

debug

rapportsystem-backend.API.debug

Definition at line 210 of file API.py.

host

rapportsystem-backend.API.host

Definition at line 210 of file API.py.

leader_get

rapportsystem-backend.API.leader_get = api.namespace('api/leader/get', description='GET Endpoints')

Definition at line 92 of file API.py.

leader_post

rapportsystem-backend.API.leader_post = api.namespace('api/leader/post', description='POST Endpoints')

Definition at line 91 of file API.py.

operator_get

rapportsystem-backend.API.operator_get = api.namespace('api/operator/get', description='GET Endpoints')

Definition at line 95 of file API.py.

operator_post

rapportsystem-backend.API.operator_post = api.namespace('api/operator/post', description='POST Endpoints')

Definition at line 94 of file API.py.

port

rapportsystem-backend.API.port

Definition at line 210 of file API.py.

supports_credentials

rapportsystem-backend.API.supports_credentials

Definition at line 61 of file API.py.

True

rapportsystem-backend.API.True

Definition at line 210 of file API.py.

user_get

rapportsystem-backend.API.user_get = api.namespace('api/user/get', description='GET Endpoints')

Definition at line 86 of file API.py.

user_post

rapportsystem-backend.API.user_post = api.namespace('api/user/post', description='POST Endpoints')

Definition at line 85 of file API.py.