-
Notifications
You must be signed in to change notification settings - Fork 7
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
[DO NOT MERGE][Internal testing] - testing updates to breaking change report #3143
Conversation
Next Steps to mergeNext steps that must be taken to merge this PR:
|
Swagger Generation Artifacts
|
Generated ApiView
|
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
agfood.json | 2020-05-12-preview(98372d7) | 2020-05-12-preview(main) |
analyzeconversations-authoring.json | 2023-11-15-preview(98372d7) | 2023-11-15-preview(main) |
analyzeconversations.json | 2023-11-15-preview(98372d7) | 2023-11-15-preview(main) |
analyzetext-authoring.json | 2023-11-15-preview(98372d7) | 2023-11-15-preview(main) |
analyzetext.json | 2023-11-15-preview(98372d7) | 2023-11-15-preview(main) |
questionanswering-authoring.json | 2023-11-15-preview(98372d7) | 2023-11-15-preview(main) |
analyzeconversations-authoring.json | 2023-04-01(98372d7) | 2023-04-01(main) |
analyzeconversations.json | 2023-04-01(98372d7) | 2023-04-01(main) |
analyzetext-authoring.json | 2023-04-01(98372d7) | 2023-04-01(main) |
analyzetext.json | 2023-04-01(98372d7) | 2023-04-01(main) |
common.json | 2023-04-01(98372d7) | 2023-04-01(main) |
questionanswering-authoring.json | 2023-04-01(98372d7) | 2023-04-01(main) |
Only 13 items are listed, please refer to log for more details.
️❌
Breaking Change(Cross-Version): 46 Errors, 114 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
analyzeconversations-authoring.json | 2023-11-16-preview(98372d7) | 2023-04-01(main) |
analyzeconversations-authoring.json | 2023-11-16-preview(98372d7) | 2023-11-15-preview(main) |
analyzeconversations.json | 2023-11-16-preview(98372d7) | 2023-04-01(main) |
analyzeconversations.json | 2023-11-16-preview(98372d7) | 2023-11-15-preview(main) |
analyzetext-authoring.json | 2023-11-16-preview(98372d7) | 2023-04-01(main) |
analyzetext-authoring.json | 2023-11-16-preview(98372d7) | 2023-11-15-preview(main) |
analyzetext.json | 2023-11-16-preview(98372d7) | 2023-04-01(main) |
analyzetext.json | 2023-11-16-preview(98372d7) | 2023-11-15-preview(main) |
common.json | 2023-11-16-preview(98372d7) | 2023-04-01(main) |
common.json | 2023-11-16-preview(98372d7) | 2023-11-15-preview(main) |
questionanswering-authoring.json | 2023-11-16-preview(98372d7) | 2023-04-01(main) |
questionanswering-authoring.json | 2023-11-16-preview(98372d7) | 2023-11-15-preview(main) |
questionanswering.json | 2023-11-16-preview(98372d7) | 2023-04-01(main) |
questionanswering.json | 2023-11-16-preview(98372d7) | 2023-11-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 13 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 13 items are listed, please refer to log for more details.
️🔄
LintDiff inProgress [Detail]
️️✔️
~[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌
Avocado: 14 Errors, 0 Warnings failed [Detail]
Only 13 items are listed, please refer to log for more details.
️❌
ModelValidation: 178 Errors, 0 Warnings failed [Detail]
Only 13 items are listed, please refer to log for more details.
Rule | Message |
---|---|
RESPONSE_STATUS_CODE_NOT_IN_SPEC |
Response statusCode 202 for operation QuestionAnsweringProjects_DeleteProject is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L201:22 ExampleUrl: examples/questionanswering/authoring/SuccessfulDeleteProject.json#L9:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 208 for operation QuestionAnsweringProjects_DeleteProject were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L202:18 ExampleUrl: examples/questionanswering/authoring/SuccessfulDeleteProject.json#L9:16 |
RESPONSE_STATUS_CODE_NOT_IN_SPEC |
Response statusCode 202 for operation QuestionAnsweringProjects_Export is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L288:22 ExampleUrl: examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json#L15:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 208 for operation QuestionAnsweringProjects_Export were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L295:18 ExampleUrl: examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json#L15:16 |
RESPONSE_STATUS_CODE_NOT_IN_SPEC |
Response statusCode 202 for operation QuestionAnsweringProjects_Import is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L392:22 ExampleUrl: examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json#L65:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 208 for operation QuestionAnsweringProjects_Import were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L393:18 ExampleUrl: examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json#L65:16 |
RESPONSE_STATUS_CODE_NOT_IN_SPEC |
Response statusCode 202 for operation QuestionAnsweringProjects_DeployProject is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L479:22 ExampleUrl: examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json#L10:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 208 for operation QuestionAnsweringProjects_DeployProject were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L480:18 ExampleUrl: examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json#L10:16 |
RESPONSE_STATUS_CODE_NOT_IN_SPEC |
Response statusCode 202 for operation QuestionAnsweringProjects_UpdateSources is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L772:22 ExampleUrl: examples/questionanswering/authoring/SuccessfulUpdateSources.json#L39:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 208 for operation QuestionAnsweringProjects_UpdateSources were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L773:18 ExampleUrl: examples/questionanswering/authoring/SuccessfulUpdateSources.json#L39:16 |
RESPONSE_STATUS_CODE_NOT_IN_SPEC |
Response statusCode 202 for operation QuestionAnsweringProjects_UpdateQnas is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L918:22 ExampleUrl: examples/questionanswering/authoring/SuccessfulUpdateQnas.json#L66:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 208 for operation QuestionAnsweringProjects_UpdateQnas were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L919:18 ExampleUrl: examples/questionanswering/authoring/SuccessfulUpdateQnas.json#L66:16 |
RESPONSE_STATUS_CODE_NOT_IN_SPEC |
Response statusCode 201 for operation Extensions_Create is provided in exampleResponseValue, however it is not present in the swagger spec. Url: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L33:22 ExampleUrl: preview/2020-05-12-preview/examples/Extensions_Create.json#L9:16 |
️❌
SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_PATH_PARAMETER_DEFINITION |
Path parameter is declared but is not defined: extensionId JsonUrl: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L10:14 |
️❌
~[NotRequired_Staging] SpellCheck: 4 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Unknown word (extdsension), please fix the error or add words to ./custom-words.txt path: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L14:33 |
HowToFix |
Unknown word (Crdte), please fix the error or add words to ./custom-words.txt path: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L48:23 |
HowToFix |
Unknown word (responsec), please fix the error or add words to ./custom-words.txt path: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L211:35 |
HowToFix |
Unknown word (responsse), please fix the error or add words to ./custom-words.txt path: Language/preview/2023-11-16-preview/questionanswering-authoring.json#L251:35 |
️️✔️
PR Summary succeeded [Detail] [Expand]
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Please address or respond to feedback from the ARM API reviewer. |
Hi @konrad-jamrozik! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
This is a PR made by the Azure SDK Engineering System team.