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
If you discover a problem with a REST API document in this repo, feel free to [open an issue](https://github.com/Azure/azure-rest-api-specs/issues/new). But please do not report issues with service behavior / functionality in this repo.
28
29
@@ -40,7 +41,7 @@ There is a [YouTube video series](https://www.youtube.com/watch?v=9Ng00IlBCtw) b
40
41
41
42
Another resource is the [Considerations for Service Design](https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md), which is an introduction to REST API design mainly for services that are just getting started.
42
43
43
-
### Exceptions for consistency within a service
44
+
### Exceptions for Consistency within a Service
44
45
45
46
There are situations where a service has GA'd their API with design patterns that do not follow our guidelines and it would be a breaking change to adopt the API design in the guidelines.
46
47
Because the first rule is to avoid breaking changes and because we want APIs to be consistent within a service, these design patterns are considered the standard for that service and should be followed in all subsequent (non-breaking) versions of that service's REST API.
@@ -70,7 +71,7 @@ If you want to contribute to the repository, follow these steps:
70
71
71
72
Microsoft employees can try out the experience at [OpenAPI Hub](https://aka.ms/openapihub) for [adding a new API version using OpenAPI Hub](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version).
72
73
73
-
## Pull Request checks
74
+
## Pull Request Checks
74
75
75
76
Every PR in this repo will go through a series of PR checks, including:
76
77
@@ -90,3 +91,10 @@ Every PR in this repo will go through a series of PR checks, including:
90
91
91
92
When any of these PR checks fails it will post a comment to the PR with links to information on how to resolve the problem.
92
93
There is also the [CI Fix Guide](https://aka.ms/ci-fix) that describes how to fix common PR check failures.
94
+
95
+
## Internal Contribution Guide
96
+
For management plane, please refer to https://aka.ms/rpguidelines;
97
+
98
+
For data-plane, please refer to [Guide to design and creation of Data Plane REST API and Client Libraries](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/591/Guide-to-design-and-creation-of-Data-Plane-REST-API-and-Client-Libraries);
99
+
100
+
For contribution access to spec repos, please refer to [Public repo vs. Private repo: To get write access](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/202/Overall-Process-of-Management-Plane-SDK-Onboarding?anchor=2.-create/update-the-openapi-specifications%2C-and-launch-swagger-pr-review)
0 commit comments