Skip to content

Commit 608d8ae

Browse files
authored
Merge pull request #443 from microsoft/graph-azure-positioning
Clarifed the positioning of the MS Guidelines.
2 parents 99f99bc + 28bc3ef commit 608d8ae

File tree

2 files changed

+23
-16
lines changed

2 files changed

+23
-16
lines changed

Guidelines.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
> # NOTICE TO READERS
2+
>
3+
> ## **Guidance for Azure service teams**
4+
> Azure service teams should use the companion documents, [Azure REST API Guidelines](./azure/Guidelines.md) and [Considerations for Service Design](./azure/ConsiderationsForServiceDesign.md), when building or modifying their services. These documents provide a refined set of guidance targeted specifically for Azure services. For more information please refer to the [README](./azure/README.md) in the Azure folder.
5+
>
6+
> ## **Guidance for Microsoft Graph service teams**
7+
> Graph service teams should reference the companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services. This document and the associated pattern catalog provides a refined set of guidance targeted specifically for Microsoft Graph services.
8+
9+
---
10+
111
# Microsoft REST API Guidelines
212

313
## Microsoft REST API Guidelines Working Group
@@ -20,22 +30,13 @@ To provide the smoothest possible experience for developers on platforms followi
2030

2131
This document establishes the guidelines Microsoft REST APIs SHOULD follow so RESTful interfaces are developed consistently.
2232

23-
### **Guidance for Azure service teams**
24-
Azure service teams should use the companion documents, [Azure REST API Guidelines](./azure/Guidelines.md) and [Considerations for Service Design](./azure/ConsiderationsForServiceDesign.md), when building or modifying their services. These documents provide a refined set of guidance targeted specifically for Azure services. For more information please refer to the [README](./azure/README.md) in the Azure folder.
25-
26-
### **Guidance for Microsoft Graph service teams**
27-
Graph service teams should reference the companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services. This document and the associated pattern catalog provides a refined set of guidance targeted specifically for Microsoft Graph services.
28-
29-
3033
## 2. Table of contents
3134
<!-- TOC depthFrom:2 depthTo:4 orderedList:false updateOnSave:false withLinks:true -->
3235

3336
- [Microsoft REST API Guidelines](#microsoft-rest-api-guidelines)
3437
- [Microsoft REST API Guidelines Working Group](#microsoft-rest-api-guidelines-working-group)
3538
- [Microsoft REST API Guidelines](#microsoft-rest-api-guidelines-1)
3639
- [1. Abstract](#1-abstract)
37-
- [**Guidance for Azure service teams**](#guidance-for-azure-service-teams)
38-
- [**Guidance for Microsoft Graph service teams**](#guidance-for-microsoft-graph-service-teams)
3940
- [2. Table of contents](#2-table-of-contents)
4041
- [3. Introduction](#3-introduction)
4142
- [3.1. Recommended reading](#31-recommended-reading)

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
1-
# Microsoft REST API Guidelines
1+
> # NOTICE TO READERS
2+
>
3+
> ## Guidance for Azure service teams
4+
> Azure service teams should use companion documents, [Azure REST API Guidelines](./azure/Guidelines.md) and [Considerations for Service Design](./azure/ConsiderationsForServiceDesign.md), when building or modifying their services. These documents provide a refined set of guidance targeted specifically for Azure services. For more information please refer to the [README](./azure/README.md) in the Azure folder.
5+
>
6+
> ## Guidance for Microsoft Graph service teams
7+
> Microsoft Graph service teams should reference the companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services.
8+
>
9+
> In the process of building many of Microsoft's highest scale services, the Microsoft Graph team found the Microsoft API guidelines tremendously useful as a baseline. However, there are several areas where we need to provide more clarity on how developers should describe their APIs. The companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) is a set of amendments and clarifications for Microsoft Graph that act as further reading. Recognizing that two documents is a lot for a new API designer to absorb, our plan is to follow the approach Azure have taken and roll out guidelines for Microsoft Graph into a single consolidated document.
10+
11+
---
12+
13+
## Microsoft REST API Guidelines
214
The [Microsoft REST API Guidelines](Guidelines.md) are Microsoft's internal company-wide REST API design guidelines.
315
Teams at Microsoft typically reference this document when setting API design policy.
416
They may additionally create documents specific to their team, adding further guidance or making adjustments as appropriate to their circumstances.
517

618
We publish these guidelines here with the aim of fostering dialogue and learning in the API community at large.
719
We further hope that these guidelines may encourage other organizations to create guidelines that are appropriate for them and in turn, if they are able, to publish theirs.
820

9-
### Guidance for Azure service teams
10-
Azure service teams should use companion documents, [Azure REST API Guidelines](./azure/Guidelines.md) and [Considerations for Service Design](./azure/ConsiderationsForServiceDesign.md), when building or modifying their services. These documents provide a refined set of guidance targeted specifically for Azure services. For more information please refer to the [README](./azure/README.md) in the Azure folder.
11-
12-
### Guidance for Microsoft Graph service teams
13-
Graph service teams should reference the companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services. This document and the associated pattern catalog provides a refined set of guidance targeted specifically for Microsoft Graph services.
14-
1521
[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
1622

1723
## Code of Conduct

0 commit comments

Comments
 (0)