-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[Do Not Review] PostgreSQL 2022-03-08-preview API #20632
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-03-08-preview
…QL-2022-03-08-preview
…view' of https://github.com/ambrahma/azure-rest-api-specs into dev-postgresql-Microsoft.DBforPostgreSQL-2022-03-08-preview
Hi, @DaeunYim 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 Validation Report
|
compared swaggers (via Oad v0.9.7)] | new version | base version |
---|---|---|
Databases.json | 2022-03-08-preview(ef4e8bc) | 2021-06-01(main) |
Databases.json | 2022-03-08-preview(ef4e8bc) | 2022-01-20-preview(main) |
PrivateDnsZone.json | 2022-03-08-preview(ef4e8bc) | 2021-06-01(main) |
PrivateDnsZone.json | 2022-03-08-preview(ef4e8bc) | 2022-01-20-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
"details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:GetCachedServerName_Execute;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/CachedServerName.json" |
|
"details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:Operations_List;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Operations.json" |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 8 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-flexibleserver-2022-03-privatepreview | package-flexibleserver-2022-03-privatepreview(ef4e8bc) | default(main) |
package-flexibleserver-2022-03-preview | package-flexibleserver-2022-03-preview(ef4e8bc) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Administrators_Create' Request Model: 'ActiveDirectoryAdministratorAdd' Response Model: 'ActiveDirectoryAdministrator' Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Administrators.json#L38 |
||
OperationId should contain the verb: 'getcachedservername' in:'GetCachedServerName_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/CachedServerName.json#L42 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fastProvisioningSupported Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L357 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: activeDirectoryAuthEnabled Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FlexibleServers.json#L706 |
||
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: passwordAuthEnabled Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FlexibleServers.json#L710 |
||
'FastProvisioningEditionCapability' 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-03-08-preview/Capabilities.json#L212 |
||
'supportedFastProvisioningEditions' 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-03-08-preview/Capabilities.json#L362 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ServerGet Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FlexibleServers.json#L226 |
The following errors/warnings exist before current PR submission:
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-03-08-preview/Capabilities.json#L42 |
|
'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-03-08-preview/Capabilities.json#L42 |
|
'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-03-08-preview/Configuration.json#L186 |
|
Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Operations.json#L38 |
|
OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/CheckNameAvailability.json#L42 |
|
OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/PrivateDnsZone.json#L42 |
|
OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'VirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/VirtualNetwork.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-03-08-preview/Capabilities.json#L326 |
|
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-03-08-preview/Capabilities.json#L331 |
|
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-03-08-preview/Capabilities.json#L336 |
|
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-03-08-preview/CheckNameAvailability.json#L109 |
|
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-03-08-preview/Configuration.json#L282 |
|
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-03-08-preview/Configuration.json#L287 |
|
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-03-08-preview/Configuration.json#L292 |
|
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-03-08-preview/Operations.json#L111 |
|
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-03-08-preview/ServerStartStopRestart.json#L182 |
|
'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-03-08-preview/Capabilities.json#L151 |
|
'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-03-08-preview/Capabilities.json#L175 |
|
'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-03-08-preview/Capabilities.json#L341 |
|
'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-03-08-preview/Capabilities.json#L349 |
|
'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-03-08-preview/FlexibleServers.json#L551 |
|
'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-03-08-preview/VirtualNetwork.json#L100 |
|
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-03-08-preview/Configuration.json#L187 |
|
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-03-08-preview/FirewallRules.json#L197 |
️⚠️
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 |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DBforPostgreSQL' for api version '2022-03-08-preview'. The supported api-versions are '2021-06-01-preview, 2021-06-01, 2022-01-20-preview, 2017-12-01-preview, 2017-12-01'." |
️❌
~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
ASSERTION_ERROR |
"ResourceType 'flexibleServers' should be deployed in 'West Central US' on apiVersion '2022-03-08-preview'.: expected [ Array(39) ] to satisfy [Function]" |
️❌
~[Staging] TrafficValidation: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
ASSERTION_ERROR |
"ResourceType 'flexibleServers' should be deployed in 'West Central US' on apiVersion '2022-03-08-preview'.: expected [ Array(39) ] to satisfy [Function]" |
️️✔️
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: 2 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/ef4e8bc90aae5855402ac971791fb936ad60852c/specification/postgresql/resource-manager/readme.md#tag-package-flexibleserver-2022-03-preview">postgresql/resource-manager/readme.md#package-flexibleserver-2022-03-preview
- "https://github.com/Azure/azure-rest-api-specs/blob/ef4e8bc90aae5855402ac971791fb936ad60852c/specification/postgresql/resource-manager/readme.md#tag-package-flexibleserver-2022-03-privatepreview">postgresql/resource-manager/readme.md#package-flexibleserver-2022-03-privatepreview
Rule | Message |
---|---|
"readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-preview", "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-03-privatepreview", "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
|
Generated ApiView
|
Hi @DaeunYim, Your PR has some issues. Please fix the CI sequentially by following the order of
|
5c54ff6
to
ef4e8bc
Compare
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.