Prep for stable API #42
Merged
Conversation
This file contains 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
Contributor
bergundy
commented
Feb 5, 2025
bergundy
commented
- Remove EXPERIMENTAL warning from README and mark specific exports as experimental
- Sanitize token header
- Add AddHandlerLinks method and deprecate links on result objects
bergundy
commented
Feb 5, 2025
Quinn-With-Two-Ns
approved these changes
Feb 5, 2025
cretz
reviewed
Feb 5, 2025
| // Can be called from an [Operation] handler Start method or from a [Handler] StartOperation method. The context | ||
| // provided must be the context passed to the handler. This method may be called multiple times for a given handler, | ||
| // each call appending additional links. Links will only be attached on successful responses. | ||
| func AddHandlerLinks(ctx context.Context, links ...Link) { |
There was a problem hiding this comment.
I should be able to see links that exist, remove links, etc. I would recommend at least a getter and setter (though access to a structure that contains links as a field may be better, but I understand the thread safety fear even if I don't share it). Feel free to make the getter copy the slice before returning. You can keep add in addition to set if you'd like, though you may want to call it "append", your choice.
There was a problem hiding this comment.
Sorry, I already merged, I can address in a followup PR if needed.
I think it's okay to expose a simple API for now, following https://pkg.go.dev/google.golang.org/grpc#SetHeader, and add more functionality later.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.