Adding swagger for endpoint certificates#17156
Merged
ruowan merged 3 commits intoAzure:dev-sql-Microsoft.Sql-2021-11-01-previewfrom Feb 3, 2022
Merged
Conversation
|
Hi, @srmarkov 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. vsswagger@microsoft.com |
|
[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 Validation Report
|
| Rule | Message |
|---|---|
|
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ReplicationLinks_Delete' Location: Microsoft.Sql/preview/2021-11-01-preview/ReplicationLinks.json#L112 |
|
Model definition 'FirewallRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Sql/preview/2021-11-01-preview/FirewallRules.json#L308 |
|
Model definition 'IPv6 FirewallRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Sql/preview/2021-11-01-preview/IPv6FirewallRules.json#L260 |
|
Model definition 'ProxyResourceWithWritableName' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Sql/preview/2021-11-01-preview/IPv6FirewallRules.json#L250 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/DatabaseVulnerabilityAssessmentRuleBaselines.json#L252 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/DatabaseVulnerabilityAssessments.json#L198 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/LongTermRetentionBackups.json#L269 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/LongTermRetentionBackups.json#L769 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/LongTermRetentionManagedInstanceBackups.json#L121 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/LongTermRetentionManagedInstanceBackups.json#L467 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedDatabaseSensitivityLabels.json#L256 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedDatabaseVulnerabilityAssessmentRuleBaselines.json#L264 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedDatabaseVulnerabilityAssessments.json#L207 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedInstanceAdministrators.json#L217 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedInstanceVulnerabilityAssessments.json#L189 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/ReplicationLinks.json#L141 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/RestorePoints.json#L207 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/SensitivityLabels.json#L611 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Sql/preview/2021-11-01-preview/ServerVulnerabilityAssessments.json#L189 |
|
The nested resource 'DatabaseVulnerabilityAssessmentRuleBaseline' does not have list operation, please add it. Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedDatabaseVulnerabilityAssessmentRuleBaselines.json#L313 |
|
The nested resource 'ManagedInstanceQuery' does not have list operation, please add it. Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedDatabaseQueries.json#L165 |
|
The nested resource 'ManagedDatabaseRestoreDetailsResult' does not have list operation, please add it. Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedDatabaseRestoreDetails.json#L140 |
|
The response schema of operations API '/providers/Microsoft.Sql/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Sql/preview/2021-11-01-preview/Operations.json#L19 |
|
The response in the GET collection operation 'DatabaseAdvisors_ListByDatabase' does not match the response definition in the individual GET operation 'DatabaseAdvisors_Get' . Location: Microsoft.Sql/preview/2021-11-01-preview/DatabaseAdvisors.json#L19 |
|
The response in the GET collection operation 'ServerAdvisors_ListByServer' does not match the response definition in the individual GET operation 'ServerAdvisors_Get' . Location: Microsoft.Sql/preview/2021-11-01-preview/ServerAdvisors.json#L19 |
|
The response in the GET collection operation 'DatabaseRecommendedActions_ListByDatabaseAdvisor' does not match the response definition in the individual GET operation 'DatabaseRecommendedActions_Get' . Location: Microsoft.Sql/preview/2021-11-01-preview/DatabaseRecommendedActions.json#L19 |
| Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedInstances.json#L381 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedInstances.json#L423 |
|
| 'PUT' operation 'FirewallRules_Replace' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Sql/preview/2021-11-01-preview/FirewallRules.json#L217 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Sql/preview/2021-11-01-preview/ManagedInstancePrivateLinkResources.json#L164 |
️⚠️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.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
ghost
added
the
|
Hi @srmarkov, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Dec 21, 2021
Member
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
|
@zhenglaizhang can you help to take a look? thanks! |
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
|
It's because of
It's due to at the global parameter space, |
Member
Author
@zhenglaizhang I addressed the issue you mentioned in this comment, so there are no more LintDiff errors. Still there are 2 SDK errors that seem are not related to my change. Do you have an insight how can I resolve them? |
ericshape
approved these changes
Jan 4, 2022
Member
|
@zhenglaizhang can you help to take a look about this PR? if there is no other issue, please help to merge it to dev branch? thanks! |
|
Hi, @srmarkov 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
mentat9
reviewed
Jan 26, 2022
| } | ||
| } | ||
| }, | ||
| "Resource": { |
Member
mentat9
reviewed
Jan 26, 2022
| "properties": { | ||
| "properties": { | ||
| "$ref": "#/definitions/EndpointCertificateProperties", | ||
| "description": "Resource properties.", |
Member
mentat9
reviewed
Jan 26, 2022
| } | ||
| } | ||
| }, | ||
| "parameters": { |
Member
There was a problem hiding this comment.
Most of these are unused and should be removed. Of the ones that are used, SubscriptionIdParameter, ApiVersionParameter, ResourceGroupParameter have counterparts in common types. Recommend using those instead. If you do that and remove the unused ones, the only parameter you need here is ManagedInstanceNameParameter. #Resolved
Member
Author
There was a problem hiding this comment.
@mentat9 All of those that you are suggesting we should change are automatically generated from some of our sql pipelines. There are bunch of files like this that are already checked in. This has to look like this. It probably is not the best, but that is due to it being autogenerated. So, please, I would like it checked in this way as I can not change it.
Member
|
Signed off with comments from ARM perspective. |
mentat9
added
ARMSignedOff
ruowan
approved these changes
Feb 3, 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>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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:
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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.