XS⚠️ ◾ Clarify parameter documentation and set default value for enableCorrelationHeaderBackwardCompatibility#866
Open
neilr81 wants to merge 2 commits into
Conversation
Updated XML documentation to clarify parameter usage and set a default value for enableCorrelationHeaderBackwardCompatibility. This path is obsolete if set to true and this allows the setting to be omitted entirely for services which don't use it.
Contributor
PR Metrics✔ Thanks for keeping your pull request small.
Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs! |
github-actions
Bot
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the public UseOmexMiddlewares ASP.NET Core extension API documentation and makes the backward-compatibility switch optional by introducing a default value, allowing services that don’t need legacy correlation support to omit the parameter.
Changes:
- Clarified the XML documentation for
enableCorrelationHeaderBackwardCompatibility. - Set
enableCorrelationHeaderBackwardCompatibilitydefault tofalse, making the parameter optional for callers.
neilr81
changed the title
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.
Updated XML documentation to clarify parameter usage and set a default value for enableCorrelationHeaderBackwardCompatibility.
This path is obsolete if set to true and this allows the setting to be omitted entirely for services which don't use it.