Skip to content

Commit

Permalink
Add SDK-only workflow metadata (#336)
Browse files Browse the repository at this point in the history
  • Loading branch information
antlai-temporal authored Dec 8, 2023
1 parent 4aabb70 commit 798c32f
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/.gen
/.vscode
/.stamp
*~
66 changes: 66 additions & 0 deletions temporal/api/sdk/v1/workflow_metadata.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

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_getWorkflowMetadata`.
message WorkflowMetadata {
// Metadata provided at declaration or creation time.
WorkflowDefinition definition = 1;
}

// (-- 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;
// An optional workflow 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;
repeated WorkflowInteractionDefinition query_definitions = 3;
repeated WorkflowInteractionDefinition signal_definitions = 4;
repeated WorkflowInteractionDefinition update_definitions = 5;
}

// (-- 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;
}

0 comments on commit 798c32f

Please sign in to comment.