8.2. Server#
8.2.1. Main server class#
vantage6.server.ServerApp#
8.2.2. Starting the server#
vantage6.server.run_server#
Warning
Note that the run_server function is normally not used directly to
start the server, but is used as utility function in places that start the
server. The recommended way to start a server is using uWSGI as is done in
v6 server start.
vantage6.server.run_dev_server#
8.2.3. Permission management#
vantage6.server.model.rule.Scope#
vantage6.server.model.rule.Operation#
vantage6.server.model.permission.RuleCollection#
vantage6.server.permission.PermissionManager#
8.2.4. Socket functionality#
vantage6.server.websockets.DefaultSocketNamespace#
8.2.5. API endpoints#
Warning
The API endpoints are also documented on the /apidocs endpoint of the
server (e.g. https://cotopaxi.vantage6.ai/apidocs). That documentation
requires a different format than the one used to create this documentation.
We are therefore not including the API documentation here. Instead, we
merely list the supporting functions and classes.
vantage6.server.resource#
vantage6.server.resource.common.output_schema#
vantage6.server.resource.common.auth_helper#
vantage6.server.resource.common.swagger_template#
This module contains the template for the OAS3 documentation of the API.
8.2.6. SQLAlchemy models#
vantage6.server.model.base#
This module contains a few base classes that are used by the other models.