-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
[Language] Restructure Language swagger files #31161
base: main
Are you sure you want to change the base?
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the purpose of these changes? Just to better align with the TypeSpec migration? Relocating these files in main
will break a lot of use cases including Azure SDKs - at least when we update references (but that can be fixed) - and likely Microsoft Learn docs.
If these are strictly to better compare with TypeSpec, I'd also recommend changing "-Authoring" directories to ".Authoring" to match with package names, which we more typically use "." in general naming.
@heaths to give some context, since we already have separate api release schedules for Language, our generated API docs are not reflecting the correct API versions for each capability. So during the API review for the new API version we were asked to get this fixed. In an attempt to fix, that I submitted this PR to re-organize the swagger files according to the api grouping we will release. The organization we are proposing (after discussion with our internal team):
Adding @JeffreyRichter, @mikekistler @allenjzhang for their review/comments |
This PR looks pretty GREAT to me! Can we get rid of the preview folder that is immediately under the Language directory? This folder currently has 2021-110-01-preview and 2023-04-15-preview subdirs in it. |
@JeffreyRichter , yes, I am updating the typespecs as well to point to the correct swagger directory in this next iteration. The preview folder under Language shows up as there were 2 random files which were part of the preview folders, which I am assuming should not have been merged. They show up as removed as they are not moved anywhere. Rather they are deleted.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job! Thanks for doing this.
Data Plane API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
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.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
Getting help
write access
per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext 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.and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.