Skip to content

Commit 0c743db

Browse files
author
Aman Jain
committed
Merge branch 'main' of https://github.com/Aman-Jain-14/rest-api-auto-export-spec into Aman-Jain-14/auto-export-spec-24-07-01
2 parents f516e0c + c3cc9ab commit 0c743db

File tree

3,983 files changed

+472749
-53383
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,983 files changed

+472749
-53383
lines changed

.devcontainer/Dockerfile

Lines changed: 0 additions & 21 deletions
This file was deleted.

.devcontainer/devcontainer.json

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
{
22
"name": "TypeSpec Dev Container",
3-
"build": {
4-
"dockerfile": "Dockerfile"
5-
},
6-
"remoteUser": "root"
7-
/*,
8-
update below source folder to your local sdk-repos folder
9-
"mounts": [
10-
"source=/home/rc/repos/tmp/sdk-repos,target=/workspaces/sdk-repos,type=bind,consistency=cached"
11-
]*/
12-
}
3+
"image": "mcr.microsoft.com/devcontainers/typescript-node:dev-20",
4+
// Default is 2 cores which is too slow for this codebase
5+
"hostRequirements": {"cpus": 4},
6+
"postCreateCommand": "npm ci",
7+
"customizations": {
8+
"vscode": {
9+
// Keep in sync with .vscode/extensions.json
10+
"extensions": [
11+
"EditorConfig.EditorConfig",
12+
"esbenp.prettier-vscode",
13+
"typespec.typespec-vscode",
14+
"docsmsft.docs-authoring-pack"
15+
]
16+
}
17+
}
18+
}
Binary file not shown.

.github/PULL_REQUEST_TEMPLATE/control_plane_template.md

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,11 @@
33
> [!TIP]
44
> Overwhelmed by all this guidance? See the `Getting help` section at the bottom of this PR description.
55
6-
> [!NOTE]
7-
> As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
8-
96
## PR review workflow diagram
107

118
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
129

13-
![diagram](https://github.com/Azure/azure-rest-api-specs/assets/20296335/9e51cff7-28f7-4ae7-99a3-0f4a116c759f)
14-
15-
<details>
16-
<summary>Click here to see the details of Step 1, Breaking Changes review</summary>
17-
18-
If you are in purview of Step 1 of the diagram, follow the [Breaking Changes review process].
19-
**IMPORTANT!** This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
20-
</details>
21-
22-
<details>
23-
<summary>Click here to see the details of Step 2, ARM review</summary>
24-
25-
See https://aka.ms/azsdk/pr-arm-review.
26-
</details>
27-
28-
<details>
29-
<summary> Click here to see the diagram footnotes</summary>
30-
31-
### Diagram footnotes
32-
33-
[1] See [ARM review queue] (for **PR merge** queues, see [2]).
34-
[2] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1])
35-
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
36-
37-
</details>
10+
![spec_pr_review_workflow_diagram](https://github.com/Azure/azure-rest-api-specs/assets/4429827/5bb5e7ce-8aff-4dbb-a3f8-0d9b68fef5b1)
3811

3912
## Purpose of this PR
4013

@@ -54,7 +27,7 @@ and followed the instructions by checking all the boxes:
5427

5528
- [ ] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
5629
- [ ] I have reviewed following [Resource Provider guidelines](https://aka.ms/rpguidelines), including
57-
[ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and
30+
[ARM resource provider contract](https://aka.ms/azurerpc) and
5831
[REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md) (estimated time: 4 hours).
5932
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
6033

@@ -78,15 +51,11 @@ If one or multiple validation error/warning suppression(s) is detected in your P
7851
## Getting help
7952

8053
- First, please carefully read through this PR description, from top to bottom. Please fill out the `Purpose of this PR` and `Due diligence checklist`.
54+
- If you don't have permissions to remove or add labels to the PR, request `write access` per [aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories](https://aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories")
8155
- To understand what you must do next to merge this PR, see the `Next Steps to Merge` comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
8256
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
8357
and https://aka.ms/ci-fix.
84-
- For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
58+
- For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
8559
- If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`.
8660
This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.
8761
- If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
88-
89-
[ARM review queue]: https://aka.ms/azsdk/pr-arm-review#about-the-arm-review-queue
90-
[public repo merge queue]: https://github.com/Azure/azure-rest-api-specs/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+label%3Aresource-manager+draft%3Afalse+sort%3Acreated-asc
91-
[private repo merge queue]: https://github.com/Azure/azure-rest-api-specs-pr/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+label%3Aresource-manager+-label%3AApproved-OkToMerge+draft%3Afalse+sort%3Acreated-asc
92-
[Breaking Changes review process]: https://aka.ms/brch

.github/PULL_REQUEST_TEMPLATE/data_plane_template.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
1-
# Data Plane API - Pull Request
1+
# Data Plane API Specification Update Pull Request
2+
3+
> [!TIP]
4+
> Overwhelmed by all this guidance? See the `Getting help` section at the bottom of this PR description.
5+
6+
27
<!-- 🚨🚨🚨 Replace this line with a summary and reason for these changes to your data plane API 🚨🚨🚨 -->
38

9+
## PR review workflow diagram
10+
11+
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
12+
13+
![spec_pr_review_workflow_diagram](https://github.com/Azure/azure-rest-api-specs/assets/4429827/5bb5e7ce-8aff-4dbb-a3f8-0d9b68fef5b1)
14+
415
## API Info: The Basics
16+
517
Most of the information about your service should be captured in the issue that serves as your [*API Spec engagement record*](https://aka.ms/azsdk/onboarding/restapischedule).
618

719
* Link to API Spec engagement record issue:
@@ -48,7 +60,6 @@ The [Azure API Review Board](https://aka.ms/azsdk/onboarding/restapischedule) is
4860

4961
* [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)
5062
* [Spectral Linting](https://github.com/Azure/azure-api-style-guide/blob/main/README.md)
51-
* [Open API Hub](https://aka.ms/openapiportal)
5263

5364
### Guidelines & Specifications
5465

@@ -62,8 +73,13 @@ The [Azure API Review Board](https://aka.ms/azsdk/onboarding/restapischedule) is
6273

6374
</details>
6475

65-
<details>
66-
<summary>Checks stuck in `queued` state?</summary>
67-
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`.
68-
This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.
69-
</details>
76+
## Getting help
77+
78+
- First, please carefully read through this PR description, from top to bottom.
79+
- If you don't have permissions to remove or add labels to the PR, request `write access` per [aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories](https://aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories")
80+
- To understand what you must do next to merge this PR, see the `Next Steps to Merge` comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
81+
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
82+
and https://aka.ms/ci-fix.
83+
- If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`.
84+
This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.
85+
- If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
276 KB
Loading

.github/comment.yml

Lines changed: 0 additions & 107 deletions
This file was deleted.

0 commit comments

Comments
 (0)