[Language] Remove duplication for PreBuiltResult and InputError#23788
[Language] Remove duplication for PreBuiltResult and InputError#23788heaths merged 4 commits intoAzure:mainfrom
Conversation
|
Hi, @minhanh-phan 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 |
|---|---|---|
| analyzetext.json | 2023-04-01(94e1528) | 2023-04-01(main) |
| common.json | 2023-04-01(94e1528) | 2023-04-01(main) |
| analyzetext.json | 2023-04-01(94e1528) | 2023-04-01(main) |
| common.json | 2023-04-01(94e1528) | 2023-04-01(main) |
️❌Breaking Change(Cross-Version): 3 Errors, 111 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| analyzetext.json | 2023-04-01(94e1528) | 2023-04-01(main) |
| analyzetext.json | 2023-04-01(94e1528) | 2022-10-01-preview(main) |
| common.json | 2023-04-01(94e1528) | 2023-04-01(main) |
| common.json | 2023-04-01(94e1528) | 2022-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The '$ref' property points to different models in the old and new versions. New: cognitiveservices/data-plane/Language/common.json#L383:11 Old: Language/stable/2023-04-01/common.json#L383:11 |
|
The new version removes the 'additionalProperties' element. New: cognitiveservices/data-plane/Language/common.json#L345:5 Old: Language/stable/2023-04-01/common.json#L345:5 |
|
The new version removes the 'additionalProperties' element. New: cognitiveservices/data-plane/Language/common.json#L387:9 Old: Language/stable/2023-04-01/common.json#L387:9 |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 218 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| release_2023-04-01 | release_2023-04-01(94e1528) | release_2023-04-01(main) |
| release_2023_04_01 | release_2023_04_01(94e1528) | release_2023_04_01(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️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.
ghost
added
the
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @minhanh-phan, 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. |
Would it be better to do it the other way around: Remove it from analyzetext.json and keep it in common.json? |
Sorry bad wording, this is what I'm suggesting 😆 |
|
@kristapratico Yes, I miss this. Pushed the change. Thank you for noticing that. |
Generates successfully for me, thank you! |
heaths
added
the
Approved-BreakingChange
|
The breaking changes are expected and have not previous GA'd. This is effectively a correction. |
minhanh-phan
requested review from
markweitzel and
mikekistler
and removed request for
a team
7 participants
Data Plane API - Pull Request
PreBuiltResultandRequestStatisticsbreak autorest schema check because they are duplicated in bothcommon.jsonandanalyzetext.json. Edit all theanalyzetext.jsonreference to point tocommon.json. UnifyInputErrorwithDocumentError.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.
❔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