Use CRUD restrictions annotations for the generation of complex properties' paths #180
Conversation
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
…complex property paths
baywet
requested changes
Feb 22, 2022
src/Microsoft.OpenApi.OData.Reader/PathItem/ComplexPropertyItemHandler.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.OpenApi.OData.Reader/PathItem/ComplexPropertyItemHandler.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.OpenApi.OData.Reader/PathItem/ComplexPropertyItemHandler.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.OpenApi.OData.Reader/PathItem/ComplexPropertyItemHandler.cs
Outdated
Show resolved
Hide resolved
baywet
approved these changes
Feb 22, 2022
xuzhg
reviewed
Feb 22, 2022
| /// <summary> | ||
| /// Gets/Sets a value indicating whether or not to use restrictions annotations to generate paths for complex properties. | ||
| /// </summary> | ||
| public bool UseRestrictionAnnotationsToGeneratePathsForComplexProperties { get; set; } = true; |
There was a problem hiding this comment.
UseRestrictionAnnotationsToGenerateComplexPropertyPaths
There was a problem hiding this comment.
by default, it should be "false" right?
There was a problem hiding this comment.
I agree this is a better name: UseRestrictionAnnotationsToGenerateComplexPropertyPaths
There was a problem hiding this comment.
by default, it should be "false" right?
Please refer to the discussion in the issue: #176
xuzhg
reviewed
Feb 22, 2022
| @@ -1,90 +0,0 @@ | |||
| // ------------------------------------------------------------ | |||
There was a problem hiding this comment.
why delete?
Same as above, the reason has been mentioned in the issue: #176
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.
Fixes #176
This PR
UseRestrictionAnnotationsToGeneratePathsForComplexPropertieswhich defaults totruethat will be used as a flag to determine whether or not to use CRUD restrictions annotations for the generation of paths for complex properties. When this istrue, generation will look for the specific CRUD restriction annotation to determine whether readability, or updatability or insertability is enabled (by setting their values totrue). IfUseRestrictionAnnotationsToGeneratePathsForComplexPropertiesisfalse, paths for complex properties are generated by default without inspecting the CRUD restrictions annotations. This happens in theODataPathProvider.csclass when generating paths and in theComplexPropertyItemHandler.csclass when generating the path item operations.