Skip to content
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

Merged

Conversation

galkeinan-microsoft
Copy link
Member

@galkeinan-microsoft galkeinan-microsoft commented Aug 24, 2023

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.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

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.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

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

galkeinan-microsoft and others added 30 commits August 6, 2023 17:55
2022-08-17 & 2022-09-25 (according to 45554387 item)
@galkeinan-microsoft galkeinan-microsoft requested a review from a team as a code owner August 24, 2023 12:35
@galkeinan-microsoft galkeinan-microsoft requested review from markweitzel and johanste and removed request for a team August 24, 2023 12:35
@openapi-pipeline-app
Copy link

Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

@openapi-pipeline-app
Copy link

Swagger pipeline can not start as the pull request has merge conflicts.

@openapi-pipeline-app
Copy link

Swagger pipeline can not start as the pull request has merge conflicts.

@openapi-pipeline-app
Copy link

Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

Next Steps to Merge

⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
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
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Search/preview/2022-08-17-preview/search.json#L515
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Search/preview/2022-08-17-preview/search.json#L515
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L682
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L697
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L705
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L717
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L982
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L1002
⚠️ EnumInsteadOfBoolean 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
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L1068
⚠️ EnumInsteadOfBoolean 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
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L1122
⚠️ PropertyType Property should have a defined type.
Location: Search/preview/2022-08-17-preview/search.json#L1166
⚠️ ParameterDefaultNotAllowed A required parameter should not specify a default value.
Location: Search/preview/2022-09-25-preview/search.json#L501
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Search/preview/2022-09-25-preview/search.json#L514
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Search/preview/2022-09-25-preview/search.json#L514
⚠️ ParameterDefaultNotAllowed A required parameter should not specify a default value.
Location: Search/preview/2022-09-25-preview/search.json#L942
⚠️ Nullable Avoid the use of x-nullable.
Location: Search/preview/2022-09-25-preview/search.json#L947
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Search/preview/2022-09-25-preview/search.json#L955
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Search/preview/2022-09-25-preview/search.json#L955
⚠️ ListInOperationName 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
⚠️ PageableOperation 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
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Search/preview/2022-09-25-preview/search.json#L973
⚠️ Nullable Avoid the use of x-nullable.
Location: Search/preview/2022-09-25-preview/search.json#L1319
⚠️ ParameterDefaultNotAllowed A required parameter should not specify a default value.
Location: Search/preview/2022-09-25-preview/search.json#L1336
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Search/preview/2022-09-25-preview/search.json#L1348
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Search/preview/2022-09-25-preview/search.json#L1348
⚠️ PropertyType 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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

Generated ApiView

Language Package Name ApiView Link
Swagger marketplacecatalog-data-plane-Search https://apiview.dev/Assemblies/Review/ffd341ab043b49b0be2477d189466f43

@galkeinan-microsoft
Copy link
Member Author

galkeinan-microsoft commented Aug 24, 2023

Hi,
We changed the deprecation date to from January to March.
We don’t have 6 months notice, so PM decided to postpone the date to March.
See the PR that was approved yesterday by @weidongxu-microsoft : #25194 (not published)

@mikekistler @weidongxu-microsoft - maybe you guys can approve?
("azure-deprecating" header value will be updated with the new date as well)

Copy link
Member

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. 👍

@galkeinan-microsoft
Copy link
Member Author

Hi @markweitzel \ @johanste
can you please merge this PR? (@mikekistler already approved)

@johanste johanste added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Aug 24, 2023
@galkeinan-microsoft
Copy link
Member Author

@tjprescott can you merge this PR?
already approved

@tjprescott tjprescott merged commit 3783498 into Azure:main Aug 24, 2023
@openapi-pipeline-app
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. data-plane
Projects
None yet
5 participants