docs(outbox): document outboxInternalTopic metadata field#5155
Open
spolom wants to merge 1 commit into
Open
Conversation
Add documentation for the outboxInternalTopic metadata field which allows overriding the auto-generated internal outbox topic name. Changes: - Add outboxInternalTopic to metadata fields table - Add outboxInternalTopic to YAML example - Update internal outbox topic section with override explanation Related: dapr/dapr#8933, dapr/dapr#9855 Signed-off-by: Szymon Polom <szymon.polom@gmail.com>
7 tasks
Contributor
nelson-parente
left a comment
nelson-parente
left a comment
There was a problem hiding this comment.
Pre-review for @marcduiker handoff: LGTM with nits.
- Documents
outboxInternalTopiccorrectly: added to YAML example, spec table, and the explanatory prose. Default naming convention{namespace}{appID}{topic}outboxis correctly described. - Nit: the table entry for
outboxInternalTopicis missing a closing pipe|on the description column — may render oddly in Hugo. Worth a quick fix.
Nothing blocking — Marc, your call.
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
2 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.
Description
Documents the new
outboxInternalTopicmetadata field added in dapr/dapr#9855 (closing dapr/dapr#8933).Changes
outboxInternalTopicto the metadata fields table with description and default valueoutboxInternalTopicto the YAML component exampleIssue reference
Related to dapr/dapr#8933, dapr/dapr#9855