0.157.0

HiberGlobal · Jul 10, 2023 · 8f91561 · 8f91561
1 parent 3351633
commit 8f91561
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,20 +1,8 @@
 # Changelog Hiber Rest API
 
-#### Upcoming Changes
+### 0.157 (2023-07-10)
 
-### 0.121 (2022-09-19)
-
-### 0.120 (2022-09-12)
-
-### 0.119 (2022-09-05)
-
-### 0.118 (2022-08-22)
-
-### 0.117 (2022-08-15)
-
-### 0.116 (2022-08-01)
-
-### 0.115 (2022-07-25)
+- Add `/modems` to list modems.
 
 ### 0.114 (2022-07-18)
 

diff --git a/docs/modems.md b/docs/modems.md
@@ -0,0 +1,76 @@
+# /modems
+
+Get the list of modems (/devices).
+
+## Usage
+
+Simply navigate to [rest.api.hiber.cloud/modems](https://rest.api.hiber.cloud/modems).
+Don't forget the auth token as described in the main [readme](../README.md#auth).
+
+### Output format
+
+The output is an object with two fields.
+
+The `modems` field is a json version of the `Modem` object
+[in the grpc API](https://github.com/HiberGlobal/api/blob/master/docs/modem.md#modem),
+though some fields may be omitted for simplicity.
+
+The other field is a `_links` field, as described in [readme](../README.md#hal).
+
+### Example
+
+```
+$ curl -v https://rest.api.hiber.cloud/modems?size=1&page=2 -H "Authorization: Bearer <token>"
+{
+    "modems": [{
+        "organization": "hiber",
+        "number": "ABCD 0123",
+        "name": "ABCD 0123",
+        "identifier": "00 00 00 00 00 00 00 00",
+        "location": {
+            "latitude": 1.2345,
+            "longitude": 1.2345,
+            "textual": "[1.2345,1.2345]"
+        },
+        "healthLevel": {
+            "level": "Warning",
+            "color": "#FFD67A",
+            "colorData": {
+                "fill": "#FFD67A",
+                "markerBackground": "#EDB63C",
+                "markerForeground": "#FFFFFF",
+                "text": "#FFD67A"
+            },
+            "severity": "2"
+        },
+        "notes": "My important device",
+        "tags": [
+            {
+                "id": "3",
+                "label": {
+                    "name": "my group",
+                    "type": "group"
+                }
+            }
+        ]
+    }],
+    "_links": {
+        "self": {
+            "href": "https://rest.api.hiber.cloud/modems?size=1&page=2"
+        },
+        "next": {
+            "href": "https://rest.api.hiber.cloud/modems?size=1&page=3"
+        },
+        "previous": {
+            "href": "https://rest.api.hiber.cloud/modems?size=1&page=1"
+        },
+        "curies": [
+            {
+                "href": "https://rest.api.hiber.cloud/docs/rels/{rel}",
+                "name": "hiber",
+                "templated": true
+            }
+        ]
+    }
+}
+```