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

improve api docs

Browse Source
This commit is contained in:
checktheroads
2020-01-21 02:38:04 -07:00
parent 52c2489658
commit 94c35faac0
3 changed files with 68 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
hyperglass/configuration/models/docs.py
View File

@@ -1,5 +1,7 @@
"""Configuration for API docs feature."""
# Third Party Imports
from pydantic import StrictBool
from pydantic import StrictStr
from pydantic import constr
# Project Imports
@@ -13,3 +15,6 @@ class Docs(HyperglassModel):
enable: StrictBool = True
mode: constr(regex=r"(swagger|redoc)") = "swagger"
uri: AnyUri = "/docs"
endpoint_summary: StrictStr = "Query Endpoint"
endpoint_description: StrictStr = "Request a query response per-location."
group_title: StrictStr = "Queries"