Fix examples id type & typo in description #20826
Closed
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
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| LUIS-Authoring.json | v3.0(61e4fdf) | v3.0(main) |
| LUIS-Authoring.json | v2.0(61e4fdf) | v2.0(main) |
| LUIS-Authoring.json | v3.0(61e4fdf) | 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(61e4fdf) | authoring_2_0(main) |
| authoring_3_0_preview | authoring_3_0_preview(61e4fdf) | authoring_3_0_preview(main) |
| authoring_3_0 | authoring_3_0(61e4fdf) | authoring_3_0(main) |
The following errors/warnings exist before current PR submission:
Only 20 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#L9507 |
|
| 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#L9794 |
|
| 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#L9940 |
|
| 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#L9961 |
|
| 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#L10045 |
|
| 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#L10350 |
|
| 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#L10420 |
|
| 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#L10469 |
|
| 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#L9079 |
|
| 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#L9308 |
️️✔️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: 50 Errors, 0 Warnings failed [Detail]
Only 20 items are listed, please refer to log for more details.
️❌SemanticValidation: 26 Errors, 0 Warnings failed [Detail]
Only 20 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Intent Classifier JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9578:25 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: N-Depth Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9621:30 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Hierarchical Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9396:36 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Composite Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9425:33 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: List Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9454:34 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Prebuilt Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9483:32 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9598:24 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Regex Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L10365:29 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Pattern.Any Entity Extractor JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L10391:34 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Intent Classifier JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L9132:25 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Entity Extractor JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L9152:24 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Hierarchical Entity Extractor JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L8968:36 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Composite Entity Extractor JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L8997:33 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: List Entity Extractor JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L9026:34 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Prebuilt Entity Extractor JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L9055:32 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Regex Entity Extractor JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L9879:29 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Pattern.Any Entity Extractor JsonUrl: Authoring/stable/v2.0/LUIS-Authoring.json#L9905:34 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Intent Classifier JsonUrl: Authoring/stable/v3.0/LUIS-Authoring.json#L9593:25 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: N-Depth Entity Extractor JsonUrl: Authoring/stable/v3.0/LUIS-Authoring.json#L9636:30 |
|
Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Hierarchical Entity Extractor JsonUrl: Authoring/stable/v3.0/LUIS-Authoring.json#L9411:36 |
️️✔️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/61e4fdf76b26f140c7874bf30dcf4108e043fc61/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/61e4fdf76b26f140c7874bf30dcf4108e043fc61/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/61e4fdf76b26f140c7874bf30dcf4108e043fc61/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md#tag-authoring_3_0">cognitiveservices/data-plane/LUIS/Authoring/readme.md#authoring_3_0
Only 20 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'" |
️️✔️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.
|
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 Generation Artifacts
|
|
Swagger pipeline started 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
|
ziyadss
force-pushed
the
integer-overflow-fix
branch
from
61e4fdf to
7d5d1db
Compare
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
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!
Click here for links to tools, specs, guidelines & other good stuff