Add swagger examples for cross subscription operations #18135
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @imadan1996 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 Validation Report
|
| Rule | Message |
|---|---|
|
Missing identifier id in array item property Location: Microsoft.Sql/preview/2021-11-01-preview/Databases.json#L1823 |
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2021-11-01-preview/Databases.json#L310 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2021-11-01-preview/Databases.json#L430 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2021-11-01-preview/Databases.json#L540 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2021-11-01-preview/Databases.json#L590 |
|
| OperationId should contain the verb: 'move' in:'Databases_Rename'. Consider updating the operationId Location: Microsoft.Sql/preview/2021-11-01-preview/Databases.json#L494 |
|
| '$skipToken' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Sql/preview/2021-11-01-preview/Databases.json#L33 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2021-11-01-preview/Databases.json compared with base:preview/2021-08-01-preview/Databases.json
️️✔️SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2021-11", "details":"Error: Plugin checker reported failure." |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
ghost
added
the
|
Hi, @imadan1996 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
This was referenced Mar 8, 2022
This was referenced Mar 8, 2022
This was referenced Mar 8, 2022
raych1
approved these changes
Mar 10, 2022
raych1
pushed a commit
that referenced
this pull request
Mar 29, 2022
* Adds base for updating Microsoft.Sql from version preview/2021-08-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * update sql default tag to composite-v5 (#17143) * Updated Blob Auditing API Files (#17355) * Updated Blob Auditing API Files * Fixed new property name case * fixing x-ms-enum lint warning Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> * Adding swagger for endpoint certificates (#17156) * Adding swagger for endpoint certificates * Fix the year * Fix build error on the pull request * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs (#17881) * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs * Fix to Swagger ModelValidation failures * Removing the 201 from Database Upsert operation since it is not a long running operation. * Change the name of the API to AdvancedThreatProtectionSettings * Fix to the renaming to AdvancedThreatProtectionSettings * Remove old files * Adding ManagedServerDnsAliases API endpoints (#18008) * change * Update readme.md * error 201 * Revert "Update readme.md" This reverts commit ceff39a. * Revert "error 201" This reverts commit 759fa4f. * Fixed bad reverts Co-authored-by: Ji Wang <wangjiprc@gmail.com> * Add 201 response example so SQL clients can work correctly (#18121) * Add examples for cross sub restore (#18135) * Release Microsoft.sql 2021 11 01 preview (#18005) * update swagger files and example files * update readme.md * address the pipeline error. * update the reference. * address the pipeline error * address x-ms-secret comments * update error message * revert the deleted legacy files; avoid breaking changes. * remove example files and reference. * remove secret * Adds base for updating Microsoft.Sql from version preview/2021-08-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * update sql default tag to composite-v5 (#17143) * Updated Blob Auditing API Files (#17355) * Updated Blob Auditing API Files * Fixed new property name case * fixing x-ms-enum lint warning Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> * Adding swagger for endpoint certificates (#17156) * Adding swagger for endpoint certificates * Fix the year * Fix build error on the pull request * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs (#17881) * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs * Fix to Swagger ModelValidation failures * Removing the 201 from Database Upsert operation since it is not a long running operation. * Change the name of the API to AdvancedThreatProtectionSettings * Fix to the renaming to AdvancedThreatProtectionSettings * Remove old files * update swagger files and example files * update readme.md * address the pipeline error. * resolove the conflict * address the pipeline error * address x-ms-secret comments * update error message * revert the deleted legacy files; avoid breaking changes. * remove example files and reference. * remove secret Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: msdogra <msdogra@hotmail.com> Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> Co-authored-by: srmarkov <88828188+srmarkov@users.noreply.github.com> Co-authored-by: Uriel Cohen <urielc@microsoft.com> Co-authored-by: Marko Nikolic <96062747+markonikolicmicrosoft@users.noreply.github.com> Co-authored-by: Andrija Cicovic <100755783+cicovic-andrija-msft@users.noreply.github.com> Co-authored-by: Ishan Rajesh Madan <99760799+imadan1996@users.noreply.github.com>
visingl
pushed a commit
that referenced
this pull request
Mar 30, 2022
* Adds base for updating Microsoft.Sql from version preview/2021-08-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * update sql default tag to composite-v5 (#17143) * Updated Blob Auditing API Files (#17355) * Updated Blob Auditing API Files * Fixed new property name case * fixing x-ms-enum lint warning Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> * Adding swagger for endpoint certificates (#17156) * Adding swagger for endpoint certificates * Fix the year * Fix build error on the pull request * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs (#17881) * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs * Fix to Swagger ModelValidation failures * Removing the 201 from Database Upsert operation since it is not a long running operation. * Change the name of the API to AdvancedThreatProtectionSettings * Fix to the renaming to AdvancedThreatProtectionSettings * Remove old files * Adding ManagedServerDnsAliases API endpoints (#18008) * change * Update readme.md * error 201 * Revert "Update readme.md" This reverts commit ceff39a. * Revert "error 201" This reverts commit 759fa4f. * Fixed bad reverts Co-authored-by: Ji Wang <wangjiprc@gmail.com> * Add 201 response example so SQL clients can work correctly (#18121) * Add examples for cross sub restore (#18135) * Release Microsoft.sql 2021 11 01 preview (#18005) * update swagger files and example files * update readme.md * address the pipeline error. * update the reference. * address the pipeline error * address x-ms-secret comments * update error message * revert the deleted legacy files; avoid breaking changes. * remove example files and reference. * remove secret * Adds base for updating Microsoft.Sql from version preview/2021-08-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * update sql default tag to composite-v5 (#17143) * Updated Blob Auditing API Files (#17355) * Updated Blob Auditing API Files * Fixed new property name case * fixing x-ms-enum lint warning Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> * Adding swagger for endpoint certificates (#17156) * Adding swagger for endpoint certificates * Fix the year * Fix build error on the pull request * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs (#17881) * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs * Fix to Swagger ModelValidation failures * Removing the 201 from Database Upsert operation since it is not a long running operation. * Change the name of the API to AdvancedThreatProtectionSettings * Fix to the renaming to AdvancedThreatProtectionSettings * Remove old files * update swagger files and example files * update readme.md * address the pipeline error. * resolove the conflict * address the pipeline error * address x-ms-secret comments * update error message * revert the deleted legacy files; avoid breaking changes. * remove example files and reference. * remove secret Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: msdogra <msdogra@hotmail.com> Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> Co-authored-by: srmarkov <88828188+srmarkov@users.noreply.github.com> Co-authored-by: Uriel Cohen <urielc@microsoft.com> Co-authored-by: Marko Nikolic <96062747+markonikolicmicrosoft@users.noreply.github.com> Co-authored-by: Andrija Cicovic <100755783+cicovic-andrija-msft@users.noreply.github.com> Co-authored-by: Ishan Rajesh Madan <99760799+imadan1996@users.noreply.github.com>
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
* Adds base for updating Microsoft.Sql from version preview/2021-08-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * update sql default tag to composite-v5 (Azure#17143) * Updated Blob Auditing API Files (Azure#17355) * Updated Blob Auditing API Files * Fixed new property name case * fixing x-ms-enum lint warning Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> * Adding swagger for endpoint certificates (Azure#17156) * Adding swagger for endpoint certificates * Fix the year * Fix build error on the pull request * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs (Azure#17881) * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs * Fix to Swagger ModelValidation failures * Removing the 201 from Database Upsert operation since it is not a long running operation. * Change the name of the API to AdvancedThreatProtectionSettings * Fix to the renaming to AdvancedThreatProtectionSettings * Remove old files * Adding ManagedServerDnsAliases API endpoints (Azure#18008) * change * Update readme.md * error 201 * Revert "Update readme.md" This reverts commit ceff39a. * Revert "error 201" This reverts commit 759fa4f. * Fixed bad reverts Co-authored-by: Ji Wang <wangjiprc@gmail.com> * Add 201 response example so SQL clients can work correctly (Azure#18121) * Add examples for cross sub restore (Azure#18135) * Release Microsoft.sql 2021 11 01 preview (Azure#18005) * update swagger files and example files * update readme.md * address the pipeline error. * update the reference. * address the pipeline error * address x-ms-secret comments * update error message * revert the deleted legacy files; avoid breaking changes. * remove example files and reference. * remove secret * Adds base for updating Microsoft.Sql from version preview/2021-08-01-preview to version 2021-11-01-preview * Updates readme * Updates API version in new specs and examples * update sql default tag to composite-v5 (Azure#17143) * Updated Blob Auditing API Files (Azure#17355) * Updated Blob Auditing API Files * Fixed new property name case * fixing x-ms-enum lint warning Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> * Adding swagger for endpoint certificates (Azure#17156) * Adding swagger for endpoint certificates * Fix the year * Fix build error on the pull request * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs (Azure#17881) * Microsoft.Sql - adding Database and Server AdvancedThreatProtection APIs * Fix to Swagger ModelValidation failures * Removing the 201 from Database Upsert operation since it is not a long running operation. * Change the name of the API to AdvancedThreatProtectionSettings * Fix to the renaming to AdvancedThreatProtectionSettings * Remove old files * update swagger files and example files * update readme.md * address the pipeline error. * resolove the conflict * address the pipeline error * address x-ms-secret comments * update error message * revert the deleted legacy files; avoid breaking changes. * remove example files and reference. * remove secret Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com> Co-authored-by: msdogra <msdogra@hotmail.com> Co-authored-by: Mukesh Dogra <mdogra@microsoft.com> Co-authored-by: srmarkov <88828188+srmarkov@users.noreply.github.com> Co-authored-by: Uriel Cohen <urielc@microsoft.com> Co-authored-by: Marko Nikolic <96062747+markonikolicmicrosoft@users.noreply.github.com> Co-authored-by: Andrija Cicovic <100755783+cicovic-andrija-msft@users.noreply.github.com> Co-authored-by: Ishan Rajesh Madan <99760799+imadan1996@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
March 2022
March 2022
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.