Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuration schema generator: fix missing cref inside para tag #1358

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

bart-vmware
Copy link
Member

@bart-vmware bart-vmware commented Sep 17, 2024

Description

Configuration schema generator: fix missing cref inside para tag.
Fixes #1356 (comment).

Example output from GetDocComment(ISymbol):

<member name="P:Steeltoe.Management.Endpoint.Actuators.HttpExchanges.HttpExchangesEndpointOptions.RequestHeaders">
  <summary>
            Gets request header values that are allowed to be logged.
            <para>
            If a request header is not present in the <see cref="P:Steeltoe.Management.Endpoint.Actuators.HttpExchanges.HttpExchangesEndpointOptions.RequestHeaders" />, the header name will be logged with a redacted value. Request headers can
            contain authentication tokens, or private information which may have regulatory concerns under GDPR and other laws. Arbitrary request headers should
            not be logged unless logs are secure and access controlled and the privacy impact assessed.
            </para>
  </summary>
</member>

Quality checklist

  • Your code complies with our Coding Style.
  • You've updated unit and/or integration tests for your change, where applicable.
  • You've updated documentation for your change, where applicable.
    If your change affects other repositories, such as Documentation, Samples and/or MainSite, add linked PRs here.
  • There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.
  • You've added required license files and/or file headers (explaining where the code came from with proper attribution), where code is copied from StackOverflow, a blog, or OSS.

@bart-vmware bart-vmware mentioned this pull request Sep 17, 2024
5 tasks
@bart-vmware
Copy link
Member Author

/azp run Steeltoe.All

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@bart-vmware
Copy link
Member Author

/cc @eerhardt

@bart-vmware bart-vmware marked this pull request as ready for review September 17, 2024 15:05
Copy link

sonarcloud bot commented Sep 17, 2024

@bart-vmware bart-vmware merged commit 6ba87dd into main Sep 19, 2024
15 checks passed
@bart-vmware bart-vmware deleted the fix-schema-cref-in-para branch September 19, 2024 14:04
@bart-vmware bart-vmware restored the fix-schema-cref-in-para branch September 19, 2024 14:06
@bart-vmware bart-vmware deleted the fix-schema-cref-in-para branch September 19, 2024 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants