[meta] FORMAT_VERSION = "0.1.0" HTML_TOP = """ {{NAME}} Reference
Espresso Systems Logo

{{NAME}} API {{FORMAT_VERSION}} Reference

{{DESCRIPTION}}

""" HTML_BOTTOM = """

 

Copyright © 2022 Espresso Systems. All rights reserved.

""" HEADING_ENTRY = "

{{METHOD}} {{NAME}}

\n" HEADING_ROUTES = "

Routes

\n" HEADING_PARAMETERS = "

Parameters

\n" HEADING_DESCRIPTION = "

Description

\n" ROUTE_PATH = "

{{PATH}}

\n" PARAMETER_TABLE_OPEN = "\n" PARAMETER_TABLE_CLOSE = "
\n\n" PARAMETER_ROW = "{{NAME}}{{TYPE}}\n" PARAMETER_NONE = "
None
" # TODO https://github.com/EspressoSystems/tide-disco/issues/52 MINIMAL_HTML = """ {{TITLE}}
Espresso Systems Logo

{{TITLE}}

{{BODY}}

 

Copyright © 2022 Espresso Systems. All rights reserved.

""" [route.help] PATH = ["/help", "/help/:endpoint/tag/:tag"] METHOD = "GET" #"endpoint" = "Literal" ":endpoint" = "Integer" ":tag" = "TaggedBase64" # E.g. LA~SG9tZbo DOC = "Provides complete reference documentation if no endpoint is provided or help on a single endpoint" [route.healthcheck] PATH = ["/healthcheck"] METHOD = "GET" DOC = "Provides server status as JSON such as `{status: Available}`" [route.version] PATH = ["/version"] METHOD = "GET" DOC = "Reports versions as JSON"