Extend openApi specification, do not use boolean fields for string fi…

…elds in osm, add geojson endpoint (v2)
OpenBracketsCH · Apr 16, 2024 · 6b7ac58 · 6b7ac58
1 parent 525f8f8
commit 6b7ac58
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 7 deletions.
diff --git a/backend/DefibrillatorFunction.cs b/backend/DefibrillatorFunction.cs
@@ -15,7 +15,9 @@
 using Microsoft.Azure.WebJobs;
 using Microsoft.Azure.WebJobs.Extensions.Http;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Attributes;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Enums;
 using Microsoft.Extensions.Logging;
+using Microsoft.OpenApi.Models;
 using Newtonsoft.Json;
 using OsmSharp;
 using OsmSharp.IO.API;
@@ -35,7 +37,7 @@ public DefibrillatorFunction(ServiceConfiguration config, ICacheRepository<OsmNo
         }
 
         [FunctionName("Defibrillators_GETALL")]
-        [OpenApiOperation(operationId: "GetDefibrillators_V1")]
+        [OpenApiOperation(operationId: "GetDefibrillators_V1", tags: new[] { "Defibrillator-V1" }, Summary = "Get all defibrillators from switzerland as custom json.")]
         [OpenApiResponseWithBody(statusCode: HttpStatusCode.OK, contentType: "application/json", bodyType: typeof(List<OsmNode>), Description = "The OK response")]
         public async Task<IActionResult> GetAll(
             [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "defibrillator")] HttpRequestMessage req,
@@ -71,9 +73,10 @@ public async Task<IActionResult> GetAll(
 
 
         [FunctionName("Defibrillators_POST")]
-        [OpenApiOperation(operationId: "CreateDefibrillator_V1")]
+        [OpenApiOperation(operationId: "CreateDefibrillator_V1", tags: new[] { "Defibrillator-V1" }, Summary = "Create a new defibrillator. [Soon deprecated, use V2]")]
         [OpenApiRequestBody("application/json", typeof(DefibrillatorRequest))]
         [OpenApiResponseWithBody(statusCode: HttpStatusCode.Created, contentType: "application/json", bodyType: typeof(DefibrillatorResponse), Description = "The OK response")]
+        [OpenApiSecurity("Defikarte.ch API-Key", SecuritySchemeType.ApiKey, In = OpenApiSecurityLocationType.Header, Name = "x-functions-key")]
         public async Task<IActionResult> Create(
             [HttpTrigger(AuthorizationLevel.Function, "Post", Route = "defibrillator")] HttpRequest req,
             ILogger log)

diff --git a/backend/DefibrillatorFunctionV2.cs b/backend/DefibrillatorFunctionV2.cs
@@ -15,7 +15,9 @@
 using Microsoft.Azure.WebJobs;
 using Microsoft.Azure.WebJobs.Extensions.Http;
 using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Attributes;
+using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Enums;
 using Microsoft.Extensions.Logging;
+using Microsoft.OpenApi.Models;
 using Newtonsoft.Json;
 using OsmSharp;
 using OsmSharp.IO.API;
@@ -35,7 +37,7 @@ public DefibrillatorFunctionV2(ServiceConfiguration config, IGeoJsonCacheReposit
         }
 
         [FunctionName("Defibrillators_GETALL_V2")]
-        [OpenApiOperation(operationId: "GetDefibrillators_V2")]
+        [OpenApiOperation(operationId: "GetDefibrillators_V2", tags: new[] { "Defibrillator-V2" }, Summary = "Get all defibrillators from switzerland as geojson.")]
         [OpenApiResponseWithBody(statusCode: HttpStatusCode.OK, contentType: "application/json", bodyType: typeof(FeatureCollection), Description = "The OK response")]
         public async Task<IActionResult> GetAll(
             [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "v2/defibrillator")] HttpRequestMessage req,
@@ -71,9 +73,10 @@ public async Task<IActionResult> GetAll(
 
 
         [FunctionName("Defibrillators_POST_V2")]
-        [OpenApiOperation(operationId: "CreateDefibrillator_V2")]
+        [OpenApiOperation(operationId: "CreateDefibrillator_V2", tags: new[] {"Defibrillator-V2"}, Summary = "Create a new defibrillator.")]
         [OpenApiRequestBody("application/json", typeof(DefibrillatorRequestV2))]
         [OpenApiResponseWithBody(statusCode: HttpStatusCode.Created, contentType: "application/json", bodyType: typeof(DefibrillatorResponse), Description = "The OK response")]
+        [OpenApiSecurity("Defikarte.ch API-Key", SecuritySchemeType.ApiKey, In = OpenApiSecurityLocationType.Header, Name = "x-functions-key")]
         public async Task<IActionResult> Create(
             [HttpTrigger(AuthorizationLevel.Function, "Post", Route = "v2/defibrillator")] HttpRequest req,
             ILogger log)
@@ -169,7 +172,7 @@ private static Node CreateNode(DefibrillatorRequestV2 request)
                     "access", request.Access
                 },
                 {
-                    "indoor", request.Indoor ? "yes" : "no"
+                    "indoor", request.Indoor
                 },
                 {
                     "description", request.Description

diff --git a/backend/Model/DefibrillatorRequestV2.cs b/backend/Model/DefibrillatorRequestV2.cs
@@ -24,7 +24,7 @@ public class DefibrillatorRequestV2
 
         public string EmergencyPhone { get; set; }
 
-        public bool Indoor { get; set; }
+        public string Indoor { get; set; }
 
         public string Source { get; set; }
 

diff --git a/backend/Validation/DefibrillatorRequestValidatorV2.cs b/backend/Validation/DefibrillatorRequestValidatorV2.cs
@@ -16,7 +16,7 @@ public DefibrillatorRequestValidatorV2()
             RuleFor(x => x.Description).MaximumLength(200);
             RuleFor(x => x.OperatorPhone).Custom((value, context) => PhoneNumberValid(value, context)).When(x => !string.IsNullOrEmpty(x.OperatorPhone));
             RuleFor(x => x.Access).Custom((value, context) => AccessValid(value, context));
-            RuleFor(x => x.Indoor).NotNull();
+            RuleFor(x => x.Indoor).NotNull().NotEmpty().Custom((value, context) => IndoorValid(value, context));
             RuleFor(x => x.EmergencyPhone).NotEmpty().Custom((value, context) => PhoneNumberValid(value, context));
             // opening hours validation is missing
         }
@@ -67,5 +67,18 @@ private static void AccessValid(string access, ValidationContext<DefibrillatorRe
                 context.AddFailure(context.PropertyName, "Access not valid");
             }
         }
+
+        private static void IndoorValid(string indoor, ValidationContext<DefibrillatorRequestV2> context)
+        {
+            if (string.IsNullOrEmpty(indoor))
+            {
+                return;
+            }
+
+            if (!(new List<string> { "yes", "no" }).Contains(indoor))
+            {
+                context.AddFailure(context.PropertyName, "Indoor not valid");
+            }
+        }
     }
 }