Skip to content

Commit 5bcbf0e

Browse files
author
Konrad Jamrozik
authored
ongoing (#25390)
1 parent 624dbc7 commit 5bcbf0e

File tree

3 files changed

+26
-5
lines changed

3 files changed

+26
-5
lines changed

.github/PULL_REQUEST_TEMPLATE/control_plane_template.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,17 @@ and followed the instructions by checking all the boxes:
5252
- If you want to force ARM review, add the label yourself.
5353
- Proceed according to the diagram at the top of this comment.
5454

55+
## Viewing API changes
56+
57+
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
58+
in the `Generated ApiView` comment added to this PR. You can use ApiView to show API versions diff.
59+
60+
## Suppressing failures
61+
62+
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
63+
[Swagger-Suppression-Process](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process)
64+
to get approval.
65+
5566
## Getting help
5667

5768
- For general PR approval workflow, see the diagram at the top of this comment.

.github/PULL_REQUEST_TEMPLATE/data_plane_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,23 @@ Is this review for (select one):
1313
- [ ] GA release
1414

1515
### Change Scope
16+
1617
<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 API Spec document (if applicable), and the root paths that have been updated. </sup>
1718
* Design Document:
1819
* Previous API Spec Doc:
1920
* Updated paths:
2021

22+
### Viewing API changes
23+
24+
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
25+
in the `Generated ApiView` comment added to this PR. You can use ApiView to show API versions diff.
26+
27+
### Suppressing failures
28+
29+
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
30+
[Swagger-Suppression-Process](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process)
31+
to get approval.
32+
2133
## ❔Got questions? Need additional info?? We are here to help!
2234

2335
<details>
@@ -33,16 +45,19 @@ The [Azure API Review Board](https://aka.ms/azsdk/onboarding/restapischedule) is
3345
<summary>Click here for links to tools, specs, guidelines & other good stuff</summary>
3446

3547
### Tooling
48+
3649
* [Open API validation tools](https://aka.ms/swaggertools) were run on this PR. Go here to see [how to fix errors](https://aka.ms/ci-fix)
3750
* [Spectral Linting](https://aka.ms/style)
3851
* [Open API Hub](https://aka.ms/openapiportal)
3952

4053
### Guidelines & Specifications
54+
4155
* [Azure REST API Guidelines](https://aka.ms/guidelines)
4256
* [OpenAPI Style Guidelines](https://aka.ms/style)
4357
* [Azure Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy)
4458

4559
### Helpful Links
60+
4661
* [Azure DevTools Wiki](https://aka.ms/azapi)
4762

4863
</details>

.github/comment.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
---
2-
- rule:
3-
type: label
4-
label: SuppressionReviewRequired
5-
onLabeledComments: "Hi @${PRAuthor}, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the [Swagger-Suppression-Process](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process) to get approval."
6-
72
- rule:
83
type: label
94
label: "CI-MissingBaseCommit"

0 commit comments

Comments
 (0)