API docs viewer unavailable
The documentation viewer is loaded from a CDN and could not be reached.
This is expected on an offline or air-gapped install.
The specification itself is served locally and needs no network access:
openapi.yaml. Render it with any local viewer,
for example npx @redocly/cli preview-docs openapi.yaml.
""".replace("__SPEC_URL__", SPEC_URL).replace("__BUNDLE_URL__", REDOC_BUNDLE_URL)
def add_api_docs_routes(routes: web.RouteTableDef) -> None:
"""Register the spec and docs-page routes on the given route table.
Registering on PromptServer's route table (rather than on the app directly)
matters twice over: the table is added before the ``web.static('/')``
catch-all that would otherwise shadow these paths, and every route in it is
also re-registered under an ``/api`` prefix.
"""
@routes.get("/openapi.yaml")
async def get_openapi_spec(request):
if not os.path.isfile(SPEC_PATH):
return web.Response(status=404, text="openapi.yaml not found")
response = web.FileResponse(SPEC_PATH)
response.headers["Content-Type"] = "application/yaml"
# The cache_control middleware only special-cases js/css/images, so a
# .yaml response falls through untouched. Without this, a user editing
# the spec would keep getting a stale copy from the browser cache.
response.headers["Cache-Control"] = "no-store, must-revalidate"
return response
@routes.get("/api-docs")
async def get_api_docs(request):
response = web.Response(text=API_DOCS_HTML, content_type="text/html")
response.headers["Cache-Control"] = "no-store, must-revalidate"
return response