syntax = "proto3";

package temporal.api.sdk.v1;

option go_package = "go.temporal.io/api/sdk/v1;sdk";
option java_package = "io.temporal.api.sdk.v1";
option java_multiple_files = true;
option java_outer_classname = "WorkflowMetadataProto";
option ruby_package = "Temporalio::Api::Sdk::V1";
option csharp_namespace = "Temporalio.Api.Sdk.V1";

// The name of the query to retrieve this information is `__temporal_workflow_metadata`.
message WorkflowMetadata {
  // Metadata provided at declaration or creation time.
  WorkflowDefinition definition = 1;
  // Current long-form details of the workflow's state. This is used by user interfaces to show
  // long-form text. This text may be formatted by the user interface.
  string current_details = 2;
}

// (-- api-linter: core::0203::optional=disabled --)
message WorkflowDefinition {
  // A name scoped by the task queue that maps to this workflow definition.
  // If missing, this workflow is a dynamic workflow.
  string type = 1;

  // Query definitions, sorted by name.
  repeated WorkflowInteractionDefinition query_definitions = 2;

  // Signal definitions, sorted by name.
  repeated WorkflowInteractionDefinition signal_definitions = 3;

  // Update definitions, sorted by name.
  repeated WorkflowInteractionDefinition update_definitions = 4;
}

// (-- api-linter: core::0123::resource-annotation=disabled
//     aip.dev/not-precedent: The `name` field is optional. --)
// (-- api-linter: core::0203::optional=disabled --)
message WorkflowInteractionDefinition {
  // An optional name for the handler. If missing, it represents
  // a dynamic handler that processes any interactions not handled by others.
  // There is at most one dynamic handler per workflow and interaction kind.
  string name = 1;
  // An optional interaction description provided by the application.
  // By convention, external tools may interpret its first part,
  // i.e., ending with a line break, as a summary of the description.
  string description = 2;
}
