Introduce api category into history APIs#9435
Open
yux0 wants to merge 6 commits intotemporalio:mainfrom
Open
Conversation
yycptt
reviewed
Mar 4, 2026
Member
yycptt
left a comment
yycptt
left a comment
There was a problem hiding this comment.
Guess you'll have to add more for SAA like PollActivityExecution.
We may need to use proto custom options for this and define it along with the method... otherwise it's very easy to miss updating this code for new apis.
bergundy
reviewed
Mar 6, 2026
Member
bergundy
left a comment
bergundy
left a comment
There was a problem hiding this comment.
I would strongly recommend that you require that all server methods set a category and enforce it in genrpcwrappers and the chasm protoc plugin. It forces the dev to think about this while developing and prevents accidentally mis-categorizing APIs in the future.
yux0
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed?
Introduce api category into history APIs
Why?
There are some APIs we want to exclude from health check. Using API category is a more protective way to manage this group.
How did you test it?