Skip to content

Commit 65b9adf

Browse files
committed
docs(endpoints): update endpoint list
1 parent f570126 commit 65b9adf

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/docs/Data-Aggregation-API/design.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Design
22

3+
## Swagger
4+
5+
The Swagger UI can be found at `/swagger-ui` url.
6+
37
## Ingestors
48

59
An ingestor is a component responsible for fetching data from a single source of truth. Most of the time it is querying a single endpoint.
@@ -99,8 +103,12 @@ The reports contain:
99103

100104
| Endpoint | Description |
101105
|------------|-----------|
106+
| `/v1/devices/[hostname]/config` | Get config (OpenConfig+IETF) data for a specific device |
107+
| `/v1/devices/*/config` | Get config (OpenConfig+IETF) data for all devices |
102108
| `/v1/devices/[hostname]/openconfig` | Get OpenConfig data for a specific device |
103109
| `/v1/devices/*/openconfig` | Get OpenConfig data for all devices |
110+
| `/v1/devices/[hostname]/ietf` | Get IETF data for a specific device (usage example: SNMP configuration) |
111+
| `/v1/devices/*/ietf` | Get IETF data for all devices (usage example: SNMP configuration) |
104112
| `/v1/devices/[hostname]/afk_enabled` | Indicates if a device has the tag AFK enabled in NetBox |
105113
| `/v1/devices/*/afk_enabled` | Same as above, but for all devices |
106114

0 commit comments

Comments
 (0)