Skip to content

Commit

Permalink
Enable custom query validato into SelectExpandQueryValidator (#800)
Browse files Browse the repository at this point in the history 
* Enable custom query validato into SelectExpandQueryValidator

* Update src/Microsoft.AspNetCore.OData/Query/Validator/SelectExpandQueryValidator.cs

Co-authored-by: John Gathogo <john.gathogo@microsoft.com>

* Address the comments

* Fix the build warnings

Co-authored-by: John Gathogo <john.gathogo@microsoft.com>
  • Loading branch information
@xuzhg @gathogojr
xuzhg and gathogojr authored Jan 18, 2023
1 parent b8cafe9 commit b90269b
Show file tree
Hide file tree
Showing 10 changed files with 832 additions and 239 deletions.
172 changes: 168 additions & 4 deletions src/Microsoft.AspNetCore.OData/Microsoft.AspNetCore.OData.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11889,14 +11889,39 @@
<param name="orderByOption">The $orderby query.</param>
<param name="validationSettings">The validation settings.</param>
</member>
<member name="T:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator">
<member name="T:Microsoft.AspNetCore.OData.Query.Validator.QueryValidatorContext">
<summary>
Represents a validator used to validate a <see cref="T:Microsoft.AspNetCore.OData.Query.SelectExpandQueryOption" /> based on the <see cref="T:Microsoft.AspNetCore.OData.Query.Validator.ODataValidationSettings"/>.
The base for validator context.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.OData.Query.Validator.QueryValidatorContext.Context">
<summary>
The Query context.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.OData.Query.Validator.QueryValidatorContext.ValidationSettings">
<summary>
The Query validation settings.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.OData.Query.Validator.QueryValidatorContext.Property">
<summary>
The applied property, It could be null.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.OData.Query.Validator.QueryValidatorContext.StructuredType">
<summary>
The applied strutured type.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.OData.Query.Validator.QueryValidatorContext.CurrentDepth">
<summary>
The current depth.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.#ctor">
<member name="T:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator" /> class
Represents a validator used to validate a <see cref="T:Microsoft.AspNetCore.OData.Query.SelectExpandQueryOption" /> based on the <see cref="T:Microsoft.AspNetCore.OData.Query.Validator.ODataValidationSettings"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.Validate(Microsoft.AspNetCore.OData.Query.SelectExpandQueryOption,Microsoft.AspNetCore.OData.Query.Validator.ODataValidationSettings)">
Expand All @@ -11906,6 +11931,145 @@
<param name="selectExpandQueryOption">The $select and $expand query.</param>
<param name="validationSettings">The validation settings.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateSelectExpand(Microsoft.OData.UriParser.SelectExpandClause,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates all select and expand items in $select and $expand.
For example, ~/Customers?$expand=Nav($expand=subNav;$select=Prop;$top=2)&amp;$select=Addresses($select=City;$top=1)
</summary>
<param name="selectExpandClause">The $select and $expand clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateExpandedNavigationSelectItem(Microsoft.OData.UriParser.ExpandedNavigationSelectItem,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates one $expand. For example, ~/Customers?$expand=Nav($expand=subNav;$select=Prop;$top=2)
</summary>
<param name="expandItem">One $expand clause.</param>
<param name="validatorContext">The validator context.</param>
<exception cref="T:Microsoft.OData.ODataException">The thrown exception.</exception>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateExpandedCountSelectItem(Microsoft.OData.UriParser.ExpandedCountSelectItem,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates one expand count. For example, ~/Customers?$expand=Nav/$count
</summary>
<param name="expandCountItem">The expand count item.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateExpandedReferenceSelectItem(Microsoft.OData.UriParser.ExpandedReferenceSelectItem,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates one expand reference. For example, ~/Customers?$expand=Nav/$ref
</summary>
<param name="expandReferItem">The expand reference item.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidatePathSelectItem(Microsoft.OData.UriParser.PathSelectItem,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $select. For example, ~/Customers?$select=Prop($select=SubProp;$top=2)
</summary>
<param name="pathSelectItem">The $select item.</param>
<param name="validatorContext">The validator context.</param>
<exception cref="T:Microsoft.OData.ODataException">The thrown exception.</exception>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateWildcardSelectItem(Microsoft.OData.UriParser.WildcardSelectItem,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $select wildcard. For example, ~/Customers?$select=*
</summary>
<param name="wildCardSelectItem">The wildcard select item.</param>
<param name="validatorContext">The validator context.</param>
<exception cref="T:Microsoft.OData.ODataException">The thrown exception.</exception>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNamespaceQualifiedWildcardSelectItem(Microsoft.OData.UriParser.NamespaceQualifiedWildcardSelectItem,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $select namespace wildcard. For example, ~/Customers?$select=NS.*
</summary>
<param name="namespaceQualifiedWildcardSelectItem">The namespace wildcard select item.</param>
<param name="validatorContext">The validator context.</param>
<exception cref="T:Microsoft.OData.ODataException">The thrown exception.</exception>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedFilter(Microsoft.OData.UriParser.FilterClause,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $filter within $select or $expand
</summary>
<param name="filterClause">The nested $filter clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedOrderby(Microsoft.OData.UriParser.OrderByClause,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $orderby within $select or $expand
</summary>
<param name="orderByClause">The nested $orderby clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedTop(System.Nullable{System.Int64},Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $top within $select or $expand
</summary>
<param name="topOption">The nested $top clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedSkip(System.Nullable{System.Int64},Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $skip within $select or $expand
</summary>
<param name="skipOption">The nested $skip clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedCount(System.Nullable{System.Boolean},Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $count within $select or $expand
</summary>
<param name="countOption">The nested $count clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedLevels(Microsoft.OData.UriParser.LevelsClause,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $levels within $expand
</summary>
<param name="levelsClause">The nested $levels clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedSearch(Microsoft.OData.UriParser.SearchClause,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $search within $select or $expand
</summary>
<param name="searchClause">The nested $search clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedCompute(Microsoft.OData.UriParser.ComputeClause,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $compute within $expand
</summary>
<param name="computeClause">The nested $compute clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandQueryValidator.ValidateNestedApply(Microsoft.OData.UriParser.Aggregation.ApplyClause,Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext)">
<summary>
Validates $apply within $expand
</summary>
<param name="applyClause">The nested $apply clause.</param>
<param name="validatorContext">The validator context.</param>
</member>
<member name="T:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext">
<summary>
The metadata context for $select and $expand validator.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext.SelectExpand">
<summary>
The top level $select and $expand query option.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext.RemainingDepth">
<summary>
The remaining depth on property.
It's weird logic in current implementation. Need to improve it later.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.OData.Query.Validator.SelectExpandValidatorContext.Clone">
<summary>
Clone the context.
</summary>
<returns>The cloned context.</returns>
</member>
<member name="T:Microsoft.AspNetCore.OData.Query.Validator.SkipQueryValidator">
<summary>
Represents a validator used to validate a <see cref="T:Microsoft.AspNetCore.OData.Query.SkipQueryOption"/> based on the <see cref="T:Microsoft.AspNetCore.OData.Query.Validator.ODataValidationSettings"/>.
Expand Down
Loading

0 comments on commit b90269b

Please sign in to comment.