Update Insomnia UI requests collection export

[e-mobility-charging-stations-simulator.git] / README.md

diff --git a/README.md b/README.md
index 63d48d98eae81e37333574abf1dc07e2438b286b..855e13db05ec966089f4753206419719b27e12a2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -386,6 +386,10 @@ All kind of OCPP parameters are supported in a charging station configuration or
 
 Protocol to control the simulator via a Websocket or HTTP server.
 
+### HTTP Protocol
+
+A Postman and [Insomnia](https://insomnia.rest/) collection, to learn how to use the HTTP protocol to pilot the simulator, is available in [src/assets](./src/assets/) directory.
+
 ### WebSocket Protocol
 
 PDU stands for Protocol Data Unit.
@@ -401,13 +405,13 @@ PDU stands for Protocol Data Unit.
   `uuid`: String uniquely linking the response to the request  
   `PDU`: Response data to requested procedure
 
-### Version 0.0.1
+#### Version 0.0.1
 
 Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 
-#### Procedures
+##### Procedures
 
-##### Start Simulator
+###### Start Simulator
 
 - Request:  
   `ProcedureName`: 'startSimulator'  
@@ -418,7 +422,7 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-##### Stop Simulator
+###### Stop Simulator
 
 - Request:  
   `ProcedureName`: 'stopSimulator'  
@@ -429,7 +433,7 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-##### List Charging Stations
+###### List Charging Stations
 
 - Request:  
   `ProcedureName`: 'listChargingStations'  
@@ -443,7 +447,7 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `index`: ChargingStationData  
   }
 
-##### Start Transaction
+###### Start Transaction
 
 - Request:  
   `ProcedureName`: 'startTransaction'  
@@ -458,7 +462,7 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-##### Stop Transaction
+###### Stop Transaction
 
 - Request:  
   `ProcedureName`: 'stopTransaction'  
@@ -472,12 +476,12 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-##### Start Charging Station
+###### Start Charging Station
 
 - Request:  
   `ProcedureName`: 'startChargingStation'  
   `PDU`: {  
-  `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
+  `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array  
   }
 
 - Response:  
@@ -485,7 +489,7 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-##### Stop Charging Station
+###### Stop Charging Station
 
 - Request:  
   `ProcedureName`: 'stopChargingStation'  
@@ -498,7 +502,7 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-##### Open Connection
+###### Open Connection
 
 - Request:  
   `ProcedureName`: 'openConnection'  
@@ -511,7 +515,7 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-##### Close Connection
+###### Close Connection
 
 - Request:  
   `ProcedureName`: 'closeConnection'  
@@ -524,10 +528,6 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
   `status`  
   }
 
-### HTTP Protocol
-
-A Postman or [Insomnia](https://insomnia.rest/) collection, to learn how to use the HTTP protocol to pilot the simulator, is available.
-
 ## Support, Feedback, Contributing
 
 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/e-mobility-charging-stations-simulator/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).