aliencube · justinyoo · Sep 7, 2024 · Sep 7, 2024 · Sep 7, 2024 · Sep 7, 2024
diff --git a/.spectral.yaml b/.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
diff --git a/src/AzureOpenAIProxy.ApiApp/Endpoints/AdminEventEndpoints.cs b/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")

diff --git a/src/AzureOpenAIProxy.ApiApp/Endpoints/ProxyChatCompletionsEndpoint.cs b/src/AzureOpenAIProxy.ApiApp/Endpoints/ProxyChatCompletionsEndpoint.cs
@@ -56,7 +56,9 @@ public static RouteHandlerBuilder AddChatCompletions(this WebApplication app)
         .Accepts<ChatCompletionOptions>(contentType: "application/json")
         .Produces<ChatCompletion>(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")

diff --git a/src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs b/src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs
 public class AdminEventRepository : IAdminEventRepository
 {
    /// <inheritdoc />
    public async Task<AdminEventDetails> CreateEvent(AdminEventDetails eventDetails)
    {
        throw new NotImplementedException();
    }

    /// <inheritdoc />
    public async Task<List<AdminEventDetails>> GetEvents()
    {
        throw new NotImplementedException();
    }

    /// <inheritdoc />
    public async Task<AdminEventDetails> GetEvent(Guid eventId)
    {
        throw new NotImplementedException();
    }

    /// <inheritdoc />
    public async Task<AdminEventDetails> UpdateEvent(Guid eventId, AdminEventDetails eventDetails)
    {
        throw new NotImplementedException();
    }
	public class AdminEventRepository : IAdminEventRepository
	{
	/// <inheritdoc />
	public async Task<AdminEventDetails> CreateEvent(AdminEventDetails eventDetails)
Check warning on line 45 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.` Check warning on line 45 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.`
	{
	throw new NotImplementedException();
	}

	/// <inheritdoc />
	public async Task<List<AdminEventDetails>> GetEvents()
Check warning on line 51 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.` Check warning on line 51 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.`
	{
	throw new NotImplementedException();
	}

	/// <inheritdoc />
	public async Task<AdminEventDetails> GetEvent(Guid eventId)
Check warning on line 57 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.` Check warning on line 57 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.`
	{
	throw new NotImplementedException();
	}

	/// <inheritdoc />
	public async Task<AdminEventDetails> UpdateEvent(Guid eventId, AdminEventDetails eventDetails)
Check warning on line 63 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.` Check warning on line 63 in src/AzureOpenAIProxy.ApiApp/Repositories/AdminEventRepository.cs GitHub Actions / build-test `This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.`
	{
	throw new NotImplementedException();
	}