Clarify that Nexus Failure details must be JSON serializable (#506)

bergundy · Sushisource · web-flow · commit e8fc1a5c4909 · 2024-12-19T19:18:21.000Z
Co-authored-by: Spencer Judge &lt;sjudge@hey.com&gt;
diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
@@ -6859,7 +6859,8 @@
         },
         "details": {
           "type": "string",
-          "format": "byte"
+          "format": "byte",
+          "description": "UTF-8 encoded JSON serializable details."
         }
       },
       "title": "A general purpose failure message.\nSee: https://github.com/nexus-rpc/api/blob/main/SPEC.md#failure"
diff --git a/temporal/api/nexus/v1/message.proto b/temporal/api/nexus/v1/message.proto
@@ -37,6 +37,7 @@ import "temporal/api/common/v1/message.proto";
 message Failure {
     string message = 1;
     map<string, string> metadata = 2;
+    // UTF-8 encoded JSON serializable details.
     bytes details = 3;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ import "temporal/api/common/v1/message.proto";`
`37`	`37`	`message Failure {`
`38`	`38`	`string message = 1;`
`39`	`39`	`map<string, string> metadata = 2;`
	`40`	`+ // UTF-8 encoded JSON serializable details.`
`40`	`41`	`bytes details = 3;`
`41`	`42`	`}`
`42`	`43`