From e8fc1a5c490987714081f2aa0d308601cbf1304b Mon Sep 17 00:00:00 2001
From: Roey Berman <roey@temporal.io>
Date: Thu, 19 Dec 2024 11:18:21 -0800
Subject: [PATCH] Clarify that Nexus Failure details must be JSON serializable
 (#506)

Co-authored-by: Spencer Judge <sjudge@hey.com>
---
 openapi/openapiv2.json              | 3 ++-
 temporal/api/nexus/v1/message.proto | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
index d24fdd85..ca105596 100644
--- 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
index 7519120b..46906e0a 100644
--- 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;
 }