[OpenAPI] Add endpoint for list of events #179

src/AzureOpenAIProxy.ApiApp/Endpoints/EndpointUrls.cs

@@ -1,4 +1,4 @@
-namespace AzureOpenAIProxy.ApiApp.Endpoints;
+namespace AzureOpenAIProxy.ApiApp.Endpoints;
 
 /// <summary>
 /// This represents the collection of the endpoint URLs.
@@ -14,4 +14,9 @@ public static class EndpointUrls
     /// Declares the chat completions endpoint.
     /// </summary>
     public const string ChatCompletions = "/openai/deployments/{deploymentName}/chat/completions";
-}
+
+    /// <summary>
+    /// Declares the event endpoint.
+    /// </summary>
+    public const string Events = "/events";
+}

src/AzureOpenAIProxy.ApiApp/Endpoints/EventEndpoint.cs

@@ -0,0 +1,39 @@
+using System.Text.Json;
+
+using AzureOpenAIProxy.ApiApp.Models;
+
+namespace AzureOpenAIProxy.ApiApp.Endpoints;
+
+/// <summary>
+/// This represents the endpoint entity for events that the logged user joined.
+/// </summary>
+public static class EventEndpoint
+{
+    /// <summary>
+    /// Adds the event endpoint.
+    /// </summary>
+    /// <param name="app"><see cref="WebApplication"/> instance.</param>
+    /// <returns>Returns <see cref="RouteHandlerBuilder"/> instance.</returns>
+    public static RouteHandlerBuilder AddEventList(this WebApplication app)
+    {
+        var builder = app.MapGet(EndpointUrls.Events, () =>
+        {
+            // TODO: Issue #179 https://github.com/aliencube/azure-openai-sdk-proxy/issues/179
+            return Results.Ok();
+        })
+        .Produces<List<EventDetails>>(statusCode: StatusCodes.Status200OK, contentType: "application/json")
+        .Produces(statusCode: StatusCodes.Status401Unauthorized)
+        .Produces<string>(statusCode: StatusCodes.Status500InternalServerError, contentType: "text/plain")
+        .WithTags("events")
+        .WithName("GetEvents")
+        .WithOpenApi(operation =>
+        {
+            operation.Description = "Gets all events' details that the user joined.";
+            operation.Summary = "This endpoint gets all events' details that the user joined.";
+
+            return operation;
+        });
+
+        return builder;
+    }
+}

src/AzureOpenAIProxy.ApiApp/Extensions/ServiceCollectionExtensions.cs

@@ -1,4 +1,4 @@
-using Azure.Identity;
+using Azure.Identity;
 using Azure.Security.KeyVault.Secrets;
 
 using AzureOpenAIProxy.ApiApp.Builders;
@@ -132,4 +132,4 @@ public static IServiceCollection AddOpenApiService(this IServiceCollection servi
 
         return services;
     }
-}
+}

src/AzureOpenAIProxy.ApiApp/Filters/OpenApiTagFilter.cs

@@ -16,7 +16,8 @@ public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
         [
             new OpenApiTag { Name = "weather", Description = "Weather forecast operations" },
             new OpenApiTag { Name = "openai", Description = "Azure OpenAI operations" },
-            new OpenApiTag { Name = "admin", Description = "Admin for organizing events" }
+            new OpenApiTag { Name = "admin", Description = "Admin for organizing events" },
+            new OpenApiTag { Name = "events", Description = "User events" }
         ];
     }
 }

src/AzureOpenAIProxy.ApiApp/Models/AdminEventDetails.cs

@@ -3,30 +3,15 @@
 /// <summary>
 /// This represent the event detail data for response by admin event endpoint.
 /// </summary>
-public class AdminEventDetails
+public class AdminEventDetails : EventDetails
 {
     /// <summary>
-    /// Gets or sets the event id.
-    /// </summary>
-    public required string? EventId { get; set; }
-
-    /// <summary>
-    /// Gets or sets the event title name.
-    /// </summary>
-    public required string? Title { get; set; }
-
-    /// <summary>
-    /// Gets or sets the event summary.
-    /// </summary>
-    public required string? Summary { get; set; }
-
-    /// <summary>
-    /// Gets or sets the event description. 
+    /// Gets or sets the event description.
     /// </summary>
     public string? Description { get; set; }
 
     /// <summary>
-    /// Gets or sets the event start date. 
+    /// Gets or sets the event start date.
     /// </summary>
     public required DateTimeOffset? DateStart { get; set; }
 
@@ -46,7 +31,7 @@ public class AdminEventDetails
     public required bool? IsActive { get; set; }
 
     /// <summary>
-    /// Gets or sets the event organizer name. 
+    /// Gets or sets the event organizer name.
     /// </summary>
     public required string? OrganizerName { get; set; }
 
@@ -64,14 +49,4 @@ public class AdminEventDetails
     /// Gets or sets the event coorganizer email.
     /// </summary>
     public string? CoorganizerEmail { get; set; }
-
-    /// <summary>
-    /// Gets or sets the Azure OpenAI Service request max token capacity. 
-    /// </summary>
-    public required int? MaxTokenCap { get; set; }
-
-    /// <summary>
-    /// Gets or sets the Azure OpenAI Service daily request capacity.
-    /// </summary>
-    public required int? DailyRequestCap { get; set; }
 }

src/AzureOpenAIProxy.ApiApp/Models/EventDetails.cs

@@ -0,0 +1,35 @@
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
+
+using AzureOpenAIProxy.ApiApp.Models;
+
+/// <summary>
+/// This represents the event's detailed data for response by EventEndpoint.
+/// </summary>
+public class EventDetails
+{
+    /// <summary>
+    /// Gets or sets the event id.
+    /// </summary>
+    public required string? EventId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the event title name.
+    /// </summary>
+    public required string? Title { get; set; }
+
+    /// <summary>
+    /// Gets or sets the event summary.
+    /// </summary>
+    public required string? Summary { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Azure OpenAI Service request max token capacity.
+    /// </summary>
+    public required int? MaxTokenCap { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Azure OpenAI Service daily request capacity.
+    /// </summary>
+    public required int? DailyRequestCap { get; set; }
+}

src/AzureOpenAIProxy.ApiApp/Program.cs

@@ -39,6 +39,9 @@
 app.AddWeatherForecast();
 app.AddChatCompletions();
 
+// Event Endpoints
+app.AddEventList();
+
 // Admin Endpoints
 app.AddAdminEvents();
 app.AddAdminEventList();

test/AzureOpenAIProxy.AppHost.Tests/ApiApp/Endpoints/GetEventsOpenApiTests.cs

@@ -0,0 +1,126 @@
+using System.Text.Json;
+
+using AzureOpenAIProxy.AppHost.Tests.Fixtures;
+
+using FluentAssertions;
+
+using IdentityModel.Client;
+
+namespace AzureOpenAIProxy.AppHost.Tests.ApiApp.Endpoints;
+
+public class GetEventsOpenApiTests(AspireAppHostFixture host) : IClassFixture<AspireAppHostFixture>
+{
+    [Fact]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Path()
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var apiDocument = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = apiDocument!.RootElement.GetProperty("paths")
+                                            .TryGetProperty("/events", out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+
+    [Fact]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Verb()
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var apiDocument = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = apiDocument!.RootElement.GetProperty("paths")
+                                            .GetProperty("/events")
+                                            .TryGetProperty("get", out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+
+    [Theory]
+    [InlineData("events")]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Tags(string tag)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var apiDocument = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = apiDocument!.RootElement.GetProperty("paths")
+                                            .GetProperty("/events")
+                                            .GetProperty("get")
+                                            .TryGetProperty("tags", out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Array);
+        result.EnumerateArray().Select(p => p.GetString()).Should().Contain(tag);
+    }
+
+    [Theory]
+    [InlineData("summary")]
+    [InlineData("operationId")]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Value(string attribute)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var apiDocument = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = apiDocument!.RootElement.GetProperty("paths")
+                                            .GetProperty("/events")
+                                            .GetProperty("get")
+                                            .TryGetProperty(attribute, out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.String);
+    }
+
+    [Theory]
+    [InlineData("responses")]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Object(string attribute)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var apiDocument = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = apiDocument!.RootElement.GetProperty("paths")
+                                            .GetProperty("/events")
+                                            .GetProperty("get")
+                                            .TryGetProperty(attribute, out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+
+    [Theory]
+    [InlineData("200")]
+    [InlineData("401")]
+    [InlineData("500")]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Response(string attribute)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var apiDocument = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = apiDocument!.RootElement.GetProperty("paths")
+                                            .GetProperty("/events")
+                                            .GetProperty("get")
+                                            .GetProperty("responses")
+                                            .TryGetProperty(attribute, out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+}