[ADMINAPI-1325] - Update Ed-Fi API Specifications repo with new spec for 2.3.0

Application/EdFi.Ods.AdminApi.Common/Infrastructure/AdminApiEndpointBuilder.cs

@@ -43,9 +43,6 @@ public static AdminApiEndpointBuilder MapPost(IEndpointRouteBuilder endpoints, s
     public static AdminApiEndpointBuilder MapPut(IEndpointRouteBuilder endpoints, string route, Delegate handler)
         => new(endpoints, HttpVerb.PUT, route, handler);
 
-    public static AdminApiEndpointBuilder MapPatch(IEndpointRouteBuilder endpoints, string route, Delegate handler)
-        => new(endpoints, HttpVerb.PATCH, route, handler);
-
     public static AdminApiEndpointBuilder MapDelete(IEndpointRouteBuilder endpoints, string route, Delegate handler)
         => new(endpoints, HttpVerb.DELETE, route, handler);
 
@@ -73,10 +70,10 @@ public AdminApiEndpointBuilder RequireAuthorization(PolicyDefinition authorizati
 
     public void BuildForVersions(params AdminApiVersions.AdminApiVersion[] versions)
     {
-        BuildForVersions(string.Empty, versions);
+        BuildForVersions(string.Empty, false, versions);
     }
 
-    public void BuildForVersions(string authorizationPolicy, params AdminApiVersions.AdminApiVersion[] versions)
+    public void BuildForVersions(string authorizationPolicy, bool display409 = false, params AdminApiVersions.AdminApiVersion[] versions)
     {
         if (versions.Length == 0)
             throw new ArgumentException("Must register for at least 1 version");
@@ -98,7 +95,6 @@ public void BuildForVersions(string authorizationPolicy, params AdminApiVersions
                 HttpVerb.POST => _endpoints.MapPost(versionedRoute, _handler),
                 HttpVerb.PUT => _endpoints.MapPut(versionedRoute, _handler),
                 HttpVerb.DELETE => _endpoints.MapDelete(versionedRoute, _handler),
-                HttpVerb.PATCH => _endpoints.MapPatch(versionedRoute, _handler),
                 _ => throw new ArgumentOutOfRangeException($"Unconfigured HTTP verb for mapping: {_verb}")
             };
 
@@ -125,7 +121,8 @@ public void BuildForVersions(string authorizationPolicy, params AdminApiVersions
             builder.WithGroupName(version.ToString());
             builder.WithResponseCode(401, "Unauthorized. The request requires authentication");
             builder.WithResponseCode(403, "Forbidden. The request is authenticated, but not authorized to access this resource");
-            builder.WithResponseCode(409, "Conflict. The request is authenticated, but it has a conflict with an existing element");
+            if (display409)
+                builder.WithResponseCode(409, "Conflict. The request is authenticated, but it has a conflict with an existing element");
             builder.WithResponseCode(500, FeatureCommonConstants.InternalServerErrorResponseDescription);
 
             if (_route.Contains("id", StringComparison.InvariantCultureIgnoreCase))
@@ -192,5 +189,5 @@ public AdminApiEndpointBuilder AllowAnonymous()
         return this;
     }
 
-    private enum HttpVerb { GET, POST, PUT, DELETE, PATCH }
+    private enum HttpVerb { GET, POST, PUT, DELETE }
 }

Application/EdFi.Ods.AdminApi/Features/Applications/AddApplication.cs

@@ -25,7 +25,7 @@ public void MapEndpoints(IEndpointRouteBuilder endpoints)
         AdminApiEndpointBuilder.MapPost(endpoints, "/applications", Handle)
             .WithDefaultSummaryAndDescription()
             .WithRouteOptions(b => b.WithResponse<ApplicationResult>(201))
-            .BuildForVersions(AdminApiVersions.V2);
+            .BuildForVersions(string.Empty, true, AdminApiVersions.V2);
     }
 
     public static async Task<IResult> Handle(Validator validator, IAddApplicationCommand addApplicationCommand, IMapper mapper, IUsersContext db, AddApplicationRequest request, IOptions<AppSettings> options)

build.ps1

@@ -227,21 +227,6 @@ function GenerateOpenAPI {
     }
 }
 
-function GenerateOpenAPIAdminConsole {
-    Invoke-Execute {
-        Push-Location $solutionRoot/EdFi.Ods.AdminApi/
-        $outputOpenAPI = "../../docs/api-specifications/openapi-yaml/admin-api-console-$APIVersion.yaml"
-        $dllPath = "./bin/Release/net8.0/EdFi.Ods.AdminApi.dll"
-
-        try {
-            dotnet tool run swagger tofile --output $outputOpenAPI --yaml $dllPath adminconsole
-        }
-        finally {
-            Pop-Location
-        }
-    }
-}
-
 function GenerateDocumentation {
     Invoke-Execute {
         $outputOpenAPI = "docs/api-specifications/openapi-yaml/admin-api-$APIVersion.yaml"
@@ -250,14 +235,6 @@ function GenerateDocumentation {
     }
 }
 
-function GenerateDocumentationAdminConsole {
-    Invoke-Execute {
-        $outputOpenAPI = "docs/api-specifications/openapi-yaml/admin-api-console-$APIVersion.yaml"
-        $outputMD = "docs/api-specifications/markdown/admin-api-console-$APIVersion-summary.md"
-        widdershins --search false --omitHeader true --code true --summary $outputOpenAPI -o $outputMD
-    }
-}
-
 function PublishAdminApi {
     Invoke-Execute {
         $project = "$solutionRoot/EdFi.Ods.AdminApi/"
@@ -433,9 +410,7 @@ function Invoke-GenerateOpenAPIAndMD {
     Invoke-Step { Restore }
     Invoke-Step { Compile }
     Invoke-Step { GenerateOpenAPI }
-    Invoke-Step { GenerateOpenAPIAdminConsole }
     Invoke-Step { GenerateDocumentation }
-    Invoke-Step { GenerateDocumentationAdminConsole }
 }
 
 function Invoke-SetAssemblyInfo {

docs/api-specifications/openapi-yaml/admin-api-1.4.3.yaml

@@ -1,8 +1,8 @@
 openapi: 3.0.1
 info:
-  title: Admin API Documentation
-  description: 'The Ed-Fi Admin API is a REST API-based administrative interface for managing vendors, applications, client credentials, and authorization rules for accessing an Ed-Fi API.'
-  version: v1
+  version: 1.4.3
+  title: "Ed-Fi Admin API"
+  description: The Ed-Fi Admin API is a REST API-based administrative interface for managing vendors, applications, client credentials, and authorization rules for accessing an Ed-Fi API.
 paths:
   /v1/vendors:
     get: