a bit of documenting

EvilLord666 · EvilLord666 · commit 4bba009a7bdf · 2023-05-04T13:07:57.000+05:00
diff --git a/WeatherControl/Wissance.WeatherControl.WebApi.V2/Controllers/MeasurementController.cs b/WeatherControl/Wissance.WeatherControl.WebApi.V2/Controllers/MeasurementController.cs
@@ -9,6 +9,14 @@
 
 namespace Wissance.WeatherControl.WebApi.V2.Controllers
 {
+    /// <summary>
+    ///    This controller has ability to recieve all possible query params, but EdgeDbManager could work with 3 of them:
+    ///    * sensor - id of sensor
+    ///    * from - measurements that were captured from specific datetime
+    ///    * to  - measurements that were captured previously to specific date
+    ///  I.e.: parameters usage : http://localhost:8058/api/Measurement?sensor=30ac8366-ea4b-11ed-ab17-e38db76a95f0&to=2023-05-01T12:01:00%2B05:00&from=2023-05-01T11:31:00%2B05:00
+    ///  Note: + MUST BE ENCODED AS %2B
+    /// </summary>
     public class MeasurementController : BasicCrudController<MeasurementDto, MeasurementEntity, Guid>
     {
         public MeasurementController(EdgeDBClient edgeDbClient)

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,14 @@`
`9`	`9`
`10`	`10`	`namespace Wissance.WeatherControl.WebApi.V2.Controllers`
`11`	`11`	`{`
	`12`	`+ /// <summary>`
	`13`	`+ /// This controller has ability to recieve all possible query params, but EdgeDbManager could work with 3 of them:`
	`14`	`+ /// * sensor - id of sensor`
	`15`	`+ /// * from - measurements that were captured from specific datetime`
	`16`	`+ /// * to - measurements that were captured previously to specific date`
	`17`	`+ /// I.e.: parameters usage : http://localhost:8058/api/Measurement?sensor=30ac8366-ea4b-11ed-ab17-e38db76a95f0&to=2023-05-01T12:01:00%2B05:00&from=2023-05-01T11:31:00%2B05:00`
	`18`	`+ /// Note: + MUST BE ENCODED AS %2B`
	`19`	`+ /// </summary>`
`12`	`20`	`public class MeasurementController : BasicCrudController<MeasurementDto, MeasurementEntity, Guid>`
`13`	`21`	`{`
`14`	`22`	`public MeasurementController(EdgeDBClient edgeDbClient)`