mirror/checktheroads-hyperglass
1
0
Fork 0
mirror of https://github.com/checktheroads/hyperglass synced 2024-05-11 05:55:08 +00:00
Code Releases Activity

remove params.docs.mode field; fix params.docs.path default value

Browse Source
This commit is contained in:
thatmattlove
2024-04-02 00:08:06 -04:00
parent d78c8da129
commit 7c398fdf4f
1 changed files with 1 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
hyperglass/models/config/docs.py
View File

@@ -37,18 +37,13 @@ class Docs(HyperglassModel):
"""Validation model for params.docs.""" """Validation model for params.docs."""
enable: bool = Field(True, title="Enable", description="Enable or disable API documentation.") enable: bool = Field(True, title="Enable", description="Enable or disable API documentation.")
mode: DocsMode = Field(
"redoc",
title="Docs Mode",
description="OpenAPI UI library to use for the hyperglass API docs. Currently, the options are [Swagger UI](/fixme) and [Redoc](/fixme).",
)
base_url: HttpUrl = Field( base_url: HttpUrl = Field(
"https://lg.example.net", "https://lg.example.net",
title="Base URL", title="Base URL",
description="Base URL used in request samples.", description="Base URL used in request samples.",
) )
path: AnyUri = Field( path: AnyUri = Field(
"/docs", "/api/docs",
title="URI", title="URI",
description="HTTP URI/path where API documentation can be accessed.", description="HTTP URI/path where API documentation can be accessed.",
) )