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

fix the union type document issue #4603

Merged

Conversation

ArcturusZhang
Copy link
Member

@ArcturusZhang ArcturusZhang commented Apr 19, 2024

Fixes #4508
Fixes #4509

Description

We construct a message in xml doc on a property when the its type is related with BinaryData, including when the type is BinaryData, or the type is a collection type of BinaryData.
Previously the code was not written in a recursive way so that the generator only adds messages when the type is IDictionary<string, BinaryData> or IList<BinaryData>. It does not recognize more complicated cases such as IDictionary<string, IList<BinaryData>>, we are having this case in the additional properties cadl ranch cases.

Checklist

To ensure a quick review and merge, please ensure:

  • The PR has a understandable title and description explaining the why and what.
  • The PR is opened in draft if not ready for review yet.
    • If opened in draft, please allocate sufficient time (24 hours) after moving out of draft for review
  • The branch is recent enough to not have merge conflicts upon creation.

Ready to Land?

  • Build is completely green
    • Submissions with test failures require tracking issue and approval of a CODEOWNER
  • At least one +1 review by a CODEOWNER
  • All -1 reviews are confirmed resolved by the reviewer
    • Override/Marking reviews stale must be discussed with CODEOWNERS first

@ArcturusZhang ArcturusZhang marked this pull request as ready for review April 19, 2024 08:59
@ArcturusZhang ArcturusZhang changed the title fix the union type issue fix the union type document issue Apr 22, 2024
@ArcturusZhang ArcturusZhang merged commit ae28713 into Azure:feature/v3 Apr 28, 2024
8 checks passed
@ArcturusZhang ArcturusZhang deleted the fix-union-type-description branch April 28, 2024 03:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants