-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Update LRO final state via operation and change integer format for Cosmos DB for PostgreSQL #23876
Conversation
Hi, @senatol 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.10.4)] | new version | base version |
---|---|---|
postgresqlhsc.json | 2022-11-08(4c3395b) | 2022-11-08(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 v2.1.1) | new version | base version |
---|---|---|
package-2022-11-08 | package-2022-11-08(4c3395b) | package-2022-11-08(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L163 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L396 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L680 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L680 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L795 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L795 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L867 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L867 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1024 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1125 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1125 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1239 |
LroPostReturn |
A LRO POST operation must have both 200 & 202 return codes. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1256 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1307 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1361 |
LroPostReturn |
A LRO POST operation must have both 200 & 202 return codes. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1415 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1531 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1575 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1676 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1676 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L1790 |
200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L262 |
|
The resource ServerConfiguration does not have a corresponding delete operation. Location: Microsoft.DBforPostgreSQL/stable/2022-11-08/postgresqlhsc.json#L2465 |
️️✔️
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.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView 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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @senatol, 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. |
Hi @senatol, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hello @zedy-wj, |
@tadelesh - Please help review Go breaking changes. |
Hello @zedy-wj , |
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:
Minor update on integer format and LRO operation due to errors during SDK generation tests
Not released any SDK's yet.
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.