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

add API docs examples

Browse Source
This commit is contained in:
checktheroads
2020-02-03 02:34:50 -07:00
parent 0ca5bc0ff6
commit 7ff8fa317d
16 changed files with 273 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
hyperglass/api/models/response.py
View File

@@ -1,20 +1,20 @@
"""Response model."""
# Standard Library Imports
# Standard Library
from typing import List
# Third Party Imports
from pydantic import BaseModel
from pydantic import StrictBool
from pydantic import StrictStr
from pydantic import constr
# Third Party
from pydantic import BaseModel, StrictStr, StrictBool, constr
# Project
from hyperglass.configuration import params
class QueryError(BaseModel):
"""Query response model."""
output: StrictStr
level: constr(regex=r"(success|warning|error|danger)")
keywords: List[StrictStr]
output: StrictStr = params.messages.general
level: constr(regex=r"(success|warning|error|danger)") = "danger"
keywords: List[StrictStr] = []
class Config:
"""Pydantic model configuration."""
@@ -23,6 +23,23 @@ class QueryError(BaseModel):
description = (
"Response received when there is an error executing the requested query."
)
fields = {
"output": {
"title": "Output",
"description": "Error Details",
"example": "192.0.2.1/32 is not allowed.",
},
"level": {
"title": "Level",
"description": "Error Severity",
"example": "danger",
},
"keywords": {
"title": "Keywords",
"description": "Relevant keyword values contained in the `output` field, which can be used for formatting.",
"example": ["192.0.2.1/32"],
},
}
schema_extra = {
"examples": [
{
@@ -38,7 +55,7 @@ class QueryResponse(BaseModel):
"""Query response model."""
output: StrictStr
level: constr(regex=r"(success|warning|error|danger)")
level: constr(regex=r"success") = "success"
keywords: List[StrictStr] = []
class Config:
@@ -46,66 +63,45 @@ class QueryResponse(BaseModel):
title = "Query Response"
description = "Looking glass response"
fields = {
"level": {"title": "Level", "description": "Severity"},
"keywords": {
"title": "Keywords",
"description": "Relevant keyword values contained in the `output` field, which can be used for formatting.",
"example": ["1.1.1.0/24", "best #1"],
},
"output": {
"title": "Output",
"description": "Looking Glass Response",
"example": """
BGP routing table entry for 1.1.1.0/24, version 224184946
BGP Bestpath: deterministic-med
Paths: (12 available, best #1, table default)
Advertised to update-groups:
1 40
13335, (aggregated by 13335 172.68.129.1), (received & used)
192.0.2.1 (metric 51) from 192.0.2.1 (192.0.2.1)
Origin IGP, metric 0, localpref 250, valid, internal
Community: 65000:1 65000:2
""",
},
}
schema_extra = {
"examples": [
{
"output": """
BGP routing table entry for 1.1.1.0/24, version 224184946
BGP Bestpath: deterministic-med
Paths: (12 available, best #9, table default)
Paths: (12 available, best #1, table default)
Advertised to update-groups:
1 40
13335, (aggregated by 13335 172.68.129.1), (received & used)
199.34.92.5 (metric 51) from 199.34.92.5 (199.34.92.5)
192.0.2.1 (metric 51) from 192.0.2.1 (192.0.2.1)
Origin IGP, metric 0, localpref 250, valid, internal
Community: 14525:1021 14525:2840 14525:3003 14525:4003 14525:5200 14525:5300 14525:5306
13335, (aggregated by 13335 172.68.129.1), (received & used)
199.34.92.6 (metric 51) from 199.34.92.6 (199.34.92.6)
Origin IGP, metric 0, localpref 250, valid, internal
Community: 14525:1021 14525:2840 14525:3003 14525:4003 14525:5200 14525:5300 14525:5306
1299 13335, (aggregated by 13335 162.158.140.1)
62.115.171.124 from 62.115.171.124 (2.255.254.51)
Origin IGP, metric 0, localpref 100, weight 200, valid, external
Community: 14525:0 14525:1021 14525:2840 14525:3001 14525:4001 14525:5100 14525:5103
1299 13335, (aggregated by 13335 162.158.140.1), (received-only)
62.115.171.124 from 62.115.171.124 (2.255.254.51)
Origin IGP, localpref 100, valid, external
Community: 1299:35000
174 13335, (aggregated by 13335 108.162.239.1)
199.34.92.7 (metric 1100) from 199.34.92.7 (199.34.92.7)
Origin IGP, metric 0, localpref 100, weight 125, valid, internal
Community: 14525:0 14525:840 14525:1021 14525:3004 14525:4004 14525:5100 14525:5101
174 13335, (aggregated by 13335 108.162.239.1), (received-only)
199.34.92.7 (metric 1100) from 199.34.92.7 (199.34.92.7)
Origin IGP, metric 0, localpref 100, valid, internal
Community: 14525:0 14525:840 14525:1021 14525:3004 14525:4004 14525:5100 14525:5101
174 13335, (aggregated by 13335 162.158.140.1), (Received from a RR-client)
199.34.92.2 (metric 26) from 199.34.92.2 (199.34.92.2)
Origin IGP, metric 0, localpref 100, weight 200, valid, internal
Community: 14525:0 14525:1021 14525:2840 14525:3001 14525:4001 14525:5100 14525:5101
174 13335, (aggregated by 13335 162.158.140.1), (Received from a RR-client), (received-only)
199.34.92.2 (metric 26) from 199.34.92.2 (199.34.92.2)
Origin IGP, metric 0, localpref 100, valid, internal
Community: 14525:0 14525:1021 14525:2840 14525:3001 14525:4001 14525:5100 14525:5101
174 13335, (aggregated by 13335 162.158.140.1)
38.140.141.25 from 38.140.141.25 (154.26.6.194)
Origin IGP, metric 0, localpref 100, weight 200, valid, external, best
Community: 14525:0 14525:1021 14525:2840 14525:3001 14525:4001 14525:5100 14525:5101
174 13335, (aggregated by 13335 162.158.140.1), (received-only)
38.140.141.25 from 38.140.141.25 (154.26.6.194)
Origin IGP, metric 2020, localpref 100, valid, external
Community: 174:21001 174:22013
3257 13335, (aggregated by 13335 141.101.72.1)
199.34.92.3 (metric 200) from 199.34.92.3 (199.34.92.3)
Origin IGP, metric 0, localpref 100, weight 200, valid, internal
Community: 14525:0 14525:840 14525:1021 14525:3002 14525:4002 14525:5100 14525:5104
3257 13335, (aggregated by 13335 141.101.72.1), (received-only)
199.34.92.3 (metric 200) from 199.34.92.3 (199.34.92.3)
Origin IGP, metric 0, localpref 100, valid, internal
Community: 14525:0 14525:840 14525:1021 14525:3002 14525:4002 14525:5100 14525:5104
Community: 65000:1 65000:2
""",
"level": "success",
"keywords": ["1.1.1.0/24", "best #9"],
"keywords": ["1.1.1.0/24", "best #1"],
}
]
}
@@ -144,7 +140,7 @@ class Network(BaseModel):
schema_extra = {"examples": [{"name": "primary", "display_name": "AS65000"}]}
class Router(BaseModel):
class RoutersResponse(BaseModel):
"""Response model for /api/devices list items."""
name: StrictStr
@@ -169,19 +165,7 @@ class Router(BaseModel):
}
class RoutersResponse(BaseModel):
"""Response model for /api/devices endpoint."""
__root__: List[Router]
class Config:
"""Pydantic model configuration."""
title = "Devices"
description = "List of all devices"
class SupportedQuery(BaseModel):
class SupportedQueryResponse(BaseModel):
"""Response model for /api/queries list items."""
name: StrictStr
@@ -198,15 +182,3 @@ class SupportedQuery(BaseModel):
{"name": "bgp_route", "display_name": "BGP Route", "enable": True}
]
}
class SupportedQueryResponse(BaseModel):
"""Response model for /api/queries endpoint."""
__root__: List[SupportedQuery]
class Config:
"""Pydantic model configuration."""
title = "Supported Query Types"
description = "Enabled query type attributes."