-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[Hub Generated] Review request for Microsoft.DBforPostgreSQL to add version stable/2022-12-01 #21797
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?
[Hub Generated] Review request for Microsoft.DBforPostgreSQL to add version stable/2022-12-01 #21797
Conversation
…/2022-03-08-preview to version 2022-12-01
Hi, @ambrahma 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.10.2)] | new version | base version |
---|---|---|
Administrators.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
Backups.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
Capabilities.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
CheckNameAvailability.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
Configuration.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
Databases.json | 2022-12-01(1d283e8) | 2021-06-01(main) |
Databases.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
FirewallRules.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
FlexibleServers.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
Operations.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
PrivateDnsZone.json | 2022-12-01(1d283e8) | 2021-06-01(main) |
PrivateDnsZone.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
Replicas.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
ServerStartStopRestart.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
VirtualNetwork.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
common-types.json | 2022-12-01(1d283e8) | 2022-03-08-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 11 Errors, 29 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-12 | package-2022-12(1d283e8) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
LongRunningResponseStatusCode |
A 'put' operation 'Administrators_Create' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Administrators.json#L38 |
RPC-V2-ASYNC-1 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Administrators.json#L88 |
RPC-V2-ASYNC-1 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Administrators.json#L88 |
RPC-V2-ASYNC-7 |
APIVersionPattern |
The API Version parameter MUST be in the Year-Month-Date format (i.e. 2016-07-04.) NOTE that this is the en-US ordering of month and date. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/common-types.json#L4 |
|
CreateOperationAsyncResponseValidation |
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Configuration.json#L196 |
RPC-V2-ASYNC-1 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Configuration.json#L246 |
RPC-V2-ASYNC-1 |
LongRunningResponseStatusCode |
A 'put' operation 'FirewallRules_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/FirewallRules.json#L38 |
RPC-V2-ASYNC-1 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/FirewallRules.json#L88 |
RPC-V2-ASYNC-1 |
LongRunningResponseStatusCode |
A 'put' operation 'Servers_Create' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/FlexibleServers.json#L38 |
RPC-V2-ASYNC-1 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/FlexibleServers.json#L100 |
RPC-V2-ASYNC-1 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/FlexibleServers.json#L100 |
RPC-V2-ASYNC-7 |
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: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Administrators.json#L38 |
||
Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Capabilities.json#L38 |
||
'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/2022-12-01/Capabilities.json#L42 |
||
Schema should have a description or title. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Capabilities.json#L81 |
||
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/stable/2022-12-01/Capabilities.json#L100 |
||
Schema should have a description or title. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Capabilities.json#L279 |
||
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/stable/2022-12-01/Capabilities.json#L403 |
||
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/stable/2022-12-01/Capabilities.json#L408 |
||
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/stable/2022-12-01/Capabilities.json#L413 |
||
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/stable/2022-12-01/Capabilities.json#L438 |
||
OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/CheckNameAvailability.json#L42 |
||
OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailabilityWithLocation_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/CheckNameAvailability.json#L87 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: NameAvailability Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/CheckNameAvailability.json#L88 |
||
'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/2022-12-01/Configuration.json#L200 |
||
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/stable/2022-12-01/Configuration.json#L201 |
||
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/stable/2022-12-01/Configuration.json#L310 |
||
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/stable/2022-12-01/Configuration.json#L315 |
||
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/stable/2022-12-01/Configuration.json#L320 |
||
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/stable/2022-12-01/FirewallRules.json#L213 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
LongRunningResponseStatusCode |
A 'put' operation 'Databases_Create' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Databases.json#L38 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/Databases.json#L88 |
OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/PrivateDnsZone.json#L42 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.DBforPostgreSQL/stable/2022-12-01/PrivateDnsZone.json#L49 |
️❌
Avocado: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
INCONSISTENT_API_VERSION |
The API version of the swagger is inconsistent with its file path. readme: specification/postgresql/resource-manager/readme.md json: Microsoft.DBforPostgreSQL/stable/2022-12-01/common-types.json |
MULTIPLE_DEFAULT_TAGS |
The readme file has more than one default tag. readme: specification/postgresql/resource-manager/readme.md |
️❌
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-12-01'. The supported api-versions are '2021-06-01-preview, 2021-06-01, 2022-01-20-preview, 2022-03-08-preview, 2022-05-01-privatepreview, 2017-12-01-preview, 2017-12-01, 2022-11-08'." |
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView 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.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @ambrahma, 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.