azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
TA 2023-05-15-preview metadata fix
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
- [x] a public preview
- [ ] GA release
Change Scope
This Change is to change the swagger definition to match the actual output of the API.
❔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.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
Hi, @quentinRobinson! Thank you for your pull request. To help get your PR merged:
Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. ![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 14 Errors, 112 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| analyzetext.json | 2023-04-15-preview(7591318) | 2023-04-01(main) |
Only 26 items are listed, please refer to log for more details.
️❌Breaking Change(Cross-Version): 32 Errors, 62 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| analyzetext.json | 2023-04-15-preview(7591318) | 2023-04-01(main) |
| analyzetext.json | 2023-04-15-preview(7591318) | 2022-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 26 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'string'. New: cognitiveservices/data-plane/Language/common.json#L209:9 Old: Language/stable/2023-04-01/analyzetext.json#L2412:9 |
|
The new version has a different type '' than the previous one 'object'. New: cognitiveservices/data-plane/Language/common.json#L403:5 Old: Language/stable/2023-04-01/common.json#L377:5 |
|
The new version has new required property 'entities' that was not found in the old version. |
|
The new version has new required property 'relations' that was not found in the old version. |
|
The new version has new required property 'id' that was not found in the old version. |
|
The new version has new required property 'warnings' that was not found in the old version. |
|
The new version has new required property 'entities, relations, id, warnings' that was not found in the old version. New: cognitiveservices/data-plane/Language/analyzetext.json#L869:11 Old: Language/stable/2023-04-01/analyzetext.json#L794:11 |
|
The new version has new required property 'entities' that was not found in the old version. |
|
The new version has new required property 'id' that was not found in the old version. |
|
The new version has new required property 'warnings' that was not found in the old version. |
|
The new version has new required property 'entities, id, warnings' that was not found in the old version. New: cognitiveservices/data-plane/Language/analyzetext.json#L2194:11 Old: Language/stable/2023-04-01/analyzetext.json#L1474:11 |
|
The new version has new required property 'entities' that was not found in the old version. |
|
The new version has new required property 'id' that was not found in the old version. |
|
The new version has new required property 'warnings' that was not found in the old version. |
The following breaking changes are detected by comparison with the latest preview version:
Only 26 items are listed, please refer to log for more details.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| release_2022-07-01-preview | release_2022-07-01-preview(7591318) | release_2022-07-01-preview(release-cognitiveservices-Language-2023-04-15-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: cognitiveservices/data-plane/Language/analyzetext.json#L3205 |
The following errors/warnings exist before current PR submission:
Only 26 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The host parameter must be called 'endpoint'. Location: cognitiveservices/data-plane/Language/analyzetext.json#L39 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: cognitiveservices/data-plane/Language/analyzetext.json#L39 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: cognitiveservices/data-plane/Language/analyzetext.json#L1812 |
|
The integer type does not have a format, please add it. Location: cognitiveservices/data-plane/Language/analyzetext.json#L3837 |
|
The integer type does not have a format, please add it. Location: cognitiveservices/data-plane/Language/analyzetext.json#L4268 |
|
The integer type does not have a format, please add it. Location: cognitiveservices/data-plane/Language/analyzetext.json#L4271 |
|
The integer type does not have a format, please add it. Location: cognitiveservices/data-plane/Language/analyzetext.json#L4274 |
|
The integer type does not have a format, please add it. Location: cognitiveservices/data-plane/Language/analyzetext.json#L4277 |
| :warning: OperationId | OperationId should be of the form 'Noun_Verb' Location: cognitiveservices/data-plane/Language/analyzetext.json#L49 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: cognitiveservices/data-plane/Language/analyzetext.json#L80 |
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: cognitiveservices/data-plane/Language/analyzetext.json#L82 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: cognitiveservices/data-plane/Language/analyzetext.json#L161 |
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: cognitiveservices/data-plane/Language/analyzetext.json#L163 |
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: cognitiveservices/data-plane/Language/analyzetext.json#L163 |
| :warning: GetInOperationName | 'GET' operation 'AnalyzeText_JobStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: cognitiveservices/data-plane/Language/analyzetext.json#L200 |
| :warning: OperationId | OperationId for get method should contain 'Get' or 'list' Location: cognitiveservices/data-plane/Language/analyzetext.json#L200 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: cognitiveservices/data-plane/Language/analyzetext.json#L206 |
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: cognitiveservices/data-plane/Language/analyzetext.json#L222 |
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: cognitiveservices/data-plane/Language/analyzetext.json#L222 |
| :warning: SchemaTypeAndFormat | Schema with type: integer should specify format Location: cognitiveservices/data-plane/Language/analyzetext.json#L222 |
| :warning: SchemaTypeAndFormat | Schema with type: integer should specify format Location: cognitiveservices/data-plane/Language/analyzetext.json#L222 |
| :warning: SchemaTypeAndFormat | Schema with type: integer should specify format Location: cognitiveservices/data-plane/Language/analyzetext.json#L222 |
| :warning: SchemaTypeAndFormat | Schema with type: integer should specify format Location: cognitiveservices/data-plane/Language/analyzetext.json#L222 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: cognitiveservices/data-plane/Language/analyzetext.json#L226 |
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: cognitiveservices/data-plane/Language/analyzetext.json#L228 |
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: cognitiveservices/data-plane/Language/analyzetext.json#L228 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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.
️⌛Please ignore, experimental check pending [Detail]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️⚠️ azure-sdk-for-net-track2 warning [Detail]
⚠️Warning [Logs] Generate from c558343614a1cb845e111cb218d17712da3b69af. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json warn No file changes detected after generation warn Skip detect changed packages
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from c558343614a1cb845e111cb218d17712da3b69af. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.8.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice warn No file changes detected after generation warn No package detected after generation
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.
Hi @quentinRobinson! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.
You cannot proceed with merging this PR until you complete one of the following action items:
ACTION ITEM ALTERNATIVE A: Fix the breaking change.
Please consult the documentation provided in the relevant validation failures.
ACTION ITEM ALTERNATIVE B: Request approval.
Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.
ACTION ITEM ALTERNATIVE C: Report false positive.
If you think there are no breaking changes, i.e. the validation should pass yet it fails, then please explain why in a PR comment and @ the PR assignee.
Hi @quentinRobinson! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic Validation | Fix-SemanticValidation-Error | High |
| Model Validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | High |
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.
The breaking changes in the PR are false positives. The metadata was introduced in this preview version and has never been GA'd
The only breaking changes I see are an old one that was intentional and previously approved i.e., adding type (of either "string" or "object" as needed) to satisfy some other validation failures.
However, please add "Inclusivity" to the dictionary to resolve the spellcheck error once and for all.
The breaking changes around adding type: string and type: object was previously approved, nor consequential to our code generation that hasn't already been solved.