-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Galkeinan/change date to march #25510
Galkeinan/change date to march #25510
Conversation
2022-08-17 & 2022-09-25 (according to 45554387 item)
https://github.com/galkeinan-microsoft/azure-rest-api-specs into galkeinan/add-deprecation-message-to-old-api-versions
https://github.com/galkeinan-microsoft/azure-rest-api-specs into galkeinan/add-deprecation-message-to-old-api-versions
…r ProductManager request
Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
Next Steps to Merge |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
search.json | 2022-08-17-preview(001a7c1) | 2022-08-17-preview(main) |
search.json | 2022-09-25-preview(001a7c1) | 2022-09-25-preview(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.4) | new version | base version |
---|---|---|
package-2022-08-17-preview | package-2022-08-17-preview(001a7c1) | package-2022-08-17-preview(main) |
package-2022-09-25-preview | package-2022-09-25-preview(001a7c1) | package-2022-09-25-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ValidFormats |
'decimal' is not a known format. Location: Search/preview/2022-08-17-preview/search.json#L961 |
ValidFormats |
'decimal' is not a known format. Location: Search/preview/2022-08-17-preview/search.json#L966 |
The error property in the error response schema should be required.Location: Search/preview/2022-08-17-preview/search.json#L515 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-08-17-preview/search.json#L515 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L682 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L697 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L705 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L717 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L982 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L1002 |
|
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: Search/preview/2022-08-17-preview/search.json#L1021 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L1068 |
|
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: Search/preview/2022-08-17-preview/search.json#L1076 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L1122 |
|
Property should have a defined type. Location: Search/preview/2022-08-17-preview/search.json#L1166 |
|
A required parameter should not specify a default value. Location: Search/preview/2022-09-25-preview/search.json#L501 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-09-25-preview/search.json#L514 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-09-25-preview/search.json#L514 |
|
A required parameter should not specify a default value. Location: Search/preview/2022-09-25-preview/search.json#L942 |
|
Avoid the use of x-nullable. Location: Search/preview/2022-09-25-preview/search.json#L947 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-09-25-preview/search.json#L955 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-09-25-preview/search.json#L955 |
|
Since operation response has model definition in array type, it should be of the form '_list'. Location: Search/preview/2022-09-25-preview/search.json#L973 |
|
Based on the response model schema, operation 'Suggestions_GetProducts' might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-09-25-preview/search.json#L973 |
|
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2022-09-25-preview/search.json#L973 |
|
Avoid the use of x-nullable. Location: Search/preview/2022-09-25-preview/search.json#L1319 |
|
A required parameter should not specify a default value. Location: Search/preview/2022-09-25-preview/search.json#L1336 |
|
The error property in the error response schema should be required.Location: Search/preview/2022-09-25-preview/search.json#L1348 |
|
Error schema should define code and message properties as required.Location: Search/preview/2022-09-25-preview/search.json#L1348 |
|
Property should have a defined type. Location: Search/preview/2022-09-25-preview/search.json#L1555 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView 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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @mikekistler @weidongxu-microsoft - maybe you guys can approve? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. 👍
Hi @markweitzel \ @johanste |
@tjprescott can you merge this PR? |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
fix #25647
fix #25815