Fix Cognitive Services data-plane specs with missing type:object#14172
Fix Cognitive Services data-plane specs with missing type:object#14172timotheeguerin wants to merge 1 commit intoAzure:mainfrom
Conversation
Swagger Validation Report
|
| Rule | Message |
|---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/d38bca3fe7b43c1c288a7f05009f6668b860199f/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0", "old":"https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0", "details":"Command failed: node /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@azure/oad@0.8.11/node_modules/autorest/dist/app.js /tmp/readme.oad.old.md --tag=oad-default-tag --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nFATAL: swagger-document/compose - FAILED\nFATAL: Error: '$.security' has incompatible values (---\n- apim_key: []\n, ---\n- auth_key: []\n).\n Error: '$.security' has incompatible values (---\n- apim_key: []\n, ---\n- auth_key: []\n).\n" |
Only 10 items are listed, please refer to log for more details.
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- data-plane/ContentModerator/readme.md tag:release_1_0
- data-plane/FormRecognizer/readme.md tag:release_1_0
- LUIS/Authoring/readme.md tag:authoring_3_0_preview
- LUIS/Authoring/readme.md tag:authoring_2_0
- LUIS/Runtime/readme.md tag:runtime_2_0
- data-plane/Personalizer/readme.md tag:release_1_0
- data-plane/QnAMaker/readme.md tag:runtime_release_4_0
- data-plane/QnAMaker/readme.md tag:release_5_0_preview.2
- data-plane/QnAMaker/readme.md tag:release_5_0_preview.1
- data-plane/QnAMaker/readme.md tag:release_4_0
- SpeakerRecognition/Identification/readme.md tag:identification_2_0_preview
- SpeakerRecognition/Verification/readme.md tag:verification_2_0_preview
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.5
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.4
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.3
- data-plane/TextAnalytics/readme.md tag:release_3_1
- Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- data-plane/ContentModerator/readme.md tag:release_1_0
- data-plane/FormRecognizer/readme.md tag:release_1_0
- LUIS/Authoring/readme.md tag:authoring_3_0_preview
- LUIS/Authoring/readme.md tag:authoring_2_0
- LUIS/Runtime/readme.md tag:runtime_2_0
- data-plane/Personalizer/readme.md tag:release_1_0
- data-plane/QnAMaker/readme.md tag:runtime_release_4_0
- data-plane/QnAMaker/readme.md tag:release_5_0_preview.2
- data-plane/QnAMaker/readme.md tag:release_5_0_preview.1
- data-plane/QnAMaker/readme.md tag:release_4_0
- SpeakerRecognition/Identification/readme.md tag:identification_2_0_preview
- SpeakerRecognition/Verification/readme.md tag:verification_2_0_preview
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.5
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.4
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.3
- data-plane/TextAnalytics/readme.md tag:release_3_1
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_FindFaces' Location: ContentModerator/stable/v1.0/ContentModerator.json#L31 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_OCR' Location: ContentModerator/stable/v1.0/ContentModerator.json#L70 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_Evaluate' Location: ContentModerator/stable/v1.0/ContentModerator.json#L115 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_Match' Location: ContentModerator/stable/v1.0/ContentModerator.json#L154 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Reviews_AddVideoFrame' Location: ContentModerator/stable/v1.0/ContentModerator.json#L1411 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_FindFacesFileInput' Location: ContentModerator/stable/v1.0/ContentModerator.json#L1659 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_OCRFileInput' Location: ContentModerator/stable/v1.0/ContentModerator.json#L1804 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_EvaluateFileInput' Location: ContentModerator/stable/v1.0/ContentModerator.json#L1851 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ImageModeration_MatchFileInput' Location: ContentModerator/stable/v1.0/ContentModerator.json#L1993 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ListManagementImage_AddImageFileInput' Location: ContentModerator/stable/v1.0/ContentModerator.json#L2092 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
INVALID_TYPE |
Expected type string but found type object Url: Runtime/stable/v2.0/LUIS-Runtime.json#L157 |
couldn't understand path 0,VideoFrames,0,Timestamp |
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/d38bca3fe7b43c1c288a7f05009f6668b860199f/specification/cognitiveservices/data-plane/ContentModerator/stable/v1.0/ContentModerator.json" |
internal error: section.value.startsWith is not a function |
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/d38bca3fe7b43c1c288a7f05009f6668b860199f/specification/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json" |
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
internal error: section.value.startsWith is not a function |
"role":"Semantic Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/d38bca3fe7b43c1c288a7f05009f6668b860199f/specification/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json" |
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️[Staging] SDK Track2 Validation: 5 Warnings warning [Detail]
- The following tags are being changed in this PR
- cognitiveservices/data-plane/ContentModerator/readme.md#release_1_0
- cognitiveservices/data-plane/FormRecognizer/readme.md#release_1_0
- cognitiveservices/data-plane/LUIS/Authoring/readme.md#authoring_2_0
- cognitiveservices/data-plane/LUIS/Authoring/readme.md#authoring_3_0_preview
- cognitiveservices/data-plane/LUIS/Runtime/readme.md#runtime_2_0
- cognitiveservices/data-plane/Personalizer/readme.md#release_1_0
- cognitiveservices/data-plane/QnAMaker/readme.md#release_4_0
- cognitiveservices/data-plane/QnAMaker/readme.md#runtime_release_4_0
- cognitiveservices/data-plane/QnAMaker/readme.md#release_5_0_preview.1
- cognitiveservices/data-plane/QnAMaker/readme.md#release_5_0_preview.2
- cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md#identification_2_0_preview
- cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md#verification_2_0_preview
- cognitiveservices/data-plane/TextAnalytics/readme.md#release_3_1_preview.3
- cognitiveservices/data-plane/TextAnalytics/readme.md#release_3_1_preview.4
- cognitiveservices/data-plane/TextAnalytics/readme.md#release_3_1_preview.5
- cognitiveservices/data-plane/TextAnalytics/readme.md#release_3_1
| Rule | Message |
|---|---|
| "readme":"cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md", "tag":"identification_2_0_preview", "details":"The schema 'TiProfileInfoList-profiles' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json#/components/schemas/TiProfileInfoList-profiles" |
|
| "readme":"cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md", "tag":"identification_2_0_preview", "details":"The schema 'IdentifiedSingleSpeakerInfo-profilesRanking' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json#/components/schemas/IdentifiedSingleSpeakerInfo-profilesRanking" |
|
| "readme":"cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md", "tag":"verification_2_0_preview", "details":"The schema 'TdProfileInfoList-profiles' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json#/components/schemas/TdProfileInfoList-profiles" |
|
| "readme":"cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md", "tag":"verification_2_0_preview", "details":"The schema 'paths·8hgwbp·text_dependent-phrases-locale·get·responses·200·content·application-json·schema' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json#/components/schemas/paths·8hgwbp·text_dependent-phrases-locale·get·responses·200·content·application-json·schema" |
|
| "readme":"cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md", "tag":"verification_2_0_preview", "details":"The schema 'TiProfileInfoList-profiles' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json#/components/schemas/TiProfileInfoList-profiles" |
|
| 💬 AutorestCore/Exception | "readme":"cognitiveservices/data-plane/ContentModerator/readme.md", "tag":"release_1_0", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"cognitiveservices/data-plane/ContentModerator/readme.md", "tag":"release_1_0", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
PreCheck/DuplicateInheritance |
"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'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi, @timotheeguerin 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. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
|
Hi @timotheeguerin, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @timotheeguerin, 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. |
625f110 to
69b2e63
Compare
|
Hi, @timotheeguerin. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Hi, @timotheeguerin. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
b918240 to
d38bca3
Compare
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Using newly made fixer tool
autorest-fixerto automatically fix long standing warnings due to missingtype:objectin specs.Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
Result of running the tool: