Skip to content

Extend Payload to include references to externally stored objects #671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+28 −0
Open

Extend Payload to include references to externally stored objects #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a236aa5
Change Payload to contain references to externally stored objects
simvlad Nov 25, 2025
56175e5
Commit openapi spec
simvlad Nov 25, 2025
fe9e752
Change to external references
simvlad Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7633,6 +7633,17 @@
}
}
},
"PayloadExternalReference": {
"type": "object",
"properties": {
"sizeBytes": {
"type": "string",
"format": "int64",
"title": "Size in bytes of the externally stored object"
}
},
"description": "Describes an externally stored object referenced by this Payload."
},
"PendingActivityInfoPauseInfo": {
"type": "object",
"properties": {
Expand Down
7 changes: 7 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9790,6 +9790,13 @@ components:
Represents some binary (byte array) data (ex: activity input parameters or workflow result) with
metadata which describes this binary data (format, encoding, encryption, etc). Serialization
of the data may be user-defined.
Payload_ExternalReference:
type: object
properties:
sizeBytes:
type: string
description: Size in bytes of the externally stored object
description: Describes an externally stored object referenced by this Payload.
Payloads:
type: object
properties:
Expand Down
10 changes: 10 additions & 0 deletions temporal/api/common/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,18 @@ message Payloads {
message Payload {
map<string,bytes> metadata = 1;
bytes data = 2;
// References to data stored externally rather than embedded in the payload.
Copy link
Member

@cretz cretz Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure it is currently accurate to say these are references, it's just some info about them

Copy link
Contributor Author

@simvlad simvlad Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plural external_infos is quite awkward, so I decided against it. I also considered ExternalDescriptor, but I like it slightly less than ExternalReference. Any other suggestions, which would also work for plural?

// A Payload can reference zero or more external objects.
repeated ExternalReference external_references = 3;

// Describes an externally stored object referenced by this Payload.
message ExternalReference {
// Size in bytes of the externally stored object
int64 size_bytes = 1;
}
}


// A user-defined set of *indexed* fields that are used/exposed when listing/searching workflows.
// The payload is not serialized in a user-defined way.
message SearchAttributes {
Expand Down
Loading