Skip to content

Commit 80eb106

Browse files
maririoszman-ms
authored andcommitted
Update docs to be clear about OpenAPI Hub only for swagger (#26669)
* no openAPI Hub for TS * caps
1 parent e6c73ac commit 80eb106

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

.github/PULL_REQUEST_TEMPLATE/control_plane_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you need further help with anything, see `Getting help` section below.
2020

2121
What's the purpose of this PR? Check all that apply. This is **mandatory**!
2222

23-
- [ ] New API version. (Such PR should have been generated with [OpenAPI Hub](https://aka.ms/openapihub)).
23+
- [ ] New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using [OpenAPI Hub](https://aka.ms/openapihub)).
2424
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
2525
- [ ] Update existing version to fix swagger quality issues in S360.
2626
- [ ] Other, please clarify:

CONTRIBUTING.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,11 @@ See the [README.md](./README.md) for a description of the directory structure to
5858

5959
If you want to contribute to the repository, follow these steps:
6060
1. Fork the repository and create a new branch for your changes.
61-
2. If you are introducing a new api-version, create a new directory for that api-version and copy all the files from the previous version into the new directory. Make this the very first commit in your branch and then make your changes in subsequent commits.
62-
3. Use the [linting tools](#coding-style) to check your changes for compliance with the OpenAPI v2 standard, the Azure REST API Guidelines and that Azure API Style Guide.
63-
4. Push the changes to the branch in your fork until the branch is ready to be integrated.
64-
5. Rebase your branch if needed to incorporate any changes to **main** and submit a pull request to the **main** branch using either the "control plane" or "data plane" PR template -- the main PR template lets you select which one.
65-
5. Resolve any issues flagged by the [Pull Request checks](#pull-request-checks).
66-
6. Contact the ARM API Review board or Azure API Stewardship team to request PR review.
67-
68-
Microsoft employees can use [OpenAPI Hub](https://aka.ms/openapihub) for adding a new API version.
61+
2. Push the changes to the branch in your fork until the branch is ready to be integrated.
62+
3. Rebase your branch if needed to incorporate any changes to **main** and submit a pull request to the **main** branch using either the "control plane" or "data plane" PR template -- the main PR template lets you select which one.
63+
4. Resolve any issues flagged by the [Pull Request checks](#pull-request-checks).
64+
65+
**Note:** Microsoft employees can use tooling for adding a new API version available [here](https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-specs), specially if not working with TypeSpec.
6966

7067
## Pull Request Checks
7168

0 commit comments

Comments
 (0)