Fix Labelled Utterance Id type #20870
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @ziyadss 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.9.7)] | new version | base version |
|---|---|---|
| LUIS-Authoring.json | v3.0(8b9c587) | v3.0(main) |
| LUIS-Authoring.json | v2.0(8b9c587) | v2.0(main) |
| LUIS-Authoring.json | v3.0(8b9c587) | v3.0(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 v1.13.0) | new version | base version |
|---|---|---|
| authoring_2_0 | authoring_2_0(8b9c587) | authoring_2_0(main) |
| authoring_3_0_preview | authoring_3_0_preview(8b9c587) | authoring_3_0_preview(main) |
| authoring_3_0 | authoring_3_0(8b9c587) | authoring_3_0(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The operation 'Train_TrainVersion' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L3111 |
|
| The operation 'Train_TrainVersion' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L3054 |
|
| The operation 'Train_TrainVersion' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Authoring/stable/v3.0/LUIS-Authoring.json#L3111 |
|
| Guid used in model definition 'GuidResponse' for property 'GuidResponse'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9005 |
|
| Guid used in model definition 'EntityLabel' for property 'roleId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9169 |
|
| Guid used in model definition 'ModelInfo' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9284 |
|
| Guid used in model definition 'ModelInfoResponse' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9317 |
|
| Guid used in model definition 'ChildEntity' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9503 |
|
| Guid used in model definition 'ApplicationInfoResponse' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9787 |
|
| Guid used in model definition 'ApplicationSettings' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9933 |
|
| Guid used in model definition 'PublishSettings' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9954 |
|
| Guid used in model definition 'ModelTrainingInfo' for property 'modelId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10038 |
|
| Guid used in model definition 'PatternRuleUpdateObject' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10343 |
|
| Guid used in model definition 'EntityRole' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10411 |
|
| Guid used in model definition 'PatternRuleInfo' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10460 |
|
| Guid used in model definition 'GuidResponse' for property 'GuidResponse'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L8612 |
|
| Guid used in model definition 'ModelInfo' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L8860 |
|
| Guid used in model definition 'ModelInfoResponse' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L8893 |
|
| Guid used in model definition 'ChildEntity' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9075 |
|
| Guid used in model definition 'ApplicationInfoResponse' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9302 |
|
| Guid used in model definition 'ApplicationSettings' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9448 |
|
| Guid used in model definition 'PublishSettings' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9469 |
|
| Guid used in model definition 'ModelTrainingInfo' for property 'modelId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9553 |
|
| Guid used in model definition 'PatternRuleUpdateObject' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9858 |
|
| Guid used in model definition 'EntityRole' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9926 |
|
| Guid used in model definition 'PatternRuleInfo' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v2.0/LUIS-Authoring.json#L9975 |
|
| Guid used in model definition 'GuidResponse' for property 'GuidResponse'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v3.0/LUIS-Authoring.json#L9015 |
|
| Guid used in model definition 'EntityLabel' for property 'roleId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v3.0/LUIS-Authoring.json#L9179 |
|
| Guid used in model definition 'ModelInfo' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v3.0/LUIS-Authoring.json#L9294 |
|
| Guid used in model definition 'ModelInfoResponse' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Authoring/stable/v3.0/LUIS-Authoring.json#L9332 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation 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.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/8b9c587954ff5b47ea30b5ddd54fe8c5f1b38058/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md#tag-authoring_2_0">cognitiveservices/data-plane/LUIS/Authoring/readme.md#authoring_2_0
- "https://github.com/Azure/azure-rest-api-specs/blob/8b9c587954ff5b47ea30b5ddd54fe8c5f1b38058/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md#tag-authoring_3_0_preview">cognitiveservices/data-plane/LUIS/Authoring/readme.md#authoring_3_0_preview
- "https://github.com/Azure/azure-rest-api-specs/blob/8b9c587954ff5b47ea30b5ddd54fe8c5f1b38058/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md#tag-authoring_3_0">cognitiveservices/data-plane/LUIS/Authoring/readme.md#authoring_3_0
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'HierarchicalEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'CompositeEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'ClosedListEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'PrebuiltEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'CustomPrebuiltModel' inherits 'IntentClassifier' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'CustomPrebuiltModel' inherits 'EntityExtractor' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'CustomPrebuiltModel' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'EntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'RegexEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Schema 'PatternAnyEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_2_0", "details":"Error: 10 errors occured -- cannot continue." |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'HierarchicalEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'CompositeEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'ClosedListEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'PrebuiltEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'CustomPrebuiltModel' inherits 'IntentClassifier' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'CustomPrebuiltModel' inherits 'EntityExtractor' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'CustomPrebuiltModel' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'EntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'NDepthEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'RegexEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Schema 'PatternAnyEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0_preview", "details":"Error: 11 errors occured -- cannot continue." |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0", "details":"Schema 'HierarchicalEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0", "details":"Schema 'CompositeEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0", "details":"Schema 'ClosedListEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0", "details":"Schema 'PrebuiltEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0", "details":"Schema 'CustomPrebuiltModel' inherits 'IntentClassifier' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0", "details":"Schema 'CustomPrebuiltModel' inherits 'EntityExtractor' via an allOf that is already coming from parent 'ModelInfo'" |
|
"readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md", "tag":"authoring_3_0", "details":"Schema 'CustomPrebuiltModel' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'" |
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
ghost
added
the
customer-reported
|
Thank you for your contribution ziyadss! We will review the pull request and get back to you soon. |
|
Hi @ziyadss, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
@tjprescott can you please take a look at this PR and advise on the further steps we need to do to generate a LUIS authoring SDK? Regarding the errors in the above checks, most of them seem to be not related to the change. The only ones are the breaking change validations, and this is expected as the change is a breaking change but we need to do it to fix the bug in the SDK and have the datatype match what the service actually expects. |
tjprescott
approved these changes
Sep 29, 2022
|
@AmirGeorge you'll need to resolve the ModelValidation and SemanticValidation errors. The breaking change can be approved as a bug fix by reaching out to someone on the API stewardship board. @JeffreyRichter. |
JeffreyRichter
added
the
Approved-BreakingChange
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @ziyadss, 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. |
|
@tjprescott |
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
* exampleId parameter in delete to int64 * Id attribute in labelled utterances now int64 * Typo in exampleId description * Semantic fix * model validation uuids * Remove discriminator
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
ID width widening is a bug fix so a necessary breaking change
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your 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 Open API document (swagger) 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