Skip to content

Commit c0343cf

Browse files
committed
Update history
1 parent cf971ff commit c0343cf

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

azure/ConsiderationsForServiceDesign.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
## Considerations for Service Design
2+
### History
3+
4+
| Date | Notes |
5+
| ----------- | -------------------------------------------------------------- |
6+
| 2021-Aug-06 | Updated Azure REST Guidelines per Azure API Stewardship Board. |
7+
8+
### Introduction
29

310
Great APIs make your service usable to customers. They are intuitive, naturally reflecting and communicating the underlying model and its behavior. They lend themselves easily to client library implementations in multiple programming languages. And they don't "get in the way" of the developer, by remaining stable and predictable, _especially over time_.
411

azure/Guidelines.md

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

4-
| Date | Version | Notes |
5-
| ----------- | ------- | --------------------------------------------------- |
6-
| 2021-Jul-02 | vNext-RC1 | Updated Azure REST Guidelines. |
7-
| 2020-Jul-31 | v3.2 | Added service advice for initial versions |
8-
| 2020-Mar-31 | v3.1 | 1st public release of the Azure REST API Guidelines |
4+
| Date | Notes |
5+
| ----------- | -------------------------------------------------------------- |
6+
| 2021-Aug-06 | Updated Azure REST Guidelines per Azure API Stewardship Board. |
7+
| 2020-Jul-31 | Added service advice for initial versions |
8+
| 2020-Mar-31 | 1st public release of the Azure REST API Guidelines |
99

1010
## Introduction
1111

@@ -20,6 +20,8 @@ These guidelines offer prescriptive guidance that Azure service teams MUST follo
2020

2121
Technology and software is constantly changing and evolving, and as such, this is intended to be a living document. [Open an issue](https://github.com/microsoft/api-guidelines/issues/new/choose) to suggest a change or propose a new idea.
2222

23+
See the [Considerations for Service Design](./ConsiderationsForServiceDesign.md) for an introduction to the topic of API design for Azure services.
24+
2325
*NOTE: For an existing GA'd service, don't change/break its existing API; instead, leverage these concepts for future APIs while prioritizing consistency within your existing service.*
2426

2527
### Prescriptive Guidance

0 commit comments

Comments
 (0)