Skip to content

Commit eb46156

Browse files
JeffreyRichtermikekistler
authored andcommitted
Update Etag guideline for collection values
1 parent e114751 commit eb46156

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

azure/Guidelines.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -543,16 +543,16 @@ NOTE: It is a breaking change to add paging in the future
543543
```json
544544
{
545545
"value": [
546-
{ "id": "Item 01", "etag": "0xabc", "price": 99.95, "sizes": null },
546+
{ "id": "Item 01", "etag": "\"abc\"", "price": 99.95, "sizes": null },
547547
{ },
548548
{ },
549-
{ "id": "Item 99", "etag": "0xdef", "price": 59.99, "sizes": null }
549+
{ "id": "Item 99", "etag": "\"def\"", "price": 59.99, "sizes": null }
550550
],
551551
"nextLink": "{opaqueUrl}"
552552
}
553553
```
554554

555-
<a href="#collections-items-have-id-and-etag" name="collections-items-have-id-and-etag">:white_check_mark:</a> **DO** include the _id_ field and _etag_ field (if supported) for each item as this allows the customer to modify the item in a future operation.
555+
<a href="#collections-items-have-id-and-etag" name="collections-items-have-id-and-etag">:white_check_mark:</a> **DO** include the _id_ field and _etag_ field (if supported) for each item as this allows the customer to modify the item in a future operation. Note that the tag field _must_ have escaped-quotes embedded within it; for example "\"abc\"" or W/"\"abc\"".
556556

557557
<a href="#collections-document-pagination-reliability" name="collections-document-pagination-reliability">:white_check_mark:</a> **DO** clearly document that resources may be skipped or duplicated across pages of a paginated collection unless the operation has made special provisions to prevent this (like taking a time-expiring snapshot of the collection).
558558

0 commit comments

Comments
 (0)