ORB-229: Deprecate AI memory API (part 1, deprecation)

src/Orbit.Api/Controllers/ProfileController.cs

@@ -105,6 +105,7 @@
     }
 
     [HttpPut("ai-memory")]
+    [Obsolete("AI memory is deprecated and will be removed.")]
     [ProducesResponseType(StatusCodes.Status204NoContent)]
     [ProducesResponseType(StatusCodes.Status400BadRequest)]
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]

src/Orbit.Api/Controllers/UserFactsController.cs

@@ -20,6 +20,7 @@
     public record BulkDeleteUserFactsRequest(IReadOnlyList<Guid> FactIds);
 
     [HttpGet]
+    [Obsolete("AI memory is deprecated and will be removed.")]
     [ProducesResponseType(StatusCodes.Status200OK)]
     [ProducesResponseType(StatusCodes.Status400BadRequest)]
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]
@@ -31,6 +32,7 @@
     }
 
     [HttpDelete("{id:guid}")]
+    [Obsolete("AI memory is deprecated and will be removed.")]
     [ProducesResponseType(StatusCodes.Status204NoContent)]
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
@@ -46,6 +48,7 @@
     }
 
     [HttpDelete("bulk")]
+    [Obsolete("AI memory is deprecated and will be removed.")]
     [ProducesResponseType(StatusCodes.Status200OK)]
     [ProducesResponseType(StatusCodes.Status400BadRequest)]
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]

src/Orbit.Api/Extensions/ServiceCollectionExtensions.Infrastructure.cs

@@ -315,7 +315,7 @@
         builder.Services.AddApiVersioning(options =>
             {
                 options.ApiVersionReader = new HeaderApiVersionReader("api-version");
                 options.AssumeDefaultVersionWhenUnspecified = true;
                 options.DefaultApiVersion = new ApiVersion(1, 0);
                 options.ReportApiVersions = true;
                 options.UnsupportedApiVersionStatusCode = StatusCodes.Status400BadRequest;
@@ -323,8 +323,8 @@
             .AddMvc()
             .AddApiExplorer(options => options.GroupNameFormat = "'v'VVV");
 
         builder.Services.AddOpenApi("v1", options => ConfigureOrbitOpenApi(options, "1.0"));
         builder.Services.AddOpenApi("v2", options => ConfigureOrbitOpenApi(options, "2.0"));
     }
 
     private static void ConfigureOrbitOpenApi(Microsoft.AspNetCore.OpenApi.OpenApiOptions options, string version)
@@ -342,6 +342,12 @@
                 operation.Deprecated = true;
             return Task.CompletedTask;
         });
+        options.AddSchemaTransformer((schema, context, _) =>
+        {
+            if (context.JsonPropertyInfo?.AttributeProvider?.IsDefined(typeof(ObsoleteAttribute), false) == true)
+                schema.Deprecated = true;
+            return Task.CompletedTask;
+        });
     }
 
     private static void AddResponseCompression(WebApplicationBuilder builder)

src/Orbit.Api/openapi.json

@@ -11665,7 +11665,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/Profile/ai-summary": {
@@ -15156,7 +15157,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/user-facts/{id}": {
@@ -15226,7 +15228,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/user-facts/bulk": {
@@ -15307,7 +15310,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/Waitlist": {
@@ -18567,7 +18571,8 @@
             ]
           },
           "aiMemoryEnabled": {
-            "type": "boolean"
+            "type": "boolean",
+            "deprecated": true
           },
           "aiSummaryEnabled": {
             "type": "boolean"

src/Orbit.Api/openapi_v2.json

@@ -11818,7 +11818,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/Profile/ai-summary": {
@@ -15354,7 +15355,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/user-facts/{id}": {
@@ -15425,7 +15427,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/user-facts/bulk": {
@@ -15507,7 +15510,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/api/Waitlist": {
@@ -18768,7 +18772,8 @@
             ]
           },
           "aiMemoryEnabled": {
-            "type": "boolean"
+            "type": "boolean",
+            "deprecated": true
           },
           "aiSummaryEnabled": {
             "type": "boolean"

src/Orbit.Application/Profile/Queries/GetProfileQuery.cs

@@ -16,6 +16,7 @@
     string Name,
     string Email,
     string? TimeZone,
+    [property: Obsolete("AI memory is deprecated and will be removed.")]
     bool AiMemoryEnabled,
     bool AiSummaryEnabled,
     bool HasCompletedOnboarding,

tests/Orbit.Infrastructure.Tests/Controllers/AiMemoryDeprecationTests.cs

@@ -0,0 +1,67 @@
+using System.Reflection;
+using System.Text.Json;
+using FluentAssertions;
+using Microsoft.AspNetCore.Mvc.Routing;
+using Orbit.Api.Controllers;
+
+namespace Orbit.Infrastructure.Tests.Controllers;
+
+public class AiMemoryDeprecationTests
+{
+    [Theory]
+    [InlineData(typeof(UserFactsController), "GetUserFacts", null, "GET")]
+    [InlineData(typeof(UserFactsController), "DeleteUserFact", "{id:guid}", "DELETE")]
+    [InlineData(typeof(UserFactsController), "BulkDeleteUserFacts", "bulk", "DELETE")]
+    [InlineData(typeof(ProfileController), "SetAiMemory", "ai-memory", "PUT")]
+    public void RouteRemainsAvailableAndDeprecated(Type controller, string action, string? template, string verb)
+    {
+        var method = controller.GetMethod(action);
+
+        method.Should().NotBeNull();
+        var route = method!.GetCustomAttributes<HttpMethodAttribute>().Should().ContainSingle().Subject;
+        route.Template.Should().Be(template);
+        route.HttpMethods.Should().ContainSingle().Which.Should().Be(verb);
+        method.GetCustomAttributes<ObsoleteAttribute>().Should().ContainSingle();
+    }
+
+    [Theory]
+    [InlineData("openapi.json", "/api/user-facts", "get")]
+    [InlineData("openapi.json", "/api/user-facts/{id}", "delete")]
+    [InlineData("openapi.json", "/api/user-facts/bulk", "delete")]
+    [InlineData("openapi.json", "/api/Profile/ai-memory", "put")]
+    [InlineData("openapi_v2.json", "/api/user-facts", "get")]
+    [InlineData("openapi_v2.json", "/api/user-facts/{id}", "delete")]
+    [InlineData("openapi_v2.json", "/api/user-facts/bulk", "delete")]
+    [InlineData("openapi_v2.json", "/api/Profile/ai-memory", "put")]
+    public void GeneratedOpenApiMarksRouteDeprecated(string file, string route, string verb)
+    {
+        using var document = ReadOpenApi(file);
+        var operation = document.RootElement.GetProperty("paths").GetProperty(route).GetProperty(verb);
+
+        operation.TryGetProperty("deprecated", out var deprecated).Should().BeTrue();
+        deprecated.GetBoolean().Should().BeTrue();
+    }
+
+    [Theory]
+    [InlineData("openapi.json")]
+    [InlineData("openapi_v2.json")]
+    public void GeneratedOpenApiKeepsMemorySettingRequiredAndMarksItDeprecated(string file)
+    {
+        using var document = ReadOpenApi(file);
+        var profile = document.RootElement.GetProperty("components").GetProperty("schemas").GetProperty("ProfileResponse");
+        var setting = profile.GetProperty("properties").GetProperty("aiMemoryEnabled");
+
+        profile.GetProperty("required").EnumerateArray().Select(value => value.GetString())
+            .Should().Contain("aiMemoryEnabled");
+        setting.GetProperty("type").GetString().Should().Be("boolean");
+        setting.TryGetProperty("deprecated", out var deprecated).Should().BeTrue();
+        deprecated.GetBoolean().Should().BeTrue();
+    }
+
+    private static JsonDocument ReadOpenApi(string file)
+    {
+        var path = Path.GetFullPath(Path.Combine(AppContext.BaseDirectory,
+            "../../../../..", "src/Orbit.Api", file));
+        return JsonDocument.Parse(File.ReadAllText(path));
+    }
+}

tests/Orbit.Infrastructure.Tests/Controllers/ProfileControllerTests.cs

@@ -97,6 +97,7 @@ public async Task SetTimezone_Failure_ReturnsBadRequest()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated PUT /api/Profile/ai-memory route.")]
     public async Task SetAiMemory_Success_ReturnsNoContent()
     {
         _mediator.Send(Arg.Any<SetAiMemoryCommand>(), Arg.Any<CancellationToken>())
@@ -109,6 +110,7 @@ public async Task SetAiMemory_Success_ReturnsNoContent()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated PUT /api/Profile/ai-memory route.")]
     public async Task SetAiMemory_Failure_ReturnsBadRequest()
     {
         _mediator.Send(Arg.Any<SetAiMemoryCommand>(), Arg.Any<CancellationToken>())

tests/Orbit.Infrastructure.Tests/Controllers/UserFactsControllerTests.cs

@@ -33,6 +33,7 @@ public UserFactsControllerTests()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated GET /api/user-facts route.")]
     public async Task GetUserFacts_Success_ReturnsOk()
     {
         _mediator.Send(Arg.Any<GetUserFactsQuery>(), Arg.Any<CancellationToken>())
@@ -44,6 +45,7 @@ public async Task GetUserFacts_Success_ReturnsOk()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated GET /api/user-facts route.")]
     public async Task GetUserFacts_Failure_ReturnsBadRequest()
     {
         _mediator.Send(Arg.Any<GetUserFactsQuery>(), Arg.Any<CancellationToken>())
@@ -55,6 +57,7 @@ public async Task GetUserFacts_Failure_ReturnsBadRequest()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated DELETE /api/user-facts/{id} route.")]
     public async Task DeleteUserFact_Success_ReturnsNoContent()
     {
         _mediator.Send(Arg.Any<DeleteUserFactCommand>(), Arg.Any<CancellationToken>())
@@ -66,6 +69,7 @@ public async Task DeleteUserFact_Success_ReturnsNoContent()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated DELETE /api/user-facts/{id} route.")]
     public async Task DeleteUserFact_NotFound_ReturnsNotFound()
     {
         _mediator.Send(Arg.Any<DeleteUserFactCommand>(), Arg.Any<CancellationToken>())
@@ -77,6 +81,7 @@ public async Task DeleteUserFact_NotFound_ReturnsNotFound()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated DELETE /api/user-facts/bulk route.")]
     public async Task BulkDeleteUserFacts_Success_ReturnsOk()
     {
         _mediator.Send(Arg.Any<BulkDeleteUserFactsCommand>(), Arg.Any<CancellationToken>())
@@ -89,6 +94,7 @@ public async Task BulkDeleteUserFacts_Success_ReturnsOk()
     }
 
     [Fact]
+    [Obsolete("Covers the deprecated DELETE /api/user-facts/bulk route.")]
     public async Task BulkDeleteUserFacts_Failure_ReturnsBadRequest()
     {
         _mediator.Send(Arg.Any<BulkDeleteUserFactsCommand>(), Arg.Any<CancellationToken>())