diff options
| author | Magnus Kirø <magnuskiro@gmail.com> | 2016-03-23 12:29:11 +0100 |
|---|---|---|
| committer | Magnus Kirø <magnuskiro@gmail.com> | 2016-03-23 12:29:11 +0100 |
| commit | 61ed67ecbdac118b96896901f2815f2fd9c62380 (patch) | |
| tree | 1c029ddf1fa0b7fbbd702d2d842f7e8e261aeab7 | |
| parent | f421bfcac59d211f334842adfc04e41f8a6585ea (diff) | |
| parent | 38d386700282d87fffeec9cbcb7add0eaadae1f1 (diff) | |
Merge pull request #58 from magska/patch-1
Update API.rst: public doc on top.
| -rw-r--r-- | web/nms.gathering.org/api/API.rst | 70 |
1 files changed, 36 insertions, 34 deletions
diff --git a/web/nms.gathering.org/api/API.rst b/web/nms.gathering.org/api/API.rst index 61fbb5a..8fcb657 100644 --- a/web/nms.gathering.org/api/API.rst +++ b/web/nms.gathering.org/api/API.rst @@ -19,6 +19,42 @@ Currently error handling sucks. This document is in no way complete, but it's a start. It will be updated as time permits and API's stabilize. +Public +...... + +Use URL https://nms-public.tg16.gathering.org + +/api/public/ping +---------------- + +Methods: GET +Update frequency: every second or so. + +Used to report linknet latency. + +The switch latency is being integrated into switch-state.pl and linknet +latency will similarly be moved. + +/api/public/switches +-------------------- + +Methods: GET +Update frequency: Infrequent (on topology/config changes) + +List all switches and map positions. + +Used to draw switches on a map and provide static information. + +/api/public/switch-state +------------------------ + +Methods: GET +Update frequency: Every second + +Provides state for each switch, including total port speed, uplink port +speed, latency and temperature. + + Private ....... @@ -77,37 +113,3 @@ Accepts an array of switches. Magic: If you set placement to be "reset", it will re-calculate placement based on sysname. For new switches, this is redundant as an empty placement-field will trigger the same behavior. - - -Public -...... - -/api/public/ping ----------------- - -Methods: GET -Update frequency: every second or so. - -Used to report linknet latency. - -The switch latency is being integrated into switch-state.pl and linknet -latency will similarly be moved. - -/api/public/switches --------------------- - -Methods: GET -Update frequency: Infrequent (on topology/config changes) - -List all switches and map positions. - -Used to draw switches on a map and provide static information. - -/api/public/switch-state ------------------------- - -Methods: GET -Update frequency: Every second - -Provides state for each switch, including total port speed, uplink port -speed, latency and temperature. |