Skip to content

Commit 956726c

Browse files
authored
Remove extraneous backticks around filter (#502)
1 parent 17e9b00 commit 956726c

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

azure/Guidelines.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -589,23 +589,23 @@ Parameter name | Type | Description
589589

590590
<a href="#collections-query-options-no-dollar-sign" name="collections-query-options-no-dollar-sign">:no_entry:</a> **DO NOT** prefix any of these query parameter names with "$" (the convention in the [OData standard](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_QueryingCollections)).
591591

592-
#### `filter`
592+
#### filter
593593

594-
<a href="#collections-filter-param" name="collections-filter-param">:heavy_check_mark:</a> **YOU MAY** support `filter`ing of the results of a list operation with the `filter` query parameter.
594+
<a href="#collections-filter-param" name="collections-filter-param">:heavy_check_mark:</a> **YOU MAY** support filtering of the results of a list operation with the `filter` query parameter.
595595

596-
The value of the `filter` option is an expression involving the fields of the resource that produces a Boolean value. This expression is evaluated for each resource in the collection and only items where the expression evaluates to true are included in the response.
596+
The value of the `filter` query parameter is an expression involving the fields of the resource that produces a Boolean value. This expression is evaluated for each resource in the collection and only items where the expression evaluates to true are included in the response.
597597

598-
<a href="#collections-filter-behavior" name="collections-filter-behavior">:white_check_mark:</a> **DO** omit all resources from the collection for which the `filter` expression evaluates to false or to null, or references properties that are unavailable due to permissions.
598+
<a href="#collections-filter-behavior" name="collections-filter-behavior">:white_check_mark:</a> **DO** omit all resources from the collection for which the filter expression evaluates to false or to null, or references properties that are unavailable due to permissions.
599599

600600
Example: return all Products whose Price is less than $10.00
601601

602602
```text
603-
GET https://api.contoso.com/products?`filter`=price lt 10.00
603+
GET https://api.contoso.com/products?filter=price lt 10.00
604604
```
605605

606-
##### `filter` operators
606+
##### filter operators
607607

608-
:heavy_check_mark: **YOU MAY** support the following operators in `filter` expressions:
608+
:heavy_check_mark: **YOU MAY** support the following operators in filter expressions:
609609

610610
Operator | Description | Example
611611
-------------------- | --------------------- | -----------------------------------------------------
@@ -623,9 +623,9 @@ not | Logical negation | not price le 3.5
623623
**Grouping Operators** | |
624624
( ) | Precedence grouping | (priority eq 1 or city eq 'Redmond') and price gt 100
625625

626-
<a href="#collections-filter-unknown-operator" name="collections-filter-unknown-operator">:white_check_mark:</a> **DO** respond with an error message as defined in the [Handling Errors](#handling-errors) section if a client includes an operator in a `filter` expression that is not supported by the operation.
626+
<a href="#collections-filter-unknown-operator" name="collections-filter-unknown-operator">:white_check_mark:</a> **DO** respond with an error message as defined in the [Handling Errors](#handling-errors) section if a client includes an operator in a filter expression that is not supported by the operation.
627627

628-
<a href="#collections-filter-operator-ordering" name="collections-filter-operator-ordering">:white_check_mark:</a> **DO** use the following operator precedence for supported operators when evaluating `filter` expressions. Operators are listed by category in order of precedence from highest to lowest. Operators in the same category have equal precedence and should be evaluated left to right:
628+
<a href="#collections-filter-operator-ordering" name="collections-filter-operator-ordering">:white_check_mark:</a> **DO** use the following operator precedence for supported operators when evaluating filter expressions. Operators are listed by category in order of precedence from highest to lowest. Operators in the same category have equal precedence and should be evaluated left to right:
629629

630630
| Group | Operator | Description
631631
| ----------------|----------|------------
@@ -640,39 +640,39 @@ not | Logical negation | not price le 3.5
640640
| Conditional AND | and | Logical And |
641641
| Conditional OR | or | Logical Or |
642642

643-
<a href="#collections-filter-functions" name="collections-filter-functions">:heavy_check_mark:</a> **YOU MAY** support orderby and `filter` functions such as concat and contains. For more information, see [odata Canonical Functions](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31360979).
643+
<a href="#collections-filter-functions" name="collections-filter-functions">:heavy_check_mark:</a> **YOU MAY** support orderby and filter functions such as concat and contains. For more information, see [odata Canonical Functions](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31360979).
644644

645645
##### Operator examples
646646
The following examples illustrate the use and semantics of each of the logical operators.
647647

648648
Example: all products with a name equal to 'Milk'
649649

650650
```text
651-
GET https://api.contoso.com/products?`filter`=name eq 'Milk'
651+
GET https://api.contoso.com/products?filter=name eq 'Milk'
652652
```
653653

654654
Example: all products with a name not equal to 'Milk'
655655

656656
```text
657-
GET https://api.contoso.com/products?`filter`=name ne 'Milk'
657+
GET https://api.contoso.com/products?filter=name ne 'Milk'
658658
```
659659

660660
Example: all products with the name 'Milk' that also have a price less than 2.55:
661661

662662
```text
663-
GET https://api.contoso.com/products?`filter`=name eq 'Milk' and price lt 2.55
663+
GET https://api.contoso.com/products?filter=name eq 'Milk' and price lt 2.55
664664
```
665665

666666
Example: all products that either have the name 'Milk' or have a price less than 2.55:
667667

668668
```text
669-
GET https://api.contoso.com/products?`filter`=name eq 'Milk' or price lt 2.55
669+
GET https://api.contoso.com/products?filter=name eq 'Milk' or price lt 2.55
670670
```
671671

672672
Example: all products that have the name 'Milk' or 'Eggs' and have a price less than 2.55:
673673

674674
```text
675-
GET https://api.contoso.com/products?`filter`=(name eq 'Milk' or name eq 'Eggs') and price lt 2.55
675+
GET https://api.contoso.com/products?filter=(name eq 'Milk' or name eq 'Eggs') and price lt 2.55
676676
```
677677

678678
#### orderby
@@ -705,15 +705,15 @@ For example, to return all people sorted by name in descending order and a secon
705705
GET https://api.contoso.com/people?orderby=name desc,hireDate
706706
```
707707

708-
Sorting MUST compose with `filter`ing such that:
708+
Sorting MUST compose with filtering such that:
709709
```text
710-
GET https://api.contoso.com/people?`filter`=name eq 'david'&orderby=hireDate
710+
GET https://api.contoso.com/people?filter=name eq 'david'&orderby=hireDate
711711
```
712712
will return all people whose name is David sorted in ascending order by hireDate.
713713

714714
##### Considerations for sorting with pagination
715715

716-
<a href="#collections-consistent-options-with-pagination" name="collections-consistent-options-with-pagination">:white_check_mark:</a> **DO** use the same `filter`ing options and sort order for all pages of a paginated list operation response.
716+
<a href="#collections-consistent-options-with-pagination" name="collections-consistent-options-with-pagination">:white_check_mark:</a> **DO** use the same filtering options and sort order for all pages of a paginated list operation response.
717717

718718
##### skip
719719
<a href="#collections-skip-param-definition" name="collections-skip-param-definition">:white_check_mark:</a> **DO** define the `skip` parameter as an integer with a default and minimum value of 0.

0 commit comments

Comments
 (0)