got this wrong: we _dont_ want oneof (#15)

* got this wrong: we _dont_ want oneof

* we don't want oneof

* tweak the comments

AB#8336

---------

Co-authored-by: Robin Bryce <[email protected]>

Author: robinbryce

datatrails-common-api/assets/v2/assets/eventresponse.proto

@@ -173,18 +173,17 @@ message EventResponse {
         max_length: 1024
     }];
 
-    // An event has exactly one proof mechanism. On any event only the entry
-    // corresponding to the chosen proof mechanism will be present. (Note that
-    // onfof exposes us to to many tooling compatibility issues)
+    // An event has exactly one proof mechanism. This field caputures the proof
+    // mechanism specific details supporting the trustworthyness of the event
+    // record. More than one proof mech type is likely, but using oneof here has
+    // proven to expose us to open ended tooling compatibility issues.
 
     // proof details for proof_mechanism MERKLE_LOG
-    oneof proof_details {
-        MerkleLogEntry merklelog_entry = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-            description:
-            "verifiable merkle mmr log entry details",
-            // see https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-openapiv2/options/openapiv2.proto
-            //  for specific types.
-            type: OBJECT
-        }];
-    }
+    MerkleLogEntry merklelog_entry = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+        description:
+        "verifiable merkle mmr log entry details",
+        // see https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-openapiv2/options/openapiv2.proto
+        //  for specific types.
+        type: OBJECT
+    }];
 }

datatrails-common-api/assets/v2/assets/eventresponsejsonapi.proto

@@ -175,17 +175,15 @@ message EventResponseJSONAPI {
         max_length: 1024
     }];
 
-    // An event has exactly one proof mechanism. This field caputures the proof
-    // mechanism specific details supporting the trustworthyness of the event
-    // record. We anticipate at least two proof mechs: merkle_log and
-    // verkle_log. We use oneof to avoid repeating the scattering of randomly
-    // re-purposed fields we currently have for simple hash vs khipu.
-    oneof proof_details {
-        // proof details for proof_mechanism MERKLE_LOG
-        MerkleLogEntry merklelog_entry = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-            description:
-            "verifiable merkle mmr log entry details"
-            max_length: 1024
-        }];
-    };
+   // An event has exactly one proof mechanism. This field caputures the proof
+   // mechanism specific details supporting the trustworthyness of the event
+   // record. More than one proof mech type is likely, but using oneof here has
+   // proven to expose us to open ended tooling compatibility issues.
+
+   // proof details for proof_mechanism MERKLE_LOG
+   MerkleLogEntry merklelog_entry = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+       description:
+       "verifiable merkle mmr log entry details"
+       max_length: 1024
+   }];
 }