Skip to content

Commit 7bfc784

Browse files
committed
More updates for PR comments
1 parent 2f9b246 commit 7bfc784

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

azure/ConsiderationsForServiceDesign.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -499,13 +499,13 @@ When designing an API, you will almost certainly have to manage how your resourc
499499
Similarly, it could be very expensive to send a resource to a client. This could be because of its size, network conditions, or a myriad of other reasons.
500500
Both of these scenarios can be accomplished with conditional requests, where the client specifies a _precondition_
501501
for execution of a request, based on its last modification date or entity tag ("ETag").
502-
An Etag identifies a 'version' or 'instance' of a resource and is computed by the service and returned in an `ETag` response header for GET or other operations on the resource.
502+
An ETag identifies a 'version' or 'instance' of a resource and is computed by the service and returned in an `ETag` response header for GET or other operations on the resource.
503503

504504
### Cache Control
505505

506506
One of the more common uses for conditional requests is cache control. This is especially useful when resources are large in size, expensive to compute/calculate, or hard to reach (significant network latency).
507507
A client can make a "conditional GET request" for the resource, with a precondition header that requests that
508-
data be returned only when the version on the service does not match the Etag or last modified date in the header.
508+
data be returned only when the version on the service does not match the ETag or last modified date in the header.
509509
If there are no changes, then there is no need to return the resource, as the client already has the most recent version.
510510

511511
Implementing this strategy is relatively straightforward. First, you will return an `ETag` with a value that uniquely identifies the instance (or version) of the resource. The [Computing ETags](./Guidelines.md#computing-etags) section provides guidance on how to properly calculate the value of your `ETag`.
@@ -517,7 +517,7 @@ This tells the service to compare the `ETag` that came in with the request, with
517517
Optimistic concurrency is a strategy used in HTTP to avoid the "lost update" problem that can occur when multiple clients attempt to update a resource simultaneously.
518518
Clients can use ETags returned by the service to specify a _precondition_ for the execution of an update, to ensure that the resource has not been updated since the client last observed it.
519519
For example, the client can specify an `If-Match` header with the last ETag value received by the client in an update request.
520-
The service processes the update only if the Etag value in the header matches the ETag of the current resource on the server.
520+
The service processes the update only if the ETag value in the header matches the ETag of the current resource on the server.
521521
By computing and returning ETags for your resources, you enable clients to avoid using a strategy where the "last write always wins."
522522

523523
## Getting Help: The Azure REST API Stewardship Board

0 commit comments

Comments
 (0)