-
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
Add Swagger specs for ARE[Azure Runtime Environment] #23988
Conversation
Hi, @sushil490023 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Generation Artifacts
|
Thank you for your contribution sushil490023! We will review the pull request and get back to you soon. |
Generated ApiView
|
Hi @sushil490023, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @sushil490023, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Can you please update the label
Can you please update the label once PR is ready for ARM review ? |
Please fix this comment as well |
Hi @sushil490023, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
123e6b9
to
215bd43
Compare
5d66a9d
to
13447bb
Compare
"x-ms-client-flatten": true, | ||
"description": "Gets or sets the automation account properties." | ||
}, | ||
"id": { |
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.
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.
We have not modified this resource. It came as part of the last stable version.
"DeletedAutomationAccountProperties": { | ||
"type": "object", | ||
"properties": { | ||
"automationAccountResourceId": { |
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.
Is it an azure resource ID? If so, please add "format": "arm-id" and "x-ms-arm-id-details".
https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-arm-id-details
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.
We have not modified this resource. It came as part of the last stable version.
"in": "body", | ||
"required": true, | ||
"schema": { | ||
"$ref": "#/definitions/CertificateCreateOrUpdateParameters" |
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.
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.
We have not modified this resource. It came as part of the last stable version.
Since multiple reviews have happened on the PR and it was approved earlier, approved from AzCoreIDC side. Please get a final approval from ARM team. |
}, | ||
"runbookType": { | ||
"type": "string", | ||
"description": "Type of the runbook." |
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.
enum?
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.
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
* First Commit of Stable version * Add Swagger file for ARE * rename name to packageName * fix Package operation examples * Fixed Avacado errors * Fixed duplicate schema * Fix Duplicate schema erors. * Fix Duplicate schema erors. * Fix Duplicate Schema error * Fix Errors * Testing * Fix errors * Removed uuid format for PrincipalId in Identity properties * Fix example for ModelValidation Failure * Re-run Go SDK --------- Co-authored-by: Sushil Upadhyay <supadhyay@microsoft.com> Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: mahakjain314 <50352900+mahakjain314@users.noreply.github.com>
* First Commit of Stable version * Add Swagger file for ARE * rename name to packageName * fix Package operation examples * Fixed Avacado errors * Fixed duplicate schema * Fix Duplicate schema erors. * Fix Duplicate schema erors. * Fix Duplicate Schema error * Fix Errors * Testing * Fix errors * Removed uuid format for PrincipalId in Identity properties * Fix example for ModelValidation Failure * Re-run Go SDK --------- Co-authored-by: Sushil Upadhyay <supadhyay@microsoft.com> Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: mahakjain314 <50352900+mahakjain314@users.noreply.github.com>
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
What's the purpose of the update?
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
June 2023
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
June 2023
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Al supported SDKs will be updated for new API version
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
[ X] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.