Placeholder for setting query parameter examples

Author: Tsingis

App/Api/Setup/ApiEndpoints.cs

@@ -1,13 +1,16 @@
+using System.Globalization;
 using System.Net;
 using Asp.Versioning;
+using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Models;
 using Services;
 
 namespace Api.Setup;
 
 internal static class ApiEndpoints
 {
-    // private static readonly OpenApiString ExampleFromDate = new(DateTime.Now.AddMonths(-1).ToString("yyyy-MM-dd", CultureInfo.InvariantCulture));
-    // private static readonly OpenApiString ExampleToDate = new(DateTime.Now.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture));
+    private static readonly OpenApiString s_exampleFromDate = new(DateTime.Now.AddMonths(-1).ToString("yyyy-MM-dd", CultureInfo.InvariantCulture));
+    private static readonly OpenApiString s_exampleToDate = new(DateTime.Now.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture));
 
     public static void ConfigureEndpoints(this WebApplication app)
     {
@@ -42,6 +45,12 @@ public static void ConfigureEndpoints(this WebApplication app)
             .Produces((int)HttpStatusCode.BadRequest)
             .ProducesProblem((int)HttpStatusCode.TooManyRequests)
             .ProducesProblem((int)HttpStatusCode.InternalServerError)
+            .WithOpenApi(operation =>
+            {
+                operation.Parameters[0].Example = s_exampleFromDate;
+                operation.Parameters[^1].Example = s_exampleToDate;
+                return operation;
+            })
             .WithDescription("Get longest downward trend in days between given dates");
 
         group.MapGet("/highestradingvolume",
@@ -70,6 +79,12 @@ public static void ConfigureEndpoints(this WebApplication app)
                 .Produces((int)HttpStatusCode.BadRequest)
                 .ProducesProblem((int)HttpStatusCode.TooManyRequests)
                 .ProducesProblem((int)HttpStatusCode.InternalServerError)
+                .WithOpenApi(operation =>
+                {
+                    operation.Parameters[0].Example = s_exampleFromDate;
+                    operation.Parameters[^1].Example = s_exampleToDate;
+                    return operation;
+                })
                 .WithDescription("Get the date with the highest trading volume between given dates");
 
         group.MapGet("/buyandsell",
@@ -98,20 +113,14 @@ public static void ConfigureEndpoints(this WebApplication app)
             .Produces((int)HttpStatusCode.BadRequest)
             .ProducesProblem((int)HttpStatusCode.TooManyRequests)
             .ProducesProblem((int)HttpStatusCode.InternalServerError)
+            .WithOpenApi(operation =>
+            {
+                operation.Parameters[0].Example = s_exampleFromDate;
+                operation.Parameters[^1].Example = s_exampleToDate;
+                return operation;
+            })
             .WithDescription("Get pair of dates when it is best to buy and sell between given dates");
     }
-
-    // private static void ConfigureEndpoint(RouteGroupBuilder group, string route, string description, Delegate handler)
-    // {
-    //     group.MapGet(route, handler)
-    //         .WithDescription(description)
-    //         .WithOpenApi(operation =>
-    //         {
-    //             operation.Parameters[0].Example = ExampleFromDate;
-    //             operation.Parameters[^1].Example = ExampleToDate;
-    //             return operation;
-    //         });
-    // }
 }
 
 public record LongestDownwardTrendResponse(int Days);