skip operations that returns 1xx or 3xx response codes (#35)

hasura · Sep 3, 2024 · f34e81c · f34e81c
1 parent fe23190
commit f34e81c
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 14 deletions.
diff --git a/openapi/internal/oas2_operation.go b/openapi/internal/oas2_operation.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"log/slog"
 	"slices"
+	"strconv"
 
 	rest "github.com/hasura/ndc-rest-schema/schema"
 	"github.com/hasura/ndc-rest-schema/utils"
@@ -35,7 +36,7 @@ func (oc *oas2OperationBuilder) BuildFunction(pathKey string, operation *v2.Oper
 	if funcName == "" {
 		funcName = buildPathMethodName(pathKey, "get", oc.builder.ConvertOptions)
 	}
-	oc.builder.Logger.Debug("function",
+	oc.builder.Logger.Info("function",
 		slog.String("name", funcName),
 		slog.String("path", pathKey),
 	)
@@ -101,7 +102,7 @@ func (oc *oas2OperationBuilder) BuildProcedure(pathKey string, method string, op
 		procName = buildPathMethodName(pathKey, method, oc.builder.ConvertOptions)
 	}
 
-	oc.builder.Logger.Debug("procedure",
+	oc.builder.Logger.Info("procedure",
 		slog.String("name", procName),
 		slog.String("path", pathKey),
 		slog.String("method", method),
@@ -295,13 +296,22 @@ func (oc *oas2OperationBuilder) convertResponse(responses *v2.Responses, apiPath
 
 	var resp *v2.Response
 	if responses.Codes == nil || responses.Codes.IsZero() {
-		// the response is alway success
+		// the response is always successful
 		resp = responses.Default
 	} else {
-		for _, code := range []string{"200", "201", "204"} {
-			res := responses.Codes.GetOrZero(code)
-			if res != nil {
-				resp = res
+		for r := responses.Codes.First(); r != nil; r = r.Next() {
+			if r.Key() == "" {
+				continue
+			}
+			code, err := strconv.ParseInt(r.Key(), 10, 32)
+			if err != nil {
+				continue
+			}
+
+			if isUnsupportedResponseCodes(code) {
+				return nil, nil
+			} else if code >= 200 && code < 300 {
+				resp = r.Value()
 				break
 			}
 		}

diff --git a/openapi/internal/oas3_operation.go b/openapi/internal/oas3_operation.go
@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"log/slog"
+	"strconv"
 	"strings"
 
 	rest "github.com/hasura/ndc-rest-schema/schema"
@@ -36,7 +37,7 @@ func (oc *oas3OperationBuilder) BuildFunction(itemGet *v3.Operation) (*rest.REST
 		funcName = buildPathMethodName(oc.pathKey, "get", oc.builder.ConvertOptions)
 	}
 
-	oc.builder.Logger.Debug("function",
+	oc.builder.Logger.Info("function",
 		slog.String("name", funcName),
 		slog.String("path", oc.pathKey),
 		slog.String("method", oc.method),
@@ -87,7 +88,7 @@ func (oc *oas3OperationBuilder) BuildProcedure(operation *v3.Operation) (*rest.R
 		procName = buildPathMethodName(oc.pathKey, oc.method, oc.builder.ConvertOptions)
 	}
 
-	oc.builder.Logger.Debug("procedure",
+	oc.builder.Logger.Info("procedure",
 		slog.String("name", procName),
 		slog.String("path", oc.pathKey),
 		slog.String("method", oc.method),
@@ -329,11 +330,22 @@ func (oc *oas3OperationBuilder) convertResponse(responses *v3.Responses, apiPath
 	}
 
 	var resp *v3.Response
-	for _, code := range []int{200, 201, 204} {
-		res := responses.FindResponseByCode(code)
-		if res != nil {
-			resp = res
-			break
+	if responses.Codes != nil && !responses.Codes.IsZero() {
+		for r := responses.Codes.First(); r != nil; r = r.Next() {
+			if r.Key() == "" {
+				continue
+			}
+			code, err := strconv.ParseInt(r.Key(), 10, 32)
+			if err != nil {
+				continue
+			}
+
+			if isUnsupportedResponseCodes(code) {
+				return nil, nil, nil
+			} else if code >= 200 && code < 300 {
+				resp = r.Value()
+				break
+			}
 		}
 	}
 

diff --git a/openapi/internal/utils.go b/openapi/internal/utils.go
@@ -405,3 +405,8 @@ func formatWriteObjectName(name string) string {
 func errParameterSchemaEmpty(fieldPaths []string) error {
 	return fmt.Errorf("parameter schema of $.%s is empty", strings.Join(fieldPaths, "."))
 }
+
+// redirection and information response status codes aren't supported
+func isUnsupportedResponseCodes[T int | int64](code T) bool {
+	return code < 200 || (code >= 300 && code < 400)
+}
diff --git a/openapi/testdata/petstore2/swagger.json b/openapi/testdata/petstore2/swagger.json
@@ -548,6 +548,14 @@
         "responses": { "default": { "description": "successful operation" } }
       }
     },
+    "/user/logout-redirect": {
+      "get": {
+        "operationId": "logoutUserRedirect",
+        "produces": [],
+        "parameters": [],
+        "responses": { "302": { "description": "successful operation" } }
+      }
+    },
     "/user": {
       "post": {
         "tags": ["user"],

diff --git a/openapi/testdata/petstore3/source.json b/openapi/testdata/petstore3/source.json
@@ -2756,6 +2756,19 @@
           }
         }
       }
+    },
+    "/self-service/browser/flows/logout": {
+      "get": {
+        "description": "This endpoint initializes a logout flow.\n\n\u003e This endpoint is NOT INTENDED for API clients and only works\nwith browsers (Chrome, Firefox, ...).\n\nOn successful logout, the browser will be redirected (HTTP 302 Found) to the `return_to` parameter of the initial request\nor fall back to `urls.default_return_to`.\n\nMore information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).",
+        "operationId": "initializeSelfServiceBrowserLogoutFlow",
+        "responses": {
+          "302": {
+            "$ref": "#/components/responses/emptyResponse"
+          }
+        },
+        "summary": "Initialize Browser-Based Logout User Flow",
+        "tags": ["public"]
+      }
     }
   },
   "components": {
@@ -3280,6 +3293,11 @@
         }
       }
     },
+    "responses": {
+      "emptyResponse": {
+        "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201."
+      }
+    },
     "securitySchemes": {
       "basic": {
         "type": "http",