m-chrzan.xyz
aboutsummaryrefslogtreecommitdiff
path: root/src/main
diff options
context:
space:
mode:
authorMagdalena Grodzińska <mag.grodzinska@gmail.com>2019-12-25 14:09:00 +0100
committerMagdalena Grodzińska <mag.grodzinska@gmail.com>2019-12-25 14:09:00 +0100
commit063314bab3d9c67e3497e475d46c15783e1c0d97 (patch)
tree198aed2bdea6c2ee4bdbb01a1c48dc84fcfbdfdb /src/main
parent08bd4342ae7ac18b21843a1c61c0023455d94d65 (diff)
Add client api documentation
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/pl/edu/mimuw/cloudatlas/client/ClientController.java25
1 files changed, 15 insertions, 10 deletions
diff --git a/src/main/java/pl/edu/mimuw/cloudatlas/client/ClientController.java b/src/main/java/pl/edu/mimuw/cloudatlas/client/ClientController.java
index db9c09f..120d80d 100644
--- a/src/main/java/pl/edu/mimuw/cloudatlas/client/ClientController.java
+++ b/src/main/java/pl/edu/mimuw/cloudatlas/client/ClientController.java
@@ -13,16 +13,21 @@ import java.rmi.registry.LocateRegistry;
import java.rmi.registry.Registry;
import java.util.*;
-/*
-should enable reading attribute values stored by the agent
-installing and
-uninstalling queries, and
-setting fallback contacts.
-
-Apart from providing forms for queries and fallback contacts,
-and presenting the information fetched from the agent in a textual form (with automatic refreshment),
-plotting the attributes with numeric values as real-time graphs.
-*/
+/**
+ * APIs
+ * /
+ * /query - displays query submission form
+ * /installQuery - posts query installation data
+ * /uninstallQuery - posts query uninstallation data
+ * /contacts - GET - displays contacts submission form
+ * /contacts - POST - posts contacts installation data
+ * /attribs - GET - displays attribute submission form
+ * /attribs - POST - posts attribute submission data
+ * /values - GET - displays attributes values
+ * /values - POST - posts zone change data
+ * /attribNumValues - REST API to get numerical attribute values
+ * /attribAllValues - REST API to get all attribute values
+ */
@Controller
public class ClientController {