Docs handler¶
Document File Handler
Module realizes doc file handler.
- class luna_admin.crutches_on_wheels.web.docs_handler.DevelopmentManualHandler(request)[source]¶
Handler for getting sphinx documentations from static directory
- property app: LunaApplication¶
Get application :rtype:
LunaApplication
:returns: running application
- property config¶
Get running application config :returns: running application config
- async get()[source]¶
Get Sphinx service documentation, see get dev manual.
Resource is reached by address ‘/docs/dev’
- class luna_admin.crutches_on_wheels.web.docs_handler.SpecDocumentsHandler(request)[source]¶
Handler for getting openapi documentations from static directory
- property app: LunaApplication¶
Get application :rtype:
LunaApplication
:returns: running application
- property config¶
Get running application config :returns: running application config
- classmethod customise(docName=None)[source]¶
Handler customising method.
- Parameters:
docName (
Optional
[str
]) – document name to store- Returns:
the current handler class
- property docName¶
Current REST API document name getter.
- Returns:
REST API document name except extension
- async get()[source]¶
Get document of services, see get spec docs.
Resource is reached by address ‘/docs/spec’
- Raises:
VLException(Error.UnsupportedMediaType, 415, isCriticalError=False), if "Accept" header is incorrect –
- Return type:
HTTPResponse