diff options
| author | Kristian Lyngstol <kristian@bohemians.org> | 2016-03-04 19:58:01 +0100 |
|---|---|---|
| committer | Kristian Lyngstol <kristian@bohemians.org> | 2016-03-04 19:58:01 +0100 |
| commit | 6c8b525c2beb2b23daa892b698f0a5e103bddcc7 (patch) | |
| tree | d29bea07df7b9fefddb4ffdd751820148db13fae | |
| parent | b4527d6f786ec856f0346a600db81aaf849bb363 (diff) | |
NMS: Sort api "doc"
No, this isn't even close to finished. Needs documentation on the actual
API and output and whatnot.
| -rw-r--r-- | web/nms.gathering.org/api/API.rst | 57 |
1 files changed, 32 insertions, 25 deletions
diff --git a/web/nms.gathering.org/api/API.rst b/web/nms.gathering.org/api/API.rst index 5876302..4751ee5 100644 --- a/web/nms.gathering.org/api/API.rst +++ b/web/nms.gathering.org/api/API.rst @@ -19,12 +19,15 @@ 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. -/appi/private/comment-add -------------------------- +Private +....... + +/api/private/comment-add +------------------------ Methods: POST - -- Add a comment +Add a comment /api/private/comment-change --------------------------- @@ -38,30 +41,30 @@ deleted, making sure they are never shown. --------------------- Methods: GET -Update frequency: on user input - -/api/public/ping ----------------- -Methods: GET -Update frequency: every second or so. +Update frequency: on user input -Used to report linknet latency. - -The switch latency is being integrated into switch-state.pl and linknet -latency will similarly be moved. +Lists comments. /api/private/port-state ----------------------- Methods: GET -Update frequency: Every few seconds, based on SNMP data. -Private. +Update frequency: Every few seconds, based on SNMP data. Returns detailed per-port statistics. Being somewhat reorganized but will remain highly relevant. +/api/private/switches-management +-------------------------------- + +Methods: GET + +Update frequency: Infrequent (on topology/config changes) + +List management information for switches. + /api/private/switch-add ----------------------- @@ -71,23 +74,29 @@ Add switches, supports same format as tools/add_switches.txt.pl Accepts an array of switches. -/api/public/switches --------------------- +Public +...... + +/api/public/ping +---------------- Methods: GET -Update frequency: Infrequent (on topology/config changes) +Update frequency: every second or so. -List all switches and map positions. +Used to report linknet latency. -Used to draw switches on a map and provide static information. +The switch latency is being integrated into switch-state.pl and linknet +latency will similarly be moved. -/api/public/switches-management -------------------------------- +/api/public/switches +-------------------- Methods: GET Update frequency: Infrequent (on topology/config changes) -List management information for switches. +List all switches and map positions. + +Used to draw switches on a map and provide static information. /api/public/switch-state ------------------------ @@ -97,5 +106,3 @@ Update frequency: Every second Provides state for each switch, including total port speed, uplink port speed, latency and temperature. - -100% public. |