Skip to content

docs: complete System Nexus WIT annotations #865

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

Merged
tconley1428 merged 1 commit into from
Sep 3, 2026
Merged

docs: complete System Nexus WIT annotations #865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions nexus/deps/nexus-temporal-types/model.wit
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,10 @@ interface model {
/// typescript-import="@temporalio/common"
type workflow-id-conflict-policy = placeholder;

/// @nexus.doc "Static metadata for a workflow execution."
/// @nexus.proto "temporal.api.sdk.v1.UserMetadata" typescript-import="@temporalio/proto"
/// @nexus.flatten-in-api
/// @nexus.experimental
record user-metadata {
/// @nexus.doc "Single-line fixed summary for the workflow execution that may appear in UI and CLI. This can be in single-line Temporal Markdown format."
/// @nexus.proto-field "summary"
Expand Down
6 changes: 6 additions & 0 deletions nexus/workflow-service.wit
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,15 @@ interface workflow-service {
/// @nexus.doc "Amount of time to wait before starting the workflow. This does not work with cron-schedule."
/// @nexus.proto-field "workflow_start_delay"
start-delay: option<duration>,
/// @nexus.doc "Static metadata for the workflow execution."
user-metadata: option<user-metadata>,
/// @nexus.source python="workflow_namespace()" typescript="workflowNamespace()" go="workflow.GetInfo(ctx).Namespace" dotnet="TemporalWorkflowContext.WorkflowNamespace()"
/// @nexus.doc "Namespace of the workflow execution."
namespace: string,
/// @nexus.omit
control: placeholder,
/// @nexus.api-omit
/// @nexus.doc "Headers for the request."
/// @nexus.proto-field "header"
headers: option<header>,
/// @nexus.omit
Expand All @@ -103,10 +106,13 @@ interface workflow-service {
time-skipping-config: placeholder,
}

/// @nexus.doc "Result of signaling a workflow and starting it if needed."
/// @nexus.experimental
/// @nexus.proto "temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionResponse" typescript-import="@temporalio/proto"
record signal-with-start-workflow-response {
/// @nexus.doc "Run ID of the started workflow."
run-id: option<string>,
/// @nexus.doc "Whether the workflow was started."
started: option<bool>,
/// @nexus.omit
signal-link: placeholder,
Expand Down
Loading