.Net: Prepare OpenAPI model collection properties to be modifiable. #9735
Conversation
This file contains 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
SergeyMenshykh
temporarily deployed
to
integration
GitHub Actions
Inactive
dmytrostruk
approved these changes
Nov 18, 2024
markwallace-microsoft
approved these changes
Nov 18, 2024
markwallace-microsoft
added
the
kernel
SergeyMenshykh
temporarily deployed
to
integration
GitHub Actions
Inactive
SergeyMenshykh
temporarily deployed
to
integration
GitHub Actions
Inactive
SergeyMenshykh
temporarily deployed
to
integration
GitHub Actions
Inactive
SergeyMenshykh
temporarily deployed
to
integration
GitHub Actions
Inactive
SergeyMenshykh
temporarily deployed
to
integration
GitHub Actions
Inactive
markwallace-microsoft
approved these changes
Nov 19, 2024
SergeyMenshykh
deleted the
change-type-of-openapi-model-collection-props
branch
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.
Motivation, Context and Description
Currently, OpenAPI model classes use a read-only version of list and dictionary types as types for collection properties. This is sufficient for now, but it could become a breaking change later when they need to be modifiable. In that case, they will have to be changed to non-read-only types - specifically, IList and IDictionary<TK, TV>. This PR changes all the collection properties to be modifiable by altering their types to IList and IDictionary<TK, TV>.
The RestApiSecurityRequirement model class is not completely freezeable at the moment and needs to be refactored to implement the IDictionary interface instead of inheriting from Dictionary. This change will allow for intercepting mutation calls and throwing an exception if the class is frozen.Contributes to: #6884