[OpenAPI] Add endpoint for list of deployment models

src/AzureOpenAIProxy.ApiApp/Endpoints/PlaygroundEndpointUrls.cs

@@ -12,4 +12,12 @@ public static class PlaygroundEndpointUrls
     /// - GET method for listing all events
     /// </remarks>
     public const string Events = "/events";
+
+    /// <summary>
+    /// Declares the deployment models list endpoint.
+    /// </summary>
+    /// <remarks>
+    /// - GET method for listing all deployment models
+    /// </remarks>
+    public const string DeploymentModels = "/events/{eventId}/deployment-models";
 }

src/AzureOpenAIProxy.ApiApp/Endpoints/PlaygroundEndpoints.cs

@@ -1,3 +1,5 @@
+using Microsoft.AspNetCore.Mvc;
+
 namespace AzureOpenAIProxy.ApiApp.Endpoints;
 
 /// <summary>
@@ -32,4 +34,36 @@ public static RouteHandlerBuilder AddListEvents(this WebApplication app)
 
         return builder;
     }
+
+
+    /// <summary>
+    /// Adds the get deployment models
+    /// </summary>
+    /// <param name="app"><see cref="WebApplication"/> instance.</param>
+    /// <returns>Returns <see cref="RouteHandlerBuilder"/> instance.</returns>
+    public static RouteHandlerBuilder AddListDeploymentModels(this WebApplication app)
+    {
+        // Todo: Issue #170 https://github.com/aliencube/azure-openai-sdk-proxy/issues/170
+        var builder = app.MapGet(PlaygroundEndpointUrls.DeploymentModels, (
+            [FromRoute] string eventId
+        ) =>
+        {
+            return Results.Ok();
+        })
+        .Produces<List<DeploymentModelDetails>>(statusCode: StatusCodes.Status200OK, contentType: "application/json")
+        .Produces(statusCode: StatusCodes.Status401Unauthorized)
+        .Produces(statusCode: StatusCodes.Status404NotFound)
+        .Produces<string>(statusCode: StatusCodes.Status500InternalServerError, contentType: "text/plain")
+        .WithTags("events")
+        .WithName("GetDeploymentModels")
+        .WithOpenApi(operation =>
+        {
+            operation.Summary = "Gets all deployment models";
+            operation.Description = "This endpoint gets all deployment models avaliable";
+
+            return operation;
+        });
+
+        return builder;
+    }
 }

src/AzureOpenAIProxy.ApiApp/Models/DeploymentModelDetails.cs

@@ -0,0 +1,14 @@
+using System.Text.Json.Serialization;
+
+/// <summary>
+/// This represent the event detail data for response by admin event endpoint.
+/// </summary>
+public class DeploymentModelDetails
+{
+    /// <summary>
+    /// Gets or sets the deployment model name.
+    /// </summary>
+    [JsonRequired]
+    public string Name { get; set; } = string.Empty;
+
+}

src/AzureOpenAIProxy.ApiApp/Program.cs

@@ -54,6 +54,7 @@
 
 // Playground endpoints
 app.AddListEvents();
+app.AddListDeploymentModels();
 
 // Admin endpoints
 app.AddNewAdminEvent();

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

@@ -0,0 +1,239 @@
+using System.Text.Json;
+
+using AzureOpenAIProxy.AppHost.Tests.Fixtures;
+
+using FluentAssertions;
+
+using IdentityModel.Client;
+
+
+namespace AzureOpenAIProxy.AppHost.Tests.ApiApp.Endpoints;
+
+public class GetDeploymentModelsOpenApiTests(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/{eventId}/deployment-models", 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/{eventId}/deployment-models")
+                                             .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/{eventId}/deployment-models")
+                                             .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("description")]
+    [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/{eventId}/deployment-models")
+                                             .GetProperty("get")
+                                             .TryGetProperty(attribute, out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.String);
+    }
+
+
+    [Theory]
+    [InlineData("eventId")]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Path_Parameter(string name)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var openapi = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = openapi!.RootElement.GetProperty("paths")
+                                         .GetProperty("/events/{eventId}/deployment-models")
+                                         .GetProperty("get")
+                                         .GetProperty("parameters")
+                                         .EnumerateArray()
+                                         .Where(p => p.GetProperty("in").GetString() == "path")
+                                         .Select(p => p.GetProperty("name").ToString());
+        result.Should().Contain(name);
+    }
+
+    [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/{eventId}/deployment-models")
+                                             .GetProperty("get")
+                                             .TryGetProperty(attribute, out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+
+    [Theory]
+    [InlineData("200")]
+    [InlineData("401")]
+    [InlineData("404")]
+    [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/{eventId}/deployment-models")
+                                             .GetProperty("get")
+                                             .GetProperty("responses")
+                                             .TryGetProperty(attribute, out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+
+
+    [Fact]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Model()
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var openapi = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = openapi!.RootElement.GetProperty("components")
+                                         .GetProperty("schemas")
+                                         .TryGetProperty("DeploymentModelDetails", out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+
+    public static IEnumerable<object[]> DeploymentModelAttributeData =>
+    [
+        ["name", true, "string"]
+    ];
+
+
+    [Theory]
+    [MemberData(nameof(DeploymentModelAttributeData))]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Required(string attribute, bool isRequired, string type)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        var isReq = isRequired;
+        var typeStr = type;
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var openapi = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = openapi!.RootElement.GetProperty("components")
+                                         .GetProperty("schemas")
+                                         .GetProperty("DeploymentModelDetails")
+                                         .TryGetStringArray("required")
+                                         .ToList();
+        result.Contains(attribute).Should().Be(isRequired);
+    }
+
+    [Theory]
+    [MemberData(nameof(DeploymentModelAttributeData))]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Property(string attribute, bool isRequired, string type)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var openapi = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = openapi!.RootElement.GetProperty("components")
+                                         .GetProperty("schemas")
+                                         .GetProperty("DeploymentModelDetails")
+                                         .GetProperty("properties")
+                                         .TryGetProperty(attribute, out var property) ? property : default;
+        result.ValueKind.Should().Be(JsonValueKind.Object);
+    }
+
+    [Theory]
+    [MemberData(nameof(DeploymentModelAttributeData))]
+    public async Task Given_Resource_When_Invoked_Endpoint_Then_It_Should_Return_Type(string attribute, bool isRequired, string type)
+    {
+        // Arrange
+        using var httpClient = host.App!.CreateHttpClient("apiapp");
+
+        // Act
+        var json = await httpClient.GetStringAsync("/swagger/v1.0.0/swagger.json");
+        var openapi = JsonSerializer.Deserialize<JsonDocument>(json);
+
+        // Assert
+        var result = openapi!.RootElement.GetProperty("components")
+                                         .GetProperty("schemas")
+                                         .GetProperty("DeploymentModelDetails")
+                                         .GetProperty("properties")
+                                         .GetProperty(attribute);
+        result.TryGetString("type").Should().Be(type);
+    }
+}