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
<i>MSFT employees can try out our new experience at <b>[OpenAPI Hub](https://aka.ms/openapiportal) </b> - one location for using our validation tools and finding your workflow.
2
+
3
+
<i>MSFT employees can try out our new experience at <b>[OpenAPI Hub](https://aka.ms/openapiportal) </b> - one location for using our validation tools and finding your workflow.
4
4
</i>
5
5
6
6
### Changelog
@@ -13,22 +13,22 @@ Add a changelog entry for this PR by answering the following questions:
13
13
-[ ] Other, please clarify
14
14
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
15
15
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
16
-
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
16
+
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
17
17
18
18
### Contribution checklist (MS Employees Only):
19
-
-[ ] I commit to follow the [Breaking Change Policy](http://aka.ms/AzBreakingChangesPolicy) of "no breaking changes"
19
+
-[ ] I commit to follow the [Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy) of "no breaking changes"
20
20
-[ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow.
21
21
-[ ][Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and errors have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix)
22
22
23
23
If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview).
24
24
25
-
### ARM API Review Checklist
25
+
### ARM API Review Checklist
26
26
27
-
> **Applicability**: :warning:
27
+
> **Applicability**: :warning:
28
28
>
29
29
> If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
30
-
> - Change to data plane APIs
31
-
> - Adding new properties
30
+
> - Change to data plane APIs
31
+
> - Adding new properties
32
32
> - All removals
33
33
34
34
Otherwise your PR may be subject to ARM review requirements. Complete the following:
@@ -40,14 +40,13 @@ Otherwise your PR may be subject to ARM review requirements. Complete the follow
40
40
41
41
-[ ] Ensure you've reviewed following [guidelines](https://aka.ms/rpguidelines) including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md). Estimated time (4 hours). This is required before you can request review from ARM API Review board.
42
42
43
-
-[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under <ins>Azure Resource Manager service</ins>) from IcM and reach out to them.
43
+
-[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under <ins>Azure Resource Manager service</ins>) from IcM and reach out to them.
44
+
45
+
### Breaking Change Review Checklist
46
+
If you have any breaking changes as defined in the [Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy/), request approval from the Breaking Change Review Board.
44
47
45
-
### Breaking Change Review Checklist
46
-
If you have any breaking changes as defined in the [Breaking Change Policy](http://aka.ms/AzBreakingChangesPolicy/), request approval from the Breaking Change Review Board.
47
-
48
48
**Action**: to initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Additional details on the process and office hours are on the [Breaking Change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes).
49
-
49
+
50
50
NOTE: To update API(s) in public preview for over 1 year (refer to [Retirement of Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews))
51
51
52
52
Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview).
<!-- 🚨🚨🚨 Replace this line with a summary and reason for these changes to your data plane API 🚨🚨🚨 -->
3
3
4
4
## API Info: The Basics
5
5
Most of the information about your service should be captured in the issue that serves as your [*engagement record*](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/271/Azure-REST-API-Stewardship?anchor=rest-api-stewardship-process).
6
6
7
-
* Link to engagement record issue:
7
+
* Link to engagement record issue:
8
8
9
9
Is this review for (select one):
10
10
11
11
-[ ] a private preview
12
12
-[ ] a public preview
13
-
-[ ] GA release
13
+
-[ ] GA release
14
14
15
15
### Change Scope
16
16
<sup>This section will help us focus on the specific parts of your API that are new or have been modified. <br/>Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated. </sup>
17
-
* Design Document:
18
-
* Previous Open API Doc:
17
+
* Design Document:
18
+
* Previous Open API Doc:
19
19
* Updated paths:
20
-
21
-
## :grey_question:Got questions? Need additional info?? We are here to help!
20
+
21
+
## ❔Got questions? Need additional info?? We are here to help!
22
22
23
23
<details>
24
24
<summary> Contact us!</summary>
25
25
26
26
The [Azure API Review Board](https://aka.ms/azapi) is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our [wiki](https://aka.ms/azapi).
0 commit comments