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

Co-authored-by: Spencer Judge <[email protected]>
temporalio · Dec 19, 2024 · e8fc1a5 · e8fc1a5
1 parent fd15e36
commit e8fc1a5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
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;
 }