Fix OpenAPI XML code gen #60977
+109
−13
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| public class DeeplyNestedLevel1 | ||
|
||
| { | ||
| public required DeeplyNestedLevel2 Item2 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel2 | ||
| { | ||
| public required DeeplyNestedLevel3 Item3 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel3 | ||
| { | ||
| public required DeeplyNestedLevel4 Item4 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel4 | ||
| { | ||
| public required DeeplyNestedLevel5 Item5 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel5 | ||
| { | ||
| public required DeeplyNestedLevel6 Item6 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel6 | ||
| { | ||
| public required DeeplyNestedLevel7 Item7 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel7 | ||
| { | ||
| public required DeeplyNestedLevel8 Item8 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel8 | ||
| { | ||
| public required DeeplyNestedLevel9 Item9 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel9 | ||
| { | ||
| public required DeeplyNestedLevel10 Item10 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel10 | ||
| { | ||
| public required DeeplyNestedLevel11 Item11 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel11 | ||
| { | ||
| public required DeeplyNestedLevel12 Item12 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel12 | ||
| { | ||
| public required DeeplyNestedLevel13 Item13 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel13 | ||
| { | ||
| public required DeeplyNestedLevel14 Item14 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel14 | ||
| { | ||
| public required DeeplyNestedLevel15 Item15 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel15 | ||
| { | ||
| public required DeeplyNestedLevel16 Item16 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel16 | ||
| { | ||
| public required DeeplyNestedLevel17 Item17 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel17 | ||
| { | ||
| public required DeeplyNestedLevel18 Item18 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel18 | ||
| { | ||
| public required DeeplyNestedLevel19 Item19 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel19 | ||
| { | ||
| public required DeeplyNestedLevel20 Item20 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel20 | ||
| { | ||
| public required DeeplyNestedLevel21 Item21 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel21 | ||
| { | ||
| public required DeeplyNestedLevel22 Item22 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel22 | ||
| { | ||
| public required DeeplyNestedLevel23 Item23 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel23 | ||
| { | ||
| public required DeeplyNestedLevel24 Item24 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel24 | ||
| { | ||
| public required DeeplyNestedLevel25 Item25 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel25 | ||
| { | ||
| public required DeeplyNestedLevel26 Item26 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel26 | ||
| { | ||
| public required DeeplyNestedLevel27 Item27 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel27 | ||
| { | ||
| public required DeeplyNestedLevel28 Item28 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel28 | ||
| { | ||
| public required DeeplyNestedLevel29 Item29 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel29 | ||
| { | ||
| public required DeeplyNestedLevel30 Item30 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel30 | ||
| { | ||
| public required DeeplyNestedLevel31 Item31 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel31 | ||
| { | ||
| public required DeeplyNestedLevel32 Item32 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel32 | ||
| { | ||
| public required DeeplyNestedLevel33 Item33 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel33 | ||
| { | ||
| public required DeeplyNestedLevel34 Item34 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel34 | ||
| { | ||
| public required DeeplyNestedLevel35 Item35 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel35 | ||
| { | ||
| public required DeeplyNestedLevel36 Item36 { get; set; } | ||
| } | ||
|
|
||
| public class DeeplyNestedLevel36 | ||
| { | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This helps us avoid generating XML comments for non-public types and internal properties in non-public types.
Note: this does mean that DTOs have to be defined as public types if they are defined in the same assembly as the API (see where this is called in the
AssemnlyTypeSymbolVisitorabove). We can consider changing this behavior to allow XML comments on internal types in the application assembly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems a bit overaggressive. I'm guessing we'll change this behavior a bit in the future.
Any reason to disallow the type entirely just because it has internal types?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just hit this error in preview 2:
This relates to a
privatenested class inpublicclass that has some///comments on theinternal const stringmembers in it.Would this change fix that scenario too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more scenario for you - seems like it's trying to document things to do with the Regex source generator (example):
If not catered for by this change, I can open a new issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It depends on whether the type in question is defined in or outside the assembly.
I believe these bits have landed in the nightly preview3 SDK if you want to take another bump to try it out.
Alternatively, I'd recommend filing an issue so we can at least capture this scenario in a test case even if it is already fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll try out a nightly tomorrow and see if you think it should be fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirmed these two are catered for as of
10.0.100-preview.3.25169.19, but confirmed #61019 is still an issue and found two new ones 😅. Issues shortly...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think they're probably the same one issue: #61035
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, I'd recommend filing an issue so we can at least capture this scenario in a test case even if it is already fixed.
Found a different case where a private type causes a compiler error.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#61037