Document SearchAttributes parsing
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 133
- Forks
- 101
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 11
Description
Is your feature request related to a problem? Please describe.
SearchAttributes:
I don't know from reading this proto how to specify search attribute types in StartWorkflowExecution. Possible types are:
https://docs.temporal.io/docs/concepts/what-is-a-search-attribute/#custom-search-attributes
Describe the solution you'd like
A comment explaining how the Payloads are parsed, for example:
// Each Payload has a metadata.type: IndexedValueType
// If payload.metata.type is INDEXED_VALUE_TYPE_DATETIME, payload.data should be an integer with milliseconds since epoch.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with temporal/api/common/v1/message.proto and the IndexedValueType definitions in temporal/api/enums/v1/common.proto, then trace how SearchAttributes is used in StartWorkflowExecution. The work is complete when a comment explains how each Payload's metadata.type and data represent the supported search attribute types.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100