[DevOps] .spectral.yaml 수정 - 404, 400 정의 #268 (#305)

Author: o-ii

.spectral.yaml

@@ -81,3 +81,25 @@ rules:
       - field: 'content'
         function: truthy
         message: Content is required
+
+  # Ensure endpoints with path variables define a 404 response
+  # path에 path variable이 있다면 404 응답 코드가 있어야 함
+  path-variables-require-404:
+    description: Path variables must include a 404 response
+    severity: error
+    given: $.paths[*][*].parameters[?(@.in == 'path')]^^
+    then:
+      - field: responses.404
+        function: truthy
+        message: Response 404 is required
+
+  # Ensure POST, PUT, PATCH methods define a 400 response
+  # verb가 POST, PUT, PATCH일 경우 400 응답코드가 있어야 함
+  post-put-patch-require-400:
+    description: POST, PUT, PATCH methods must include a 400 response
+    given: $.paths[*][?(@property == 'post' || @property == 'put' || @property == 'patch')]
+    severity: error
+    then:
+      - field: responses.400
+        function: truthy
+        message: Response 400 is required

src/AzureOpenAIProxy.ApiApp/Endpoints/AdminEventEndpoints.cs

@@ -116,6 +116,7 @@ public static RouteHandlerBuilder AddGetAdminEvent(this WebApplication app)
         })
         .Produces<AdminEventDetails>(statusCode: StatusCodes.Status200OK, contentType: "application/json")
         .Produces(statusCode: StatusCodes.Status401Unauthorized)
+        .Produces(statusCode: StatusCodes.Status404NotFound)
         .Produces<string>(statusCode: StatusCodes.Status500InternalServerError, contentType: "text/plain")
         .WithTags("admin")
         .WithName("GetAdminEvent")
@@ -148,6 +149,7 @@ public static RouteHandlerBuilder AddUpdateAdminEvent(this WebApplication app)
         })
         .Accepts<AdminEventDetails>(contentType: "application/json")
         .Produces<AdminEventDetails>(statusCode: StatusCodes.Status200OK, contentType: "application/json")
+        .Produces(statusCode: StatusCodes.Status400BadRequest)
         .Produces(statusCode: StatusCodes.Status401Unauthorized)
         .Produces(statusCode: StatusCodes.Status404NotFound)
         .Produces<string>(statusCode: StatusCodes.Status500InternalServerError, contentType: "text/plain")

src/AzureOpenAIProxy.ApiApp/Endpoints/ProxyChatCompletionsEndpoint.cs

@@ -57,7 +57,9 @@ public static RouteHandlerBuilder AddChatCompletions(this WebApplication app)
         .Accepts<ChatCompletionOptions>(contentType: "application/json")
         .Produces<CreateChatCompletionResponse>(statusCode: StatusCodes.Status200OK, contentType: "application/json")
         // TODO: Check both request/response payloads
+        .Produces(statusCode: StatusCodes.Status400BadRequest)
         .Produces(statusCode: StatusCodes.Status401Unauthorized)
+        .Produces(statusCode: StatusCodes.Status404NotFound)
         .Produces<string>(statusCode: StatusCodes.Status500InternalServerError, contentType: "text/plain")
         .WithTags("openai")
         .WithName("GetChatCompletions")