PostgreSQL Flexible Server GA Swagger API changes #14653
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
…1-06-01-preview and 2021-06-01
xunsun-commits
requested review from
00Kai0,
ArcturusZhang,
jsntcy,
msyyc,
RAY-316 and
zhangyan133
as code owners
|
Hi, @xunsun-commits 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 |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Since operation 'LocationBasedCapabilities_Execute' 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/2021-06-01-preview/postgresql.json#L916 |
|
| Since operation 'VirtualNetworkSubnetUsage_Execute' response has model definition 'array', 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/2021-06-01-preview/postgresql.json#L958 |
|
| Since operation 'LocationBasedCapabilities_Execute' 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/stable/2021-06-01/postgresql.json#L916 |
|
| Since operation 'VirtualNetworkSubnetUsage_Execute' response has model definition 'array', 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/stable/2021-06-01/postgresql.json#L958 |
|
| '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/2021-06-01-preview/postgresql.json#L916 |
|
| '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/stable/2021-06-01/postgresql.json#L916 |
|
| '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/2021-06-01-preview/postgresql.json#L813 |
|
| '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/stable/2021-06-01/postgresql.json#L813 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json#L1002 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json#L1002 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| 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/stable/2021-06-01/postgresql.json#L1885 |
|
| 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/2021-06-01-preview/postgresql.json#L1885 |
️⚠️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.
️❌Cross-Version Breaking Changes: 182 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-06-01-preview/postgresql.json compared with base:preview/2020-02-14-preview/postgresql.json
- current:stable/2021-06-01/Databases.json compared with base:preview/2020-11-05-preview/Databases.json
- current:stable/2021-06-01/postgresql.json compared with base:preview/2020-02-14-preview/postgresql.json
- current:preview/2021-06-01-preview/postgresql.json compared with base:stable/2017-12-01/postgresql.json
- current:stable/2021-06-01/postgresql.json compared with base:stable/2017-12-01/postgresql.json
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L37:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L244:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/servers' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L286:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/replicas' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L325:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/restart' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L370:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L413:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L567:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L612:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L757:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases/{databaseName}' removed or restructured? Old: Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json#L799:5 |
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"postgresql/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"postgresql/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"postgresql/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"postgresql/resource-manager/readme.md",
"tag":"package-2021-06-01-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"postgresql/resource-manager/readme.md",
"tag":"package-2021-06-01-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @xunsun-commits your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ArcturusZhang |
26 tasks
This was referenced Jun 3, 2021
majastrz
added
ARMSignedOff
majastrz
approved these changes
Jun 3, 2021
There was a problem hiding this comment.
Signed off from ARM side. @ArcturusZhang I went by the linter results to determine whether the breaking changes review is required. It looks like it passed.
… package-2020-01-01. Reason is that the CSharp md file hasn't support flexible server yet, so the CSharp build will fail in latest version.
...ger/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/CheckNameAvailability.json
Outdated
Show resolved
Hide resolved
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ArcturusZhang
approved these changes
Jun 8, 2021
This was referenced Jun 8, 2021
26 tasks
asager
pushed a commit
to asager/azure-rest-api-specs
that referenced
this pull request
Jun 24, 2021
* Copy existing files from 2020-02-14-preview to 2021-06-01-preview and 2021-06-01 * Copy existing Databases API files from 2020-11-05-preview to 2021-06-01 * Copy existing VNET API files from 2021-03-31-privatepreview to 2021-06-01 * Copy existing ServerRestartWithFailover.json file from Azure@905c382 to 2021-06-01-preview and 2021-06-01 * Copy remaining existing change of restartWithFailover * Update files of 2021-06-01 and 2021-06-01-preview to the latest API * Revert readme.md's PostgreSQLManagementClient default version back to package-2020-01-01. Reason is that the CSharp md file hasn't support flexible server yet, so the CSharp build will fail in latest version. * As customer requested, add PUT to configurations API * Fixed 2021-06-01-preview some examples use 2020-02-14-preview
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Copy existing files from 2020-02-14-preview to 2021-06-01-preview and 2021-06-01 * Copy existing Databases API files from 2020-11-05-preview to 2021-06-01 * Copy existing VNET API files from 2021-03-31-privatepreview to 2021-06-01 * Copy existing ServerRestartWithFailover.json file from Azure@905c382 to 2021-06-01-preview and 2021-06-01 * Copy remaining existing change of restartWithFailover * Update files of 2021-06-01 and 2021-06-01-preview to the latest API * Revert readme.md's PostgreSQLManagementClient default version back to package-2020-01-01. Reason is that the CSharp md file hasn't support flexible server yet, so the CSharp build will fail in latest version. * As customer requested, add PUT to configurations API * Fixed 2021-06-01-preview some examples use 2020-02-14-preview
11 tasks
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.
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.
What's the purpose of the update?
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
2021 May.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
2021 June.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
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 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.