|
1 | | -<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 | | -</i> |
| 1 | +# Choose a PR Template |
3 | 2 |
|
4 | | -### Changelog |
5 | | -Add a changelog entry for this PR by answering the following questions: |
6 | | - 1. What's the purpose of the update? |
7 | | - - [ ] new service onboarding |
8 | | - - [ ] new API version |
9 | | - - [ ] update existing version for new feature |
10 | | - - [ ] update existing version to fix swagger quality issue in s360 |
11 | | - - [ ] Other, please clarify |
12 | | - 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. |
13 | | - 3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. |
14 | | - 4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published. |
15 | | - - [ ] SDK of .NET (need service team to ensure code readiness) |
16 | | - - [ ] SDK of Python |
17 | | - - [ ] SDK of Java |
18 | | - - [ ] SDK of Js |
19 | | - - [ ] SDK of Go |
20 | | - - [ ] PowerShell |
21 | | - - [ ] CLI |
22 | | - - [ ] Terraform |
23 | | - - [ ] No refresh required for updates in this PR |
| 3 | +Switch to "Preview" on this description then select one of the choices below. |
24 | 4 |
|
25 | | -### Contribution checklist: |
26 | | -- [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/bcforapi) of "no breaking changes" |
27 | | -- [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow. |
28 | | -- [ ] [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) |
| 5 | +<a href="?expand=1&template=data_plane_template.md">Click here</a> to open a PR for a Data Plane API. |
29 | 6 |
|
30 | | -If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). |
31 | | - |
32 | | -### ARM API Review Checklist |
33 | | - |
34 | | -> **Applicability**: :warning: |
35 | | -> |
36 | | -> If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review. |
37 | | -> - Change to data plane APIs |
38 | | -> - Adding new properties |
39 | | -> - All removals |
40 | | -
|
41 | | -Otherwise your PR may be subject to ARM review requirements. Complete the following: |
42 | | -- [ ] Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment. |
43 | | - - Adding a new service |
44 | | - - Adding new API(s) |
45 | | - - Adding a new API version |
46 | | - -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the [wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version). |
47 | | - |
48 | | -- [ ] 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. |
49 | | - |
50 | | -- [ ] 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. |
51 | | - |
52 | | -### Breaking Change Review Checklist |
53 | | -If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi). |
54 | | -- [ ] Removing API(s) in a stable version |
55 | | -- [ ] Removing properties in a stable version |
56 | | -- [ ] Removing API version(s) in a stable version |
57 | | -- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors |
58 | | -- [ ] Updating API(s) in public preview over 1 year (refer to [Retirement of Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews)) |
59 | | - |
60 | | -**Action**: to initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Addition 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). |
61 | | - |
62 | | -Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview). |
| 7 | +<a href="?expand=1&template=control_plane_template.md">Click here</a> to open a PR for a Control Plane (ARM) API. |
0 commit comments