From 2e808e318a7b9abd09bf93116dae5368025c3611 Mon Sep 17 00:00:00 2001
From: Kristian Lyngstol <kly@kly.no>
Date: Fri, 4 Mar 2016 18:00:47 +0000
Subject: nms: Split pub/switches in two

Makes authentication simpler.
---
 web/nms.gathering.org/api/API.rst | 49 ++++++++++++++++++++++++---------------
 1 file changed, 30 insertions(+), 19 deletions(-)

(limited to 'web/nms.gathering.org/api/API.rst')

diff --git a/web/nms.gathering.org/api/API.rst b/web/nms.gathering.org/api/API.rst
index b56db64..5876302 100644
--- a/web/nms.gathering.org/api/API.rst
+++ b/web/nms.gathering.org/api/API.rst
@@ -3,10 +3,13 @@ API-dok
 
 Work in progress.
 
+There are two relevant paths: /api/public and /api/private. One requires
+user-login in, the other does not.
+
 General: All end-points that output time-based data accept the "now=<time>"
 argument, where, <time> is YYYY-MM-DDThh:mm:ss. E.g:
 
-GET /switch-state.pl?now=2015-04-02T15:00:00
+GET /api/public/switch-state?now=2015-04-02T15:00:00
 
 There is no guarantee that the data is exact time-wise, thus each endpoint
 should also output relevant time stamps.
@@ -16,40 +19,40 @@ 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.
 
-comment-add.pl
---------------
+/appi/private/comment-add
+-------------------------
 
 Methods: POST
 
  -- Add a comment
 
-comment-change.pl
------------------
+/api/private/comment-change
+---------------------------
 
 Methods: POST
 
 Note that comments are never really deleted, but the state can be set to
 deleted, making sure they are never shown.
 
-comment.pl -- View comments
----------------------------
+/api/private/comments
+---------------------
 
 Methods: GET
 Update frequency: on user input
 
-ping.pl -- Being phased out
----------------------------
+/api/public/ping
+----------------
 
 Methods: GET
 Update frequency: every second or so.
 
-Used to report switch latency and linknet latency.
+Used to report linknet latency.
 
 The switch latency is being integrated into switch-state.pl and linknet
 latency will similarly be moved.
 
-port-state.pl -- Get per-port statistics
-----------------------------------------
+/api/private/port-state
+-----------------------
 
 Methods: GET
 Update frequency: Every few seconds, based on SNMP data.
@@ -59,8 +62,8 @@ Private.
 Returns detailed per-port statistics. Being somewhat reorganized but will
 remain highly relevant.
 
-switches_add.pl -- Add a switch
--------------------------------
+/api/private/switch-add
+-----------------------
 
 Methods: POST
 
@@ -68,18 +71,26 @@ Add switches, supports same format as tools/add_switches.txt.pl
 
 Accepts an array of switches.
 
-switches.pl
------------
+/api/public/switches
+--------------------
 
 Methods: GET
 Update frequency: Infrequent (on topology/config changes)
 
-List all switches and map positions. Output is filtered for public users.
+List all switches and map positions.
 
 Used to draw switches on a map and provide static information.
 
-switch-state.pl -- List state for switches
-------------------------------------------
+/api/public/switches-management
+-------------------------------
+
+Methods: GET
+Update frequency: Infrequent (on topology/config changes)
+
+List management information for switches.
+
+/api/public/switch-state
+------------------------
 
 Methods: GET
 Update frequency: Every second
-- 
cgit v1.2.3