[Hub Generated] Review request for Microsoft.DBforPostgreSQL to add version preview/2022-05-01-privatepreview #21523
Conversation
This file contains 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
…/2022-03-08-preview to version 2022-05-01-privatepreview
|
Hi, @PurnaChandraRaoK 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
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| Migrations.json | 2022-05-01-preview(506b3e0) | 2021-06-15-privatepreview(main) |
| Operations.json | 2022-05-01-preview(506b3e0) | 2022-03-08-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 12 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-flexibleserver-2022-05-01-preview-only | package-flexibleserver-2022-05-01-preview-only(506b3e0) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L404 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L407 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L414 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L417 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L428 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L504 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L507 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L514 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L517 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L528 |
||
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L591 |
RPC-Put-V1-14 | |
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json#L749 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Operations.json#L38 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Operations.json#L111 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Operations.json#L135 |
️⚠️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 |
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DBforPostgreSQL' for api version '2022-05-01-preview'. The supported api-versions are '2021-06-01-preview, 2021-06-01, 2022-01-20-preview, 2022-03-08-preview, 2022-05-01-privatepreview, 2022-11-01-preview, 2022-12-01, 2017-12-01-preview, 2017-12-01, 2022-11-08'." |
️❌~[Staging] ServiceAPIReadinessTest: 7 Errors, 0 Warnings failed [Detail]
Tag package-flexibleserver-2022-05-01-preview-only; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 7, untested: 0, failed: 7, passed: 0
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/targetdbyxfu1a' under resource group 'apiTest-gIKCWk-21523' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Migrations_Create |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/targetdbyxfu1a' under resource group 'apiTest-gIKCWk-21523' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Migrations_ListByTargetServer |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/targetdbyxfu1a' under resource group 'apiTest-gIKCWk-21523' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Migrations_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/targetdbyxfu1a' under resource group 'apiTest-gIKCWk-21523' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Migrations_Update |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'operations' could not be found in the namespace 'Microsoft.DBforPostgreSQL' for api version '2022-05-01-preview'. The supported api-versions are '2021-06-01-preview,2021-06-01,2022-01-20-preview,2022-03-08-preview,2022-05-01-privatepreview,2022-11-01-preview,2022-12-01,2017-12-01-preview,2017-12-01,2022-11-08'. Source: runtime OperationId: Operations_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/targetdbyxfu1a' under resource group 'apiTest-gIKCWk-21523' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: CheckMigrationNameAvailability |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/targetdbyxfu1a' under resource group 'apiTest-gIKCWk-21523' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Migrations_Delete |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
ghost
added
the
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 11, 2022
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @PurnaChandraRaoK, 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. |
This was referenced Nov 11, 2022
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
ambrahma
reviewed
Nov 14, 2022
|
Hi @PurnaChandraRaoK, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @PurnaChandraRaoK, Your PR has some issues. Please fix the CI sequentially by following the order of
|
pilor
added
ARMSignedOff
openapi-workflow-bot
bot
added
WaitForARMFeedback
pilor
added
the
ARMSignedOff
xiaoxuqi-ms
approved these changes
Mar 2, 2023
|
The service is public on March. 1st and I highly recommend @PurnaChandraRaoK to fix the API readiness issue in other pr ASAP. |
PR is out and it will take some time to get it merged and deploy https://dev.azure.com/msdata/Database Systems/_git/orcasql-shared/pullrequest/999712?path=/src/ARM_manifests/Postgres/CSM_Registration_Postgres_Dogfood.json |
This was referenced Mar 2, 2023
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
…ersion preview/2022-05-01-privatepreview (Azure#21523) * Adds base for updating Microsoft.DBforPostgreSQL from version preview/2022-03-08-preview to version 2022-05-01-privatepreview * Updates readme * Updates API version in new specs and examples * copied migration changes * added new checkMigrationNameAvailability.json * changed readme file * change in readme.md * change in readme.md * change in readme.md * removed commontypes.json in readme * testing readme changes * changed subscriptionid and resourceGroupName * changed serviceError * changed uuid to guid * changed guid to string * aded custom words * renamed migrationName to nameOfMigration * removed common-types in readme * copied 2022-03-08-preview merged PR changes * changed v2 to v3 in migration.json and added password in types.json * added password * Added only migration related changes * Added operations.json * Added only migration related changes * testing operation change * Added operations.json * checking avocado changes * removed common-types * changed -privatepreview to -preview * resolved conflicts * changed camelcase errors * added trigger as custom word * added trigger as custom word * Removed MigrationResourceGroup * changed nameOfMigration to migrationName * reverted nameOfMigration to migrationName * changed to preview-only * checking migrationName param * reverting migrationname changes * testing migrationName * fixed error --------- Co-authored-by: Purnachandra rao Kota <pkota@microsoft.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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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:
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.
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.