Skip to content

Commit e4cc4b3

Browse files
committed
Further improve guidance on api-version
1 parent d117061 commit e4cc4b3

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

azure/ConsiderationsForServiceDesign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
| Date | Notes |
88
| ----------- | -------------------------------------------------------------- |
9-
| 2022-Jun-08 | Update guidance on long-running operations |
9+
| 2022-Jul-15 | Update guidance on long-running operations |
1010
| 2022-Feb-01 | Updated error guidance |
1111
| 2021-Sep-11 | Add long-running operations guidance |
1212
| 2021-Aug-06 | Updated Azure REST Guidelines per Azure API Stewardship Board. |

azure/Guidelines.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Microsoft Azure REST API Guidelines
22

3-
<!-- cspell:ignore autorest, etag, idempotency, maxpagesize, innererror -->
3+
<!-- cspell:ignore autorest, BYOS, etag, idempotency, maxpagesize, innererror -->
44

55
## History
66

77
| Date | Notes |
88
| ----------- | -------------------------------------------------------------- |
9-
| 2022-Jun-08 | Update guidance on long-running operations |
9+
| 2022-Jul-15 | Update guidance on long-running operations |
1010
| 2022-May-11 | Drop guidance on version discovery |
1111
| 2022-Mar-29 | Add guidelines about using durations |
1212
| 2022-Mar-25 | Update guideline for date values in headers to follow RFC 7231 |
@@ -698,7 +698,11 @@ Azure services need to change over time. However, when changing a service, there
698698

699699
:white_check_mark: **DO** review any API changes with the Azure API Stewardship Board
700700

701-
:white_check_mark: **DO** use an `api-version` query parameter with a `YYYY-MM-DD` date value, with a `-preview` suffix for a preview service.
701+
Clients specify the version of the API to be used in every request to the service, even requests to an `Operation-Location` or `nextLink` URL returned by the service.
702+
703+
:white_check_mark: **DO** use a required query parameter named `api-version` on every operation for the client to specify the API version.
704+
705+
:white_check_mark: **DO** use `YYYY-MM-DD` date values, with a `-preview` suffix for preview versions, as the valid values for `api-version`.
702706

703707
```text
704708
PUT https://service.azure.com/users/Jeff?api-version=2021-06-04

0 commit comments

Comments
 (0)