feat: introduce 409 conflict error code

Close #107
openfga · Nov 27, 2023 · 871b2d5 · 871b2d5
1 parent 0f1d73e
commit 871b2d5
Show file tree

Hide file tree

Showing 6 changed files with 472 additions and 160 deletions.
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
@@ -53,6 +53,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -102,6 +108,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -148,6 +160,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -187,6 +205,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -231,6 +255,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -276,6 +306,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -346,6 +382,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -401,6 +443,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -468,6 +516,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -518,6 +572,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -581,6 +641,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -654,6 +720,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -718,6 +790,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -798,6 +876,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -873,6 +957,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -953,6 +1043,12 @@
               "$ref": "#/definitions/PathUnknownErrorMessageResponse"
             }
           },
+          "409": {
+            "description": "Request failed due to aborted.",
+            "schema": {
+              "$ref": "#/definitions/AbortedMessageResponse"
+            }
+          },
           "500": {
             "description": "Request failed due to internal server error.",
             "schema": {
@@ -995,6 +1091,21 @@
     }
   },
   "definitions": {
+    "AbortedMessageResponse": {
+      "type": "object",
+      "example": {
+        "code": "10",
+        "message": "transaction conflict"
+      },
+      "properties": {
+        "code": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        }
+      }
+    },
     "Any": {
       "type": "object",
       "properties": {

diff --git a/openfga/v1/errors_ignore.proto b/openfga/v1/errors_ignore.proto
@@ -114,4 +114,10 @@ message PathUnknownErrorMessageResponse {
   string message = 2;
 }
 
+message AbortedMessageResponse {
+  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {example: "{\"code\":\"10\", \"message\":\"transaction conflict\"}"};
+  string code = 1;
+  string message = 2;
+}
+
 message ErrorMessageRequest {}
diff --git a/openfga/v1/openapi.proto b/openfga/v1/openapi.proto
@@ -39,6 +39,15 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
         json_schema: {ref: ".openfga.v1.PathUnknownErrorMessageResponse"}
       }
     }
+  }
+    responses: {
+    key: "409"
+    value: {
+      description: "Request failed due to aborted."
+      schema: {
+        json_schema: {ref: ".openfga.v1.AbortedMessageResponse"}
+      }
+    }
   }
   responses: {
     key: "500"