Merge pull request #10 from pulsatrix-emobility/UserAPI-docs

changed WS message format as discussed
pulsatrix-emobility · Nov 30, 2023 · 30ad8dc · 30ad8dc
2 parents cff8e97 + d9b0971
commit 30ad8dc
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/docs/user-api/ws-rest-api/v1-charging.mdx b/docs/user-api/ws-rest-api/v1-charging.mdx
@@ -51,9 +51,10 @@ The `/charging` endpoint provides momentary information about the current chargi
   </TabItem>
   <TabItem value="ws" label="WebSocket">
     ```json title="ws://127.0.0.1:80/api/ws"
-    Topic: charging
-
-    {"voltage":[234.5166016,235.1175079,235.7384491],"amperage":[8.13,8.2,8.09],"allocatedAmperage":16,"commandedAmperage":0,"availableAmperage":18,"signaledAmperage":18,"frequency":49.93060684,"energyImported":0.307999998,"lastActivePower":2036.600098}
+    {
+      "topic": "charging",
+      "message": {"voltage":[234.5166016,235.1175079,235.7384491],"amperage":[8.13,8.2,8.09],"allocatedAmperage":16,"commandedAmperage":0,"availableAmperage":18,"signaledAmperage":18,"frequency":49.93060684,"energyImported":0.307999998,"lastActivePower":2036.600098}
+    }  
     ```
   </TabItem>
 </Tabs>

diff --git a/docs/user-api/ws-rest-api/v1-configuration.mdx b/docs/user-api/ws-rest-api/v1-configuration.mdx
@@ -29,9 +29,10 @@ The `configuration` endpoint is used to get the session specific configuration o
   </TabItem>
   <TabItem value="ws" label="WebSocket">
     ```json title="ws://127.0.0.1:80/api/ws"
-    Topic: configuration
-
-    {"sessionId":"018ba9bc-5ebe-b235-e5fb-dba94e99767e","effectiveAmperageLimit":32}
+    {
+    "topic": "configuration",
+    "message": {"sessionId":"018ba9bc-5ebe-b235-e5fb-dba94e99767e","effectiveAmperageLimit":32}
+    }
     ```
   </TabItem>
 </Tabs>
diff --git a/docs/user-api/ws-rest-api/v1-limits.mdx b/docs/user-api/ws-rest-api/v1-limits.mdx
@@ -44,9 +44,10 @@ situation where the limit set by the API is ignored because it is higher than th
   </TabItem>
   <TabItem value="ws" label="WebSocket">
     ```json title="ws://127.0.0.1:80/api/ws"
-    Topic: limits
-
-    {"enabled": false,"amperageLimit": NaN,"powerLimit": NaN,"timeout": 300000}
+    {
+    "topic": "limits",
+    "message": {"enabled": false,"amperageLimit": NaN,"powerLimit": NaN,"timeout": 300000}
+    }
     ```
   </TabItem>
 </Tabs>

diff --git a/docs/user-api/ws-rest-api/v1-transaction.mdx b/docs/user-api/ws-rest-api/v1-transaction.mdx
@@ -130,9 +130,10 @@ The `transaction` endpoint returns transactional information about the charging
   </TabItem>
   <TabItem value="ws" label="WebSocket">
     ```json title="ws://127.0.0.1:80/api/ws"
-    Topic: transaction
-
-    {"state":"IDLE","startedTime":1699359776,"endedTime":1699359816,"meterStart":0.302999973,"meterStop":0.302999973,"vehicleStatus":"A","chargeControllerStatus":"A1","usedPhasesSession":"111","startReason":"Authorized","stopReason":"DeAuthorized","allocationSourceName":"OCPP Profile"}
+    {
+    "topic": "transaction",
+    "message": {"state":"IDLE","startedTime":1699359776,"endedTime":1699359816,"meterStart":0.302999973,"meterStop":0.302999973,"vehicleStatus":"A","chargeControllerStatus":"A1","usedPhasesSession":"111","startReason":"Authorized","stopReason":"DeAuthorized","allocationSourceName":"OCPP Profile"}
+    }
     ```
   </TabItem>
 </Tabs>