mirror of
https://github.com/alice-lg/birdwatcher.git
synced 2025-03-09 00:00:05 +01:00
formatting.
This commit is contained in:
parent
841aa7edf5
commit
582b405011
1 changed files with 64 additions and 64 deletions
128
docs/schema.md
128
docs/schema.md
|
@ -3,83 +3,83 @@ Minimal description of required fields
|
|||
|
||||
# Envelope
|
||||
|
||||
{
|
||||
"api": {
|
||||
"version": "string",
|
||||
"result_from_cache": "boolean",
|
||||
"cache_status": {
|
||||
"cached_at": "datetime",
|
||||
"date": "datetime",
|
||||
{
|
||||
"api": {
|
||||
"version": "string",
|
||||
"result_from_cache": "boolean",
|
||||
"cache_status": {
|
||||
"cached_at": "datetime",
|
||||
"date": "datetime",
|
||||
}
|
||||
}
|
||||
"ttl": "datetime",
|
||||
}
|
||||
"ttl": "datetime",
|
||||
}
|
||||
|
||||
|
||||
# Status
|
||||
{
|
||||
"api": ...,
|
||||
"status": {
|
||||
"current_server": "datetime",
|
||||
"last_reboot": "datetime",
|
||||
"last_reconfig": "datetime",
|
||||
"version": "string",
|
||||
"message": "string",
|
||||
"router_id": "string",
|
||||
{
|
||||
"api": ...,
|
||||
"status": {
|
||||
"current_server": "datetime",
|
||||
"last_reboot": "datetime",
|
||||
"last_reconfig": "datetime",
|
||||
"version": "string",
|
||||
"message": "string",
|
||||
"router_id": "string",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
# Routes
|
||||
|
||||
{
|
||||
"api": ...,
|
||||
"routes": [
|
||||
{
|
||||
"age": "datetime",
|
||||
"bgp": {
|
||||
"as_path": ["int"],
|
||||
"communities": [["int"]],
|
||||
"ext_communities": [["string"]],
|
||||
"large_communities": [["int"]],
|
||||
"local_pref": "int",
|
||||
"med": "int",
|
||||
"origin": "string",
|
||||
"next_hop": "string",
|
||||
},
|
||||
"network": "string",
|
||||
"from_protocol": "string",
|
||||
"interface": "string",
|
||||
"gateway": "string"
|
||||
"metric": "int",
|
||||
"type": ["string"],
|
||||
"primary": "boolean"
|
||||
}
|
||||
]
|
||||
}
|
||||
{
|
||||
"api": ...,
|
||||
"routes": [
|
||||
{
|
||||
"age": "datetime",
|
||||
"bgp": {
|
||||
"as_path": ["int"],
|
||||
"communities": [["int"]],
|
||||
"ext_communities": [["string"]],
|
||||
"large_communities": [["int"]],
|
||||
"local_pref": "int",
|
||||
"med": "int",
|
||||
"origin": "string",
|
||||
"next_hop": "string",
|
||||
},
|
||||
"network": "string",
|
||||
"from_protocol": "string",
|
||||
"interface": "string",
|
||||
"gateway": "string"
|
||||
"metric": "int",
|
||||
"type": ["string"],
|
||||
"primary": "boolean"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
# Protocols / Neighbors
|
||||
|
||||
{
|
||||
"api": ...,
|
||||
"protocols": [
|
||||
{
|
||||
"routes": {
|
||||
"imported": "int",
|
||||
"filtered": "int",
|
||||
"exported": "int",
|
||||
"preferred": "int",
|
||||
},
|
||||
"neighbor_address": string,
|
||||
"neighbor_as": int,
|
||||
"state": "string",
|
||||
"description": "string",
|
||||
"state_changed": "datetime",
|
||||
"uptime": "datetime",
|
||||
"last_error": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
{
|
||||
"api": ...,
|
||||
"protocols": [
|
||||
{
|
||||
"routes": {
|
||||
"imported": "int",
|
||||
"filtered": "int",
|
||||
"exported": "int",
|
||||
"preferred": "int",
|
||||
},
|
||||
"neighbor_address": string,
|
||||
"neighbor_as": int,
|
||||
"state": "string",
|
||||
"description": "string",
|
||||
"state_changed": "datetime",
|
||||
"uptime": "datetime",
|
||||
"last_error": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue