Skip to content

Add Typespec conversion option to intake template #29616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 11, 2024
Merged

Add Typespec conversion option to intake template #29616

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90b7c7a
Add Typespec converstion option to intake template
mentat9 Jun 27, 2024
765f7fd
Update control_plane_template.md
mentat9 Jul 2, 2024
4dff555
Update control_plane_template.md
mentat9 Jul 2, 2024
de3b7bc
Merge branch 'main' into mentat9-patch-1
Jul 2, 2024
968ce95
Update control_plane_template.md
mentat9 Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE/control_plane_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ What's the purpose of this PR? Check the specific option that applies. This is *
- [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to [OpenAPI specs PR creation guidance](https://aka.ms/azsdkdocs/createopenapispec)).
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix OpenAPI spec quality issues in S360.
- [ ] Convert existing swagger spec to Typespec (do not combine this with implementing a new API version).
Copy link

@konrad-jamrozik konrad-jamrozik Jul 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] Convert existing swagger spec to Typespec (do not combine this with implementing a new API version).
- [ ] Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing a new API version).

We purposefully avoid using the term swagger as deprecated and incorrect. We agreed to this internally within Azure SDK plus there is this public blog post:

Also, @mikeharder this:

(do not combine this with implementing a new API version)

goes against the new guidance we agreed to that you proposed - that the conversion must happen in a new preview API version.

Copy link

@konrad-jamrozik konrad-jamrozik Jul 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to me we should link here to some doc about TypeSpec conversions if we want to avoid unnecessary support burden.

I found this:

https://azure.github.io/typespec-azure/docs/next/howtos/migrate-swagger/get-started

There is also this:

  • Pull Request 9459836: API review best practice and self attestation checklist for Typespec based PRs

Our TypeSpec page links to the page above from Resources, but that's it:

I would not add this checklist bullet without linking to appropriate doc, as I am usually one of the few people on the first line of support fielding questions.

@mikeharder @MattGertz @rkmanda

- [ ] Other, please clarify:
- _edit this with your clarification_

Expand Down