Initial#20031
Conversation
|
Hi, @gojko97 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 |
|---|---|
AutoRest exception |
"location":"specification/sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"swagger-document/individual/schema-validator - FAILED" |
AutoRest exception |
"location":"specification/sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Error: [OperationAbortedException] Error occurred. Exiting." |
️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
MISSING_APIS_IN_DEFAULT_TAG |
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/sql/resource-manager/readme.md json: Microsoft.Sql/preview/2022-05-01-preview/ManagedDatabaseMoveOperations.json |
| 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: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
unacceptable kind of an object to dump [object Error] |
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/8e9e82a7ade5a2f5154c95f9a7d551fe8884f1e9/specification/sql/resource-manager/Microsoft.Sql/preview/2022-05-01-preview/ManagedDatabaseMoveOperations.json" |
unacceptable kind of an object to dump [object Error] |
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/8e9e82a7ade5a2f5154c95f9a7d551fe8884f1e9/specification/sql/resource-manager/Microsoft.Sql/preview/2022-05-01-preview/ManagedDatabaseMoveOperations.json" |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/8e9e82a7ade5a2f5154c95f9a7d551fe8884f1e9/specification/sql/resource-manager/readme.md#tag-package-preview-2022-05">sql/resource-manager/readme.md#package-preview-2022-05
| Rule | Message |
|---|---|
DuplicateOperation |
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Duplicate Operation 'DatabaseSqlVulnerabilityAssessmentBaselines' > 'CreateOrUpdate' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths:\n - put /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/databases/databaseName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName\n - put /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName" |
DuplicateOperation |
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Duplicate Operation 'DatabaseSqlVulnerabilityAssessmentRuleBaselines' > 'Delete' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths:\n - delete /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/databases/databaseName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName/rules/ruleId\n - delete /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName/rules/ruleId" |
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Duplicate object schemas with 'SecurityAlertPolicyName' name detected." |
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Error: 3 errors occured -- cannot continue." |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
|
Hi, @gojko97 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @gojko97, Your PR has some issues. Please fix the CI sequentially by following the order of
|
| }, | ||
| "responses": { | ||
| "200": { | ||
| "properties": { |
There was a problem hiding this comment.
Does this format is expected? Without body tag?
| "operationId": "ManagedDatabaseMoveOperations_ListByLocation", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" |
There was a problem hiding this comment.
@raosuhas This JSON is automatically generated, so I'd prefer to have the Swagger generation script modified rather than to do manual intervention. Would this work?
| "type": "string" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" |
There was a problem hiding this comment.
@raosuhas Please see the proposal above.
| "type": "string" | ||
| }, | ||
| { | ||
| "name": "onlyLatestPerDatabase", |
There was a problem hiding this comment.
have you considered using one of the standard parameters : https://github.com/microsoft/api-guidelines/blob/62502e094f8a3e16586ab039d7bbe1021ec7804d/azure/Guidelines.md#query-options
There was a problem hiding this comment.
@raosuhas Thanks for pointing this one out, and I'd say that the optional "filter" argument is meant to provide flexibility via standard query options. On the other hand, "onlyLatestPerDatabase" is a shortcut meant to provide the kind of filtering we expect to be used most often by clients (i.e., by Portal).
| "tags": [ | ||
| "ManagedDatabaseMoveOperations" | ||
| ], | ||
| "description": "Gets managed database move operations.", |
| "name": "15961324-d809-46ed-86b9-d786953140e2", | ||
| "type": "Microsoft.Sql/locations/managedDatabaseMoveOperationResults" | ||
| }, | ||
| "202": { |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
|
Please respond to the comments and remove the "ARMChangesRequested" label when this PR is ready for review again . |
|
@ericshape, @jamestao, @raosuhas Taking over from @gojko97, since I'm unable to push corrections to his fork on Github, I'll abandon this PR in favor of the one created by myself: #20066. |
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:
August 2022
August 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 appy 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 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.