app.api.v2 package¶
Subpackages¶
- app.api.v2.handlers namespace
- Submodules
- app.api.v2.handlers.ability_api module
- app.api.v2.handlers.adversary_api module
- app.api.v2.handlers.agent_api module
- app.api.v2.handlers.base_api module
- app.api.v2.handlers.base_object_api module
- app.api.v2.handlers.config_api module
- app.api.v2.handlers.contact_api module
- app.api.v2.handlers.fact_api module
- app.api.v2.handlers.fact_source_api module
- app.api.v2.handlers.health_api module
- app.api.v2.handlers.obfuscator_api module
- app.api.v2.handlers.objective_api module
- app.api.v2.handlers.operation_api module
- app.api.v2.handlers.planner_api module
- app.api.v2.handlers.plugins_api module
- app.api.v2.handlers.schedule_api module
- app.api.v2.managers namespace
- Submodules
- app.api.v2.managers.ability_api_manager module
- app.api.v2.managers.adversary_api_manager module
- app.api.v2.managers.agent_api_manager module
- app.api.v2.managers.base_api_manager module
- app.api.v2.managers.config_api_manager module
- app.api.v2.managers.contact_api_manager module
- app.api.v2.managers.fact_api_manager module
- app.api.v2.managers.operation_api_manager module
- app.api.v2.managers.schedule_api_manager module
- app.api.v2.schemas namespace
Submodules¶
app.api.v2.errors module¶
- exception app.api.v2.errors.DataValidationError(message=None, name=None, value=None)¶
Bases:
Exception
- exception app.api.v2.errors.RequestBodyParseError¶
Bases:
Exception
Base class for HTTP body parsing errors.
- exception app.api.v2.errors.RequestUnparsableJsonError(message=None)¶
Bases:
RequestBodyParseError
Raised when a request body is not parsable (i.e., it is not well-formed json)
- exception app.api.v2.errors.RequestValidationError(message=None, errors=None)¶
Bases:
RequestBodyParseError
Raised when an http request body contains json that is not schema-valid.
app.api.v2.responses module¶
- exception app.api.v2.responses.JsonHttpBadRequest(error, details=None, **kwargs)¶
Bases:
JsonHttpErrorResponse
,HTTPBadRequest
An HTTP 400 response with a json formatted body.
- class app.api.v2.responses.JsonHttpErrorResponse(error, details=None, **kwargs)¶
Bases:
object
Base class for json formatted versions of aiohttp responses.
- exception app.api.v2.responses.JsonHttpForbidden(error, details=None, **kwargs)¶
Bases:
JsonHttpErrorResponse
,HTTPForbidden
An HTTP 403 response with a json formatted body.
- exception app.api.v2.responses.JsonHttpNotFound(error, details=None, **kwargs)¶
Bases:
JsonHttpErrorResponse
,HTTPNotFound
An HTTP 404 response with a json formatted body.
- async app.api.v2.responses.apispec_request_validation_middleware(request, handler)¶
Middleware to handle errors thrown by schema validation
Must be added before validation_middleware
- async app.api.v2.responses.json_request_validation_middleware(request, handler)¶
Middleware that converts json decoding and marshmallow validation errors into 400 responses w/ json bodies.
app.api.v2.security module¶
- app.api.v2.security.authentication_exempt(handler)¶
Mark the endpoint handler as not requiring authentication.
- Note:
This only applies when the authentication_required_middleware is being used.
- app.api.v2.security.authentication_required_middleware_factory(auth_svc)¶
Enforce authentication on every endpoint within an web application.
- Note:
Any endpoint handler can opt-out of authentication using the @authentication_exempt decorator.
- app.api.v2.security.is_handler_authentication_exempt(handler)¶
Return True if the endpoint handler is authentication exempt.