-
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
DBForPostgreSQL fixing s360 violations #12529
Conversation
Hi, @dsgouda 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 |
Swagger Validation Report
|
Rule | Message |
---|---|
The child tracked resource, 'queryTexts' with immediate parent 'Server', must have a list by immediate parent operation. New: Microsoft.DBforPostgreSQL/stable/2018-06-01/QueryPerformanceInsights.json#L370 |
|
The child tracked resource, 'topQueryStatistics' with immediate parent 'Server', must have a list by immediate parent operation. New: Microsoft.DBforPostgreSQL/stable/2018-06-01/QueryPerformanceInsights.json#L370 |
|
The child tracked resource, 'waitStatistics' with immediate parent 'Server', must have a list by immediate parent operation. New: Microsoft.DBforPostgreSQL/stable/2018-06-01/QueryPerformanceInsights.json#L370 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/postgresql/resource-manager/readme.md tag: specification/postgresql/resource-manager/readme.md#tag-package-2020-01-01 |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
Hi @dsgouda, Your PR has some issues. Please fix the CI sequentially by following the order of
|
NewApiVersionRequired reason: |
Hi @dsgouda, 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. |
Hi, @dsgouda your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @jianyexi |
...l/resource-manager/Microsoft.DBforPostgreSQL/stable/2018-06-01/QueryPerformanceInsights.json
Outdated
Show resolved
Hide resolved
...resource-manager/Microsoft.DBforPostgreSQL/stable/2018-06-01/examples/WaitStatisticsGet.json
Outdated
Show resolved
Hide resolved
...l/resource-manager/Microsoft.DBforPostgreSQL/stable/2018-06-01/QueryPerformanceInsights.json
Show resolved
Hide resolved
...resource-manager/Microsoft.DBforPostgreSQL/stable/2018-06-01/examples/WaitStatisticsGet.json
Outdated
Show resolved
Hide resolved
...manager/Microsoft.DBforPostgreSQL/stable/2018-06-01/examples/WaitStatisticsListByServer.json
Outdated
Show resolved
Hide resolved
"body": { | ||
"value": [ | ||
{ | ||
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforPostgreSQL/servers/testServerName/queryStatistic/66-636923268000000000-636923277000000000-avg-duration", |
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.
these are "topQueryStatistics", not "queryStatistic"
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.
The resource type being returned is a queryStatistic, topQueryStatistics is an aggregate over the querystatistics
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.
If a user requests a topQueryStatistics resource type they need to get that back. This will result in s360 violations on your RP. See https://armwiki.azurewebsites.net/api_contracts/RPCstrongvalidation.html?q=validation
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.
Could you suggest some workaround here, this is an APi in production for the last 2 years and it has always returned queryStatistics as the response type. The idea was to return the top from the list of querystatistics.
@ssen-msft FYI
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.
Please mark it down on your end to fix in the next api-version
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.
Noted, will create a workitem at our end
...urce-manager/Microsoft.DBforPostgreSQL/stable/2018-06-01/examples/TopQueryStatisticsGet.json
Outdated
Show resolved
Hide resolved
@jianyexi please merge the PR |
* Fixing violations * CI check fixes * Addressed PR comments
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API 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.