Add PostgreSQL v14 to api spec #19808
Merged
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
|
Hi, @alanenriqueo 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.9.6)] | new version | base version |
|---|---|---|
| postgresql.json | 2022-01-20-preview(bd18bcb) | 2022-01-20-preview(main) |
| getCachedServerName.json | 2022-03-08-privatepreview(bd18bcb) | 2022-03-08-privatepreview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| flexibleserver-2022-03-privatepreview | flexibleserver-2022-03-privatepreview(bd18bcb) | flexibleserver-2022-03-privatepreview(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The schema 'Storage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-privatepreview/getCachedServerName.json#L139 |
|
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-privatepreview/getCachedServerName.json#L149 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-privatepreview/getCachedServerName.json#L175 |
| Since operation 'BackupListByServer' 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-01-20-preview/postgresql.json#L515 |
|
| 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-01-20-preview/postgresql.json#L1006 |
|
| 'GET' operation 'BackupListByServer' 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-01-20-preview/postgresql.json#L515 |
|
| '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-01-20-preview/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-01-20-preview/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-01-20-preview/postgresql.json#L1092 |
|
| OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/postgresql.json#L961 |
|
| OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'VirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/postgresql.json#L1048 |
|
| OperationId should contain the verb: 'getcachedservername' in:'GetCachedServerName_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-privatepreview/getCachedServerName.json#L42 |
|
| The child tracked resource, 'backups' with immediate parent 'Server', must have a list by immediate parent operation. Location: Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/postgresql.json#L1946 |
|
| 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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/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-01-20-preview/postgresql.json#L1247 |
|
| 'supportedStorageMB' 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-01-20-preview/postgresql.json#L1271 |
|
| 'supportedFlexibleServerEditions' 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-01-20-preview/postgresql.json#L1416 |
|
| 'supportedHyperscaleNodeEditions' 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-01-20-preview/postgresql.json#L1424 |
|
| 'ServerPropertiesForUpdate' 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-01-20-preview/postgresql.json#L1630 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: FirewallRuleList Location: Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/postgresql.json#L715 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update a user configuration Location: Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/postgresql.json#L904 |
️⚠️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 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.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/bd18bcbfac7bc65204b186c9ef0f0ff3e0bd0fd1/specification/postgresql/resource-manager/readme.md#tag-flexibleserver-2022-03-privatepreview">postgresql/resource-manager/readme.md#flexibleserver-2022-03-privatepreview
- "https://github.com/Azure/azure-rest-api-specs/blob/bd18bcbfac7bc65204b186c9ef0f0ff3e0bd0fd1/specification/postgresql/resource-manager/readme.md#tag-package-flexibleserver-2022-01-preview">postgresql/resource-manager/readme.md#package-flexibleserver-2022-01-preview
| Rule | Message |
|---|---|
| "readme":"postgresql/resource-manager/readme.md", "tag":"flexibleserver-2022-03-privatepreview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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.
Swagger Generation Artifacts
|
|
Hi @alanenriqueo, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jul 18, 2022
Closed
[AutoPR armpostgresqlflexibleservers] Add PostgreSQL v14 to api spec
azure-sdk/azure-sdk-for-go#1749
Closed
alanenriqueo
force-pushed
the
postgresql-v14-fix
branch
from
dfb3f81
to
c04e612
Compare
alanenriqueo
force-pushed
the
postgresql-v14-fix
branch
from
c04e612
to
bd18bcb
Compare
msyyc
approved these changes
Jul 26, 2022
This was referenced Jul 26, 2022
Merged
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jul 26, 2022
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.
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 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.