changing on_missing and on_duplicate to string value instead of Enum for proper JSON values

Author: cikasfm

docs/openapiv2/apidocs.swagger.json

@@ -155,8 +155,9 @@ service OpenFGAService {
         "relationship exists between an object and an user.\n"
         "In the body, `writes` adds new tuples and `deletes` removes existing tuples. When deleting a tuple, any `condition` specified with it is ignored.\n"
         "The API is not idempotent by default: if, later on, you try to add the same tuple key (even if the `condition` is different), or if you try to delete a non-existing tuple, it will throw an error.\n"
-        "To allow writes when an identical tuple already exists in the database, set `\"on_duplicate\": \"ON_DUPLICATE_IGNORE\"` on the `writes` object.\n"
-        "To allow deletes when a tuple was already removed from the database, set `\"on_missing\": \"ON_MISSING_IGNORE\"` on the `deletes` object.\n"
+        "To allow writes when an identical tuple already exists in the database, set `\"on_duplicate\": \"ignore\"` on the `writes` object.\n"
+        "To allow deletes when a tuple was already removed from the database, set `\"on_missing\": \"ignore\"` on the `deletes` object.\n"
+        "If a Write request contains both idempotent (ignore) and non-idempotent (error) operations, the most restrictive action (error) will take precedence. If a condition fails for a sub-request with an error flag, the entire transaction will be rolled back. This gives developers explicit control over the atomicity of the requests.\n"
         "The API will not allow you to write tuples such as `document:2021-budget#viewer@document:2021-budget#viewer`, because they are implicit.\n"
         "An `authorization_model_id` may be specified in the body. If it is, it will be used to assert that each written tuple (not deleted) "
         "is valid for the model specified. If it is not specified, the latest authorization model ID will be used.\n"
@@ -174,7 +175,7 @@ service OpenFGAService {
         "        \"object\": \"document:2021-budget\"\n"
         "      }\n"
         "    ],\n"
-        "    \"on_duplicate\": \"ON_DUPLICATE_ERROR\"\n"
+        "    \"on_duplicate\": \"ignore\"\n"
         "  },\n"
         "  \"authorization_model_id\": \"01G50QVV17PECNVAHX1GG4Y5NC\"\n"
         "}\n"
@@ -192,7 +193,7 @@ service OpenFGAService {
         "        \"object\": \"document:2021-budget\"\n"
         "      }\n"
         "    ],\n"
-        "    \"on_missing\": \"ON_MISSING_ERROR\"\n"
+        "    \"on_missing\": \"ignore\"\n"
         "  }\n"
         "}\n"
         "```\n"
@@ -1245,48 +1246,44 @@ message ReadResponse {
   ];
 }
 
-enum OnDuplicate {
-  ON_DUPLICATE_UNSPECIFIED = 0; // If set to 'ON_DUPLICATE_UNSPECIFIED' OR not set, the API will behave as if it was set to 'ON_DUPLICATE_ERROR'.
-  ON_DUPLICATE_ERROR = 1; // Return an error if a tuple already exists.
-  ON_DUPLICATE_IGNORE = 2; // Treat identical writes as no-ops if all attributes (including the RelationshipCondition) match.
-}
-
 message WriteRequestWrites {
   repeated TupleKey tuple_keys = 1 [
     json_name = "tuple_keys",
     (google.api.field_behavior) = REQUIRED,
     (validate.rules).repeated.min_items = 1,
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {min_items: 1}
   ];
-  OnDuplicate on_duplicate = 2 [
+  string on_duplicate = 2 [
     json_name = "on_duplicate",
-    (validate.rules).enum.defined_only = true,
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-      example: "\"ON_DUPLICATE_ERROR\""
-      description: "If 'ON_DUPLICATE_ERROR', the API returns an error if an identical tuple already exists. If 'ON_DUPLICATE_IGNORE', identical writes are treated as no-ops (matching on user, relation, object, and RelationshipCondition)."
+      enum: [
+        "error", // Return an error if a tuple already exists.
+        "ignore" // Treat identical writes as no-ops if all attributes (including the RelationshipCondition) match.
+      ]
+      default: "error"
+      example: "\"ignore\""
+      description: "On 'error' ( or unspecified ), the API returns an error if an identical tuple already exists. On 'ignore', identical writes are treated as no-ops (matching on user, relation, object, and RelationshipCondition)."
     }
   ];
 }
 
-enum OnMissing {
-  ON_MISSING_UNSPECIFIED = 0; // If set to 'ON_MISSING_UNSPECIFIED' or not set, the API behaves as if it were set to 'ON_MISSING_ERROR'.
-  ON_MISSING_ERROR = 1; // Return an error if a tuple does not exist.
-  ON_MISSING_IGNORE = 2; // Do not return an error if a tuple does not exist.
-}
-
 message WriteRequestDeletes {
   repeated TupleKeyWithoutCondition tuple_keys = 1 [
     json_name = "tuple_keys",
     (google.api.field_behavior) = REQUIRED,
     (validate.rules).repeated.min_items = 1,
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {min_items: 1}
   ];
-  OnMissing on_missing = 2 [
+  string on_missing = 2 [
     json_name = "on_missing",
-    (validate.rules).enum.defined_only = true,
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-      example: "\"ON_MISSING_ERROR\""
-      description: "If 'ON_MISSING_ERROR', the API returns an error when deleting a tuple that does not exist. If 'ON_MISSING_IGNORE', deletes of non-existent tuples are treated as no-ops."
+      enum: [
+        "error", // Return an error if a tuple does not exist.
+        "ignore" // Do not return an error if a tuple does not exist.
+      ]
+      default: "error"
+      example: "\"ignore\""
+      description: "On 'error', the API returns an error when deleting a tuple that does not exist. On 'ignore', deletes of non-existent tuples are treated as no-ops."
     }
   ];
 }