-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[Hub Generated] Review request for Microsoft.DBforPostgreSQL to add version preview/2022-05-01-privatepreview #21223
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
base: main
Are you sure you want to change the base?
Conversation
…/2022-01-20-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. [email protected] |
Swagger pipeline can not start as the pull request has merge conflicts. |
1 similar comment
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
…-01-privatepreview
Swagger Validation Report
|
compared swaggers (via Oad v0.10.1)] | new version | base version |
---|---|---|
Databases.json | 2022-05-01-privatepreview(e005c57) | 2021-06-01(main) |
Databases.json | 2022-05-01-privatepreview(e005c57) | 2022-03-08-preview(main) |
Migrations.json | 2022-05-01-privatepreview(e005c57) | 2021-06-15-privatepreview(main) |
PrivateDnsZone.json | 2022-05-01-privatepreview(e005c57) | 2021-06-01(main) |
PrivateDnsZone.json | 2022-05-01-privatepreview(e005c57) | 2022-03-08-preview(main) |
postgresql.json | 2022-05-01-privatepreview(e005c57) | 2021-06-01(main) |
postgresql.json | 2022-05-01-privatepreview(e005c57) | 2022-01-20-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1023 - TypeFormatChanged |
The new version has a different format than the previous one. New: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1815:9 Old: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1745:9 |
1023 - TypeFormatChanged |
The new version has a different format than the previous one. New: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1824:9 Old: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1762:9 |
1023 - TypeFormatChanged |
The new version has a different format than the previous one. New: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1560:9 Old: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1489:9 |
The following breaking changes are detected by comparison with the latest preview version:
Only 18 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 4 Errors, 42 Warnings failed [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-05-01-privatepreview | package-2022-05-01-privatepreview(e005c57) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 18 items are listed, please refer to log for more details.
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'DBsToTiggerCutoverOn', for definition: 'MigrationResourceProperties' must follow camelCase style. Example: 'dBsToTiggerCutoverOn'. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L432 |
|
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'DBsToCancelMigrationOn', for definition: 'MigrationResourceProperties' must follow camelCase style. Example: 'dBsToCancelMigrationOn'. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L443 |
|
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'DBsToTiggerCutoverOn', for definition: 'MigrationResourcePropertiesForPatch' must follow camelCase style. Example: 'dBsToTiggerCutoverOn'. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L535 |
|
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'DBsToCancelMigrationOn', for definition: 'MigrationResourcePropertiesForPatch' must follow camelCase style. Example: 'dBsToCancelMigrationOn'. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L546 |
|
Guid used in model definition 'MigrationResourceProperties' for property 'migrationId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L364 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: setupLogicalReplicationOnSourceDBIfNeeded Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L415 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: overwriteDBsInTarget Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L418 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: startDataMigration Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L425 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: triggerCutover Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L428 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: cancel Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L439 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: setupLogicalReplicationOnSourceDBIfNeeded Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L518 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: overwriteDBsInTarget Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L521 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: startDataMigration Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L528 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: triggerCutover Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L531 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: cancel Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L542 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L775 |
||
The tracked resource, 'MigrationResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L341 |
||
The tracked resource, 'MigrationResource', must have a list by subscriptions operation. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L341 |
The following errors/warnings exist before current PR submission:
Only 18 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Since operation 'LocationBasedCapabilitiesExecute' response has model definition 'x-ms-pageable', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1006 |
|
'GET' operation 'LocationBasedCapabilities_Execute' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1006 |
|
'PUT' operation 'Configurations_Put' 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.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L903 |
|
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-privatepreview/postgresql.json#L1092 |
|
OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L961 |
|
OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'VirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1048 |
|
OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/PrivateDnsZone.json#L42 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: geoBackupSupported Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1401 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundantHaSupported Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1406 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundantHaAndGeoBackupSupported Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1411 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDynamicConfig Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L2066 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isReadOnly Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L2071 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isConfigPendingRestart Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L2076 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L2171 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L2245 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: restartWithFailover Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L2279 |
|
'delegatedSubnetsUsage' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1139 |
|
'supportedVcores' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/postgresql.json#L1247 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌
ModelValidation: 20 Errors, 0 Warnings failed [Detail]
Only 18 items are listed, please refer to log for more details.
️️✔️
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: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Unknown word (Tigger), please fix the error or add words to ./custom-words.txt path: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L432:15 |
HowToFix |
Unknown word (Tigger), please fix the error or add words to ./custom-words.txt path: Microsoft.DBforPostgreSQL/preview/2022-05-01-privatepreview/Migrations.json#L535:15 |
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
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 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.