azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Language 2022-07-01-preview swagger
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [ ] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [ ] PowerShell
- [ ] CLI
- [ ] Terraform
- [ ] No refresh required for updates in this PR
Contribution checklist:
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[ ] Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
-
[ ] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
-
[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
- [ ] Removing API(s) in a stable version
- [ ] Removing properties in a stable version
- [ ] Removing API version(s) in a stable version
- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors
- [ ] Updating API(s) in public preview over 1 year (refer to Retirement of Previews)
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.
Hi, @nourhaanfarid Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![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: 3 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| analyzetext.json | 2022-05-01(fe6e976) | 2022-05-01(main) |
| TextAnalytics.json | v3.1(fe6e976) | v3.1(main) |
| Rule | Message |
|---|---|
|
The new version is removing enum value(s) 'BODY_STRUCTURE, AGE, GENDER, EXAMINATION_NAME, DATE, DIRECTION, FREQUENCY, MEASUREMENT_VALUE, MEASUREMENT_UNIT, RELATIONAL_OPERATOR, TIME, GENE_OR_PROTEIN, VARIANT, ADMINISTRATIVE_EVENT, CARE_ENVIRONMENT, HEALTHCARE_PROFESSION, DIAGNOSIS, SYMPTOM_OR_SIGN, CONDITION_QUALIFIER, MEDICATION_CLASS, MEDICATION_NAME, DOSAGE, MEDICATION_FORM, MEDICATION_ROUTE, FAMILY_RELATION, TREATMENT_NAME' from the old version. New: Language/stable/2022-05-01/analyzetext.json#L832:9 Old: Language/stable/2022-05-01/analyzetext.json#L832:9 |
|
The new version is removing enum value(s) 'BODY_STRUCTURE, AGE, GENDER, EXAMINATION_NAME, DATE, DIRECTION, FREQUENCY, MEASUREMENT_VALUE, MEASUREMENT_UNIT, RELATIONAL_OPERATOR, TIME, GENE_OR_PROTEIN, VARIANT, ADMINISTRATIVE_EVENT, CARE_ENVIRONMENT, HEALTHCARE_PROFESSION, DIAGNOSIS, SYMPTOM_OR_SIGN, CONDITION_QUALIFIER, MEDICATION_CLASS, MEDICATION_NAME, DOSAGE, MEDICATION_FORM, MEDICATION_ROUTE, FAMILY_RELATION, TREATMENT_NAME' from the old version. New: TextAnalytics/stable/v3.1/TextAnalytics.json#L1884:9 Old: TextAnalytics/stable/v3.1/TextAnalytics.json#L1884:9 |
|
The new version is removing enum value(s) 'BODY_STRUCTURE, AGE, GENDER, EXAMINATION_NAME, DATE, DIRECTION, FREQUENCY, MEASUREMENT_VALUE, MEASUREMENT_UNIT, RELATIONAL_OPERATOR, TIME, GENE_OR_PROTEIN, VARIANT, ADMINISTRATIVE_EVENT, CARE_ENVIRONMENT, HEALTHCARE_PROFESSION, DIAGNOSIS, SYMPTOM_OR_SIGN, CONDITION_QUALIFIER, MEDICATION_CLASS, MEDICATION_NAME, DOSAGE, MEDICATION_FORM, MEDICATION_ROUTE, FAMILY_RELATION, TREATMENT_NAME' from the old version. New: TextAnalytics/stable/v3.1/TextAnalytics.json#L1884:9 Old: TextAnalytics/stable/v3.1/TextAnalytics.json#L1884:9 |
️❌Breaking Change(Cross-Version): 26 Errors, 170 Warnings failed [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| analyzeconversations-authoring.json | 2022-07-01-preview(fe6e976) | 2022-05-01(main) |
| analyzeconversations-authoring.json | 2022-07-01-preview(fe6e976) | 2022-05-15-preview(main) |
| analyzeconversations.json | 2022-07-01-preview(fe6e976) | 2022-05-01(main) |
| analyzeconversations.json | 2022-07-01-preview(fe6e976) | 2022-05-15-preview(main) |
| analyzetext-authoring.json | 2022-07-01-preview(fe6e976) | 2022-05-01(main) |
| analyzetext-authoring.json | 2022-07-01-preview(fe6e976) | 2022-05-15-preview(main) |
| analyzetext.json | 2022-07-01-preview(fe6e976) | 2022-05-01(main) |
| analyzetext.json | 2022-07-01-preview(fe6e976) | 2022-05-15-preview(main) |
| common.json | 2022-07-01-preview(fe6e976) | 2022-05-01(main) |
| common.json | 2022-07-01-preview(fe6e976) | 2022-05-15-preview(main) |
| questionanswering-authoring.json | 2022-07-01-preview(fe6e976) | 2021-10-01(main) |
| questionanswering-authoring.json | 2022-07-01-preview(fe6e976) | 2021-07-15-preview(main) |
| questionanswering.json | 2022-07-01-preview(fe6e976) | 2021-10-01(main) |
| questionanswering.json | 2022-07-01-preview(fe6e976) | 2021-07-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 12 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 12 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| :warning: 1006 - RemovedDefinition | The new version is missing a definition that was found in the old version. Was 'KnowledgeBaseQueryOptions' removed or renamed? New: Language/preview/2022-07-01-preview/questionanswering.json#L129:3 Old: Language/preview/2021-07-15-preview/questionanswering.json#L115:3 |
| :warning: 1006 - RemovedDefinition | The new version is missing a definition that was found in the old version. Was 'AnswerSpanRequest' removed or renamed? New: Language/preview/2022-07-01-preview/questionanswering.json#L129:3 Old: Language/preview/2021-07-15-preview/questionanswering.json#L115:3 |
| :warning: 1006 - RemovedDefinition | The new version is missing a definition that was found in the old version. Was 'KnowledgeBaseAnswerRequestContext' removed or renamed? New: Language/preview/2022-07-01-preview/questionanswering.json#L129:3 Old: Language/preview/2021-07-15-preview/questionanswering.json#L115:3 |
| :warning: 1006 - RemovedDefinition | The new version is missing a definition that was found in the old version. Was 'TextQueryOptions' removed or renamed? New: Language/preview/2022-07-01-preview/questionanswering.json#L129:3 Old: Language/preview/2021-07-15-preview/questionanswering.json#L115:3 |
| :warning: 1007 - RemovedClientParameter | The new version is missing a client parameter that was found in the old version. Was 'KnowledgeBaseQueryOptions' removed or renamed? New: Language/preview/2022-07-01-preview/questionanswering.json#L576:3 Old: Language/preview/2021-07-15-preview/questionanswering.json#L538:3 |
| :warning: 1007 - RemovedClientParameter | The new version is missing a client parameter that was found in the old version. Was 'TextQueryOptions' removed or renamed? New: Language/preview/2022-07-01-preview/questionanswering.json#L576:3 Old: Language/preview/2021-07-15-preview/questionanswering.json#L538:3 |
| :warning: 1008 - ModifiedOperationId | The operation id has been changed from 'QuestionAnsweringKnowledgeBase_Query' to 'QuestionAnswering_GetAnswers'. This will impact generated code. New: Language/preview/2022-07-01-preview/questionanswering.json#L45:7 Old: Language/preview/2021-07-15-preview/questionanswering.json#L31:7 |
| :warning: 1008 - ModifiedOperationId | The operation id has been changed from 'QuestionAnsweringText_Query' to 'QuestionAnswering_GetAnswersFromText'. This will impact generated code. New: Language/preview/2022-07-01-preview/questionanswering.json#L90:7 Old: Language/preview/2021-07-15-preview/questionanswering.json#L76:7 |
| :warning: 1011 - AddingResponseCode | The new version adds a response code '200'. New: Language/preview/2022-07-01-preview/questionanswering-authoring.json#L288:11 |
| :warning: 1019 - RemovedEnumValue | The new version is removing enum value(s) 'CreditCard' from the old version. New: Language/preview/2022-07-01-preview/analyzeconversations.json#L1993:7 Old: Language/preview/2022-05-15-preview/analyzeconversations.json#L1977:7 |
| :warning: 1019 - RemovedEnumValue | The new version is removing enum value(s) 'BODY_STRUCTURE, AGE, GENDER, EXAMINATION_NAME, DATE, DIRECTION, FREQUENCY, MEASUREMENT_VALUE, MEASUREMENT_UNIT, RELATIONAL_OPERATOR, TIME, GENE_OR_PROTEIN, VARIANT, ADMINISTRATIVE_EVENT, CARE_ENVIRONMENT, HEALTHCARE_PROFESSION, DIAGNOSIS, SYMPTOM_OR_SIGN, CONDITION_QUALIFIER, MEDICATION_CLASS, MEDICATION_NAME, DOSAGE, MEDICATION_FORM, MEDICATION_ROUTE, FAMILY_RELATION, TREATMENT_NAME' from the old version. New: Language/preview/2022-07-01-preview/analyzetext.json#L823:9 Old: Language/preview/2022-05-15-preview/analyzetext.json#L794:9 |
| :warning: 1023 - TypeFormatChanged | The new version has a different format than the previous one. New: Language/preview/2022-07-01-preview/analyzeconversations.json#L2177:13 Old: Language/preview/2022-05-15-preview/analyzeconversations.json#L2159:13 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 1 Warnings failed [Detail]
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
"location":"specification/cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"swagger-document/compose - FAILED" |
|
|
"location":"specification/cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Error: '$.security' has incompatible values (---- apimkey: [], ---- AADToken: - 'https://cognitiveservices.azure.com/.default'- apimkey: [])." |
|
| :warning: R2010 - LongRunningOperationsOptionsValidator | A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Language/preview/2022-07-01-preview/questionanswering-authoring.json#L263 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: R3017 - GuidUsage | Guid used in model definition 'JobMetadata' for property 'jobId'. 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: TextAnalytics/stable/v3.1/TextAnalytics.json#L2117 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Following response status codes 200 for operation QuestionAnsweringProjects_Export were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Language/preview/2022-07-01-preview/questionanswering-authoring.json#L288:18 ExampleUrl: examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json#L15:16 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 91 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/fe6e9763e0173248d648178a888892f8c39bdfda/specification/cognitiveservices/data-plane/Language/readme.md#tag-release_2022_05_01">cognitiveservices/data-plane/Language/readme.md#release_2022_05_01
- "https://github.com/Azure/azure-rest-api-specs/blob/fe6e9763e0173248d648178a888892f8c39bdfda/specification/cognitiveservices/data-plane/Language/readme.md#tag-release_2022_07_01_preview">cognitiveservices/data-plane/Language/readme.md#release_2022_07_01_preview
- "https://github.com/Azure/azure-rest-api-specs/blob/fe6e9763e0173248d648178a888892f8c39bdfda/specification/cognitiveservices/data-plane/TextAnalytics/readme.md#tag-release_3_1">cognitiveservices/data-plane/TextAnalytics/readme.md#release_3_1
Only 12 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'ConfusionMatrixCell' (2 differences):\n - properties.normalizedValue.$ref: "#/components/schemas/schemas:454" => "#/components/schemas/schemas:684"\n - properties.rawValue.$ref: "#/components/schemas/schemas:455" => "#/components/schemas/schemas:685"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'CreateDeploymentOptions' (1 differences):\n - properties.trainedModelLabel.$ref: "#/components/schemas/schemas:458" => "#/components/schemas/schemas:703"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'CreateProjectOptions' (9 differences):\n - properties.projectKind.description: "The project kind." => "Represents the project kind."\n - properties.storageInputContainerName: "$ref":"#/components/schemas/schemas:460", "description":"The storage container name." => |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'CreateProjectOptions' (16 differences):\n - properties.projectKind: "description":"The project kind.", "$ref":"#/components/schemas/projectKind" => "description":"The storage container name." => "description":"The new project name." => "type":"boolean" => use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." => "description":"Set to true to enable creating knowledgebases in different languages for the same resource."\n - x-ms-client-name: "CreateProjectOptions" => |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'DeploymentJobState' (1 differences):\n - allOf.0.$ref: "#/components/schemas/schemas:560" => "#/components/schemas/schemas:784"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'EntityEvaluationSummary' (7 differences):\n - properties.f1.$ref: "#/components/schemas/schemas:494" => "#/components/schemas/schemas:718"\n - properties.precision.$ref: "#/components/schemas/schemas:495" => "#/components/schemas/schemas:719"\n - properties.recall.$ref: "#/components/schemas/schemas:496" => "#/components/schemas/schemas:720"\n - properties.truePositiveCount.$ref: "#/components/schemas/schemas:497" => "#/components/schemas/schemas:721"\n - properties.trueNegativeCount.$ref: "#/components/schemas/schemas:498" => "#/components/schemas/schemas:722"\n - properties.falsePositiveCount.$ref: "#/components/schemas/schemas:499" => "#/components/schemas/schemas:723"\n - properties.falseNegativeCount.$ref: "#/components/schemas/schemas:500" => "#/components/schemas/schemas:724"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'EvaluationOptions' (2 differences):\n - properties.trainingSplitPercentage.$ref: "#/components/schemas/schemas:511" => "#/components/schemas/schemas:727"\n - properties.testingSplitPercentage.$ref: "#/components/schemas/schemas:512" => "#/components/schemas/schemas:728"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'EvaluationResults' (3 differences):\n - properties.value.$ref: "#/components/schemas/schemas:514" => "#/components/schemas/schemas:730"\n - properties.value.description: "THe list of documents evaluation results." => "The utterances evaluation results."\n - properties.nextLink.$ref: "#/components/schemas/schemas:515" => "#/components/schemas/schemas:731"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'EvaluationSummary' (8 differences):\n - properties.projectKind: "description":"Represents the project type that the evaluation ran on.", "$ref":"#/components/schemas/projectKind" => "$ref":"#/components/schemas/schemas:709"\n - properties.intentsEvaluation: "$ref":"#/components/schemas/schemas:776"\n - discriminator: "propertyName":"projectKind" => |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'ExportedProject' (3 differences):\n - properties.projectFileVersion.$ref: "#/components/schemas/schemas:555" => "#/components/schemas/schemas:755"\n - properties.metadata.$ref: "#/components/schemas/schemas:459" => "#/components/schemas/schemas:704"\n - properties.assets.$ref: "#/components/schemas/schemas:556" => "#/components/schemas/schemas:756"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'ExportedProjectAssets' (1 differences):\n - properties.projectKind.description: "The type of the project the assets belong to." => "The type of project containing the assets."" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_07_01_preview", "details":"Duplicate Schema named 'ExportProjectJobState' (2 differences):\n - allOf.0.$ref: "#/components/schemas/schemas:560" => "#/components/schemas/schemas:784"\n - properties.resultUrl.$ref: "#/components/schemas/schemas:558" => "#/components/schemas/schemas:766"" |
The following errors/warnings exist before current PR submission:
Only 12 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'JobState' (19 differences):\n - properties.displayName: "$ref":"#/components/schemas/schemas:189" => "name":"State" => "description":"The warnings that were encountered while executing the job."\n - required.1: "lastUpdatedDateTime" => "createdDateTime"\n - required.2: "createdDateTime" => "lastUpdatedDateTime"\n - x-ms-client-name: |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'JobState' (19 differences):\n - properties.displayName: "$ref":"#/components/schemas/schemas:189" => "name":"State" => "description":"The warnings that were encountered while executing the job."\n - required.1: "lastUpdatedDateTime" => "createdDateTime"\n - required.2: "createdDateTime" => "lastUpdatedDateTime"\n - x-ms-client-name: |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'ConfusionMatrixCell' (2 differences):\n - properties.normalizedValue.$ref: "#/components/schemas/schemas:252" => "#/components/schemas/schemas:482"\n - properties.rawValue.$ref: "#/components/schemas/schemas:253" => "#/components/schemas/schemas:483"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'CreateDeploymentOptions' (1 differences):\n - properties.trainedModelLabel.$ref: "#/components/schemas/schemas:256" => "#/components/schemas/schemas:501"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'CreateProjectOptions' (9 differences):\n - properties.projectKind.description: "The project kind." => "Represents the project kind."\n - properties.storageInputContainerName: "$ref":"#/components/schemas/schemas:258", "description":"The storage container name." => |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'DeploymentJobState' (1 differences):\n - allOf.0.$ref: "#/components/schemas/schemas:358" => "#/components/schemas/schemas:582"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'EntityEvaluationSummary' (7 differences):\n - properties.f1.$ref: "#/components/schemas/schemas:292" => "#/components/schemas/schemas:516"\n - properties.precision.$ref: "#/components/schemas/schemas:293" => "#/components/schemas/schemas:517"\n - properties.recall.$ref: "#/components/schemas/schemas:294" => "#/components/schemas/schemas:518"\n - properties.truePositiveCount.$ref: "#/components/schemas/schemas:295" => "#/components/schemas/schemas:519"\n - properties.trueNegativeCount.$ref: "#/components/schemas/schemas:296" => "#/components/schemas/schemas:520"\n - properties.falsePositiveCount.$ref: "#/components/schemas/schemas:297" => "#/components/schemas/schemas:521"\n - properties.falseNegativeCount.$ref: "#/components/schemas/schemas:298" => "#/components/schemas/schemas:522"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'EvaluationOptions' (2 differences):\n - properties.trainingSplitPercentage.$ref: "#/components/schemas/schemas:309" => "#/components/schemas/schemas:525"\n - properties.testingSplitPercentage.$ref: "#/components/schemas/schemas:310" => "#/components/schemas/schemas:526"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'EvaluationResults' (3 differences):\n - properties.value.$ref: "#/components/schemas/schemas:312" => "#/components/schemas/schemas:528"\n - properties.value.description: "THe list of documents evaluation results." => "The utterances evaluation results."\n - properties.nextLink.$ref: "#/components/schemas/schemas:313" => "#/components/schemas/schemas:529"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'EvaluationSummary' (8 differences):\n - properties.projectKind: "description":"Represents the project type that the evaluation ran on.", "$ref":"#/components/schemas/ProjectKind" => "$ref":"#/components/schemas/schemas:507"\n - properties.intentsEvaluation: "$ref":"#/components/schemas/schemas:574"\n - discriminator: "propertyName":"projectKind" => |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'ExportedProject' (3 differences):\n - properties.projectFileVersion.$ref: "#/components/schemas/schemas:353" => "#/components/schemas/schemas:553"\n - properties.metadata.$ref: "#/components/schemas/schemas:257" => "#/components/schemas/schemas:502"\n - properties.assets.$ref: "#/components/schemas/schemas:354" => "#/components/schemas/schemas:554"" |
| :warning: PreCheck/DuplicateSchema | "readme":"cognitiveservices/data-plane/Language/readme.md", "tag":"release_2022_05_01", "details":"Duplicate Schema named 'ExportedProjectAssets' (1 differences):\n - properties.projectKind.description: "The type of the project the assets belong to." => "The type of project containing the assets."" |
️️✔️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.
![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 inProgress [Detail]
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️❌ azure-sdk-for-net failed [Detail]
❌Failed [Logs] Generate from c327a66d8ea60a16918b4a391f54375a304ba72e. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 warn specification/cognitiveservices/data-plane/Language/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk warn specification/cognitiveservices/data-plane/TextAnalytics/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/dev/cognitiveservices/data-plane/Language/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] FATAL: swagger-document/compose - FAILED cmderr [Autorest] FATAL: Error: '$.security' has incompatible values (--- cmderr [Autorest] - apim_key: [] cmderr [Autorest] , --- cmderr [Autorest] - AADToken: cmderr [Autorest] - 'https://cognitiveservices.azure.com/.default' cmderr [Autorest] - apim_key: [] cmderr [Autorest] ). cmderr [Autorest] Error: '$.security' has incompatible values (--- cmderr [Autorest] - apim_key: [] cmderr [Autorest] , --- cmderr [Autorest] - AADToken: cmderr [Autorest] - 'https://cognitiveservices.azure.com/.default' cmderr [Autorest] - apim_key: [] cmderr [Autorest] ). error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest warn Skip command for failed context: autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/readme.md warn Skip package processing as generation is failed
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from c327a66d8ea60a16918b4a391f54375a304ba72e. 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. warn specification/cognitiveservices/data-plane/Language/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk warn specification/cognitiveservices/data-plane/TextAnalytics/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] config global `--global`, `--local` are deprecated. Use `--location=global` instead. cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.16.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.16.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
️⚠️ azure-sdk-for-net-track2 warning [Detail]
⚠️Warning [Logs] Generate from c327a66d8ea60a16918b4a391f54375a304ba72e. 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 warn File azure-sdk-for-net_tmp/initOutput.json not found to read warn dev/cognitiveservices/data-plane/Language/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk warn specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk 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
Hi @nourhaanfarid, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| 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 |
Swagger Generation Artifacts
️⌛ApiDocPreview pending [Detail]
️⌛SDK Breaking Change Tracking pending [Detail]
Should this PR be following the dev/ branching strategy? @heaths
Yes. Please only modify existing files in the dev/ folder (or add files if truly new APIs). There should never been a "preview" or "stable" folder nor api-version folder like here. Copying files this way is not git-friendly and very difficult to review thoroughly.
Should this PR be following the dev/ branching strategy? @heaths
Yes. Please only modify existing files in the
dev/folder (or add files if truly new APIs). There should never been a "preview" or "stable" folder nor api-version folder like here. Copying files this way is not git-friendly and very difficult to review thoroughly.
@heaths This PR is for copying all the work we have been adding to /dev folder to the July preview folder. It's actually required for this PR to add files to a new "preview" folder
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.
Hi @nourhaanfarid, 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. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
@JeffreyRichter @johanste they are getting a lot of breaking changes because they need to also fix 2022-05-01 which went out wrong (see list below), and even 3.1. Should they just correct their swagger to match actual service behavior in all affected swaggers in this single PR?
healthcareEntityCategoryproperty enum definedSCREAMING_SNAKE_CASEenums, but the service - even in 3.1 - sends back PascalCase enum values.- Missing a bunch of
"format": "uri"and"format": {whatever}"on integers that should've been defined but apparently didn't err before. Should they even bother fixing these, or just get an exemption and do this for any new ones going forward?
@aurghob @nourhaanfarid let's please use a single PR for all these changes. There are 2 or 3 making this very hard to review, and fixing errors in one PR won't affect the other, making us do double due diligence to review errors and make sure they are fixed correctly. It's a good way for mistakes to persist.
@ArthurMa1978 there seems to be some validation bug if you look at the TypeChange warnings. The linter asked them to explicitly add type: object to all their models missing a type, but that's the swagger 2.0 default so nothing actually was changed.
Usually we don't change the service to match the swagger; we go the other way. It would depend on if this was in preview or GA.
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️🔄 azure-sdk-for-net inProgress [Detail]
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from 5c12383a236a2e074422c5235e9f343e002707b4. 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. warn specification/cognitiveservices/data-plane/Language/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk warn specification/cognitiveservices/data-plane/TextAnalytics/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead. warn No file changes detected after generation warn No package detected after generation
️🔄 azure-sdk-for-net-track2 inProgress [Detail]
Regarding the checks failures:
- The breaking changes are from fixing the
healthcareEntityCategoryto define what the service has actually been returning since 3.1. Others were adding integer and URI formats to properties that were already using those formats. @JeffreyRichter, @johanste is that really considered breaking? - azure-sdk-for-net failure I'm not sure, but the swagger is correct. Seems validation is having problems with multiple authentication methods. @akning-ms do you have any ideas on this?
- The Avocado errors should be fixed when @aurghob resolves my comment. Also, @aurghob, @nourhaanfarid, @kayousef let's make sure that all services for which swaggers were copied are actually planning to ship/support 2022-07-01-preview.
- The ModelValidation error is that you have a couple samples that just have "{JobId}" instead of something like "eefba49c-e645-4d64-bd27-5e5a3d371059". Please use actual values that pass validation.
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️❌ azure-sdk-for-net failed [Detail]
❌Failed [Logs]Release - Generate from 1646226d874de6e8d36ebd3ad088c6c5f6cc6ed0. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 warn specification/cognitiveservices/data-plane/Language/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk warn specification/cognitiveservices/data-plane/TextAnalytics/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/dev/cognitiveservices/data-plane/Language/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] FATAL: swagger-document/compose - FAILED cmderr [Autorest] FATAL: Error: '$.security' has incompatible values (--- cmderr [Autorest] - apim_key: [] cmderr [Autorest] , --- cmderr [Autorest] - AADToken: cmderr [Autorest] - 'https://cognitiveservices.azure.com/.default' cmderr [Autorest] - apim_key: [] cmderr [Autorest] ). cmderr [Autorest] Error: '$.security' has incompatible values (--- cmderr [Autorest] - apim_key: [] cmderr [Autorest] , --- cmderr [Autorest] - AADToken: cmderr [Autorest] - 'https://cognitiveservices.azure.com/.default' cmderr [Autorest] - apim_key: [] cmderr [Autorest] ). error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest warn Skip package processing as generation is failed
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs]Release - Generate from 1646226d874de6e8d36ebd3ad088c6c5f6cc6ed0. 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. warn specification/cognitiveservices/data-plane/Language/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk warn specification/cognitiveservices/data-plane/TextAnalytics/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json warn No file changes detected after generation warn No package detected after generation
️⚠️ azure-sdk-for-net-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from 1646226d874de6e8d36ebd3ad088c6c5f6cc6ed0. 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 warn File azure-sdk-for-net_tmp/initOutput.json not found to read warn dev/cognitiveservices/data-plane/Language/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk 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
Breaking changes
- The
errorerror and enum values change are expected, but the other errors about a format change: per previous discussion, I thought those were going to be reverted? Theformatis useful, but not required and @mikekistler said adding them now would be breaking.
azure-sdk-for-net
- Ignore the error. This is a problem with the generator that it can't deal with multiple security definitions, and doesn't seem to support AAD properly.
LintDiff
- I'm not sure what the error is for the first one. The error doesn't specify any actionable details. @akning-ms, @ArthurMa1978 do you know how we can find more data on the one stating,
"details":"swagger-document/compose - FAILED"? Even looking at DevOps, there's nothing obvious wherever a fatal error with "swagger-document/compose" is mentioned. - It's not clear what's wrong with it, because the error doesn't say, but this authoring is valid swagger. My guess is that the validation doesn't support multiple security definitions, because this issue only started appearing after you added the AAD token support, and multiple security definitions are allowed by swagger.
Apart from the one LintDiff issue that is questionable and fixing the format issue (just remove the "format" where you added it), I don't see anything else holding this up. /cc @lmazuel for helping merging this once we can address those issues.
@heaths did we get agreement from @JeffreyRichter on the breaking change?
@raych1 could you help look into the LintDiff issue that @heaths is calling out above? Let's make sure we understand the issue and if it is understood we should file an issue about making the error message more actionable.
@weshaggard all the error errors are expected. At one point they made error required as it always should've been. I'm actually surprised they're still seeing this since - at least some - services GA'd back in May.
As for the enums, this is actually a correction. The swagger was wrong. I'll forward you an email.