You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: azure/Guidelines.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,20 +26,17 @@ Please ensure that you add an anchor tag to any new guidelines that you add and
26
26
27
27
## Introduction
28
28
29
-
These guidelines offer prescriptive guidance that Azure service teams MUST follow ensuring that customers have a great experience by designing APIs meeting these goals:
29
+
These guidelines apply to Azure service teams implementing _data plane_ APIs. They offer prescriptive guidance that Azure service teams MUST follow ensuring that customers have a great experience by designing APIs meeting these goals:
30
30
- Developer friendly via consistent patterns & web standards (HTTP, REST, JSON)
31
31
- Efficient & cost-effective
32
32
- Work well with SDKs in many programming languages
33
33
- Customers can create fault-tolerant apps by supporting retries/idempotency/optimistic concurrency
34
34
- Sustainable & versionable via clear API contracts with 2 requirements:
35
35
1. Customer workloads must never break due to a service change
36
36
2. Customers can adopt a version without requiring code changes
37
+
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. Please read the [Considerations for Service Design](./ConsiderationsForServiceDesign.md) for an introduction to the topic of API design for Azure services. *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.*
37
38
38
-
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.
39
-
40
-
See the [Considerations for Service Design](./ConsiderationsForServiceDesign.md) for an introduction to the topic of API design for Azure services.
41
-
42
-
*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.*
39
+
*Note: If you are creating a management planen (ARM) API, please refer to the [Azure Resource Manager Resource Provider Contract](https://github.com/Azure/azure-resource-manager-rpc).*
43
40
44
41
### Prescriptive Guidance
45
42
This document offers prescriptive guidance labeled as follows:
0 commit comments