azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Merge Language 2022-10-01-preview back to main:dev/ creating 2023-05-01

Open kayousef-zz opened this issue 3 years ago • 10 comments

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

kayousef-zz avatar Oct 23 '22 21:10 kayousef-zz

Hi, @kayousef Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?
  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/ae793c4560933d65df95e8201dcbb92d8e38f27f/dev/cognitiveservices/data-plane/Language",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main//mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/dev/cognitiveservices/data-plane/Language",
    "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.43/common/temp/node_modules/.pnpm/@[email protected]/node_modules/autorest/dist/app.js /tmp/readme.oad.old.md --v2 --tag=oad-default-tag --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nERROR (Fatal/DuplicateModelCollsion): Duplicated model name with non-identical definitions\n - file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/dev/cognitiveservices/data-plane/Language/questionanswering-authoring.json:1224:4 ($.definitions.JobState)\n - file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/dev/cognitiveservices/data-plane/Language/common.json:240:4 ($.definitions.JobState)\n Cancellation requested.\n"
    BreakingChangeToolException "details":""errno":-21,
    "syscall":"read",
    "code":"EISDIR""
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌LintDiff: 1 Errors, 0 Warnings failed [Detail] [must fix]The following errors/warnings are introduced by current PR:
    Rule Message Related RPC [For API reviewers]
    AutoRest exception "location":"dev/cognitiveservices/data-plane/Language/readme.md",
    "tag":"release_2023-05-01",
    "details":"Duplicated model name with non-identical definitions"
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️❌ModelValidation: 37 Errors, 0 Warnings failed [Detail]

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L192:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L252:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulExportProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L307:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulImportProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L359:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulTrainProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L460:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L593:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L648:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L1014:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L1251:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L1303:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations-authoring.json#L1512:22
    ExampleUrl: Language/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations.json#L127:22
    ExampleUrl: Language/examples/conversations/SuccessfulConversationPIISubmit.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations.json#L127:22
    ExampleUrl: Language/examples/conversations/SuccessfulConversationSummarySubmit.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations.json#L127:22
    ExampleUrl: Language/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations.json#L127:22
    ExampleUrl: Language/examples/conversations/SuccessfulConversationSentimentSubmit.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzeconversations.json#L225:22
    ExampleUrl: Language/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L192:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulDeleteProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L249:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulExportProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L308:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulImportProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L360:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulTrainProject.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L461:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulSwapDeployments.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L594:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L649:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L1015:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L1252:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L1304:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext-authoring.json#L1513:22
    ExampleUrl: Language/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext.json#L137:22
    ExampleUrl: Language/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext.json#L137:22
    ExampleUrl: Language/examples/text/SuccessfulHealthcarePostRequest.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: cognitiveservices/data-plane/Language/analyzetext.json#L137:22
    ExampleUrl: Language/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⚠️ azure-sdk-for-net-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2175c6ef7477227f3e17ad7effb4b5629d310882. SDK Automation 14.0.0
      command	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
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	Skip detect changed packages
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2175c6ef7477227f3e17ad7effb4b5629d310882. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    Posted by Swagger Pipeline | How to fix these errors?

    Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

    Hi @kayousef, 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.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @akning-ms can someone look at all the LRO errors? Are these new? They do return an Operation-Location header.

    @kayousef as for the other errors about mismatching host templates, I made a recent change to the swagger in dev/ such that all the host templates are just "/language" which means all the authoring endpoints need to start with "/authoring". IIRC, TA used a host template of "/language/authoring" to avoid repeating it (my suggestion) but turns out validation doesn't like that. That should fix most of the errors besides the LRO ones.

    heaths avatar Oct 24 '22 23:10 heaths

    @akning-ms can someone look at all the LRO errors? Are these new? They do return an Operation-Location header.

    @kayousef as for the other errors about mismatching host templates, I made a recent change to the swagger in dev/ such that all the host templates are just "/language" which means all the authoring endpoints need to start with "/authoring". IIRC, TA used a host template of "/language/authoring" to avoid repeating it (my suggestion) but turns out validation doesn't like that. That should fix most of the errors besides the LRO ones.

    @heaths done

    kayousef-zz avatar Oct 25 '22 13:10 kayousef-zz

    @kayousef the samples also need to be updated to have the right api-version. Click on the Details links above to see what needs to be fixed. I'll ping @akning-ms about all these seemingly new LRO errors I've never seen before.

    heaths avatar Oct 26 '22 21:10 heaths

    @akning-ms can someone look at all the LRO errors? Are these new? They do return an Operation-Location header.

    the rule is enabled on Jun 2022. @raych1 to confirm whether it is something we should support in dataplane for Operation-Location

    akning-ms avatar Oct 27 '22 07:10 akning-ms

    @akning-ms can someone look at all the LRO errors? Are these new? They do return an Operation-Location header.

    the rule is enabled on Jun 2022. @raych1 to confirm whether it is something we should support in dataplane for Operation-Location

    @heaths , you could add approved-modelvalidation label if the errors are confirmed as false alarm. Let me know if dataplane has another requirement for LRO instead of following ARM RPC.

    raych1 avatar Oct 27 '22 14:10 raych1

    Let's get this merged and try to fix all these in the dev/ folder once and for all so we don't keep getting blocked on validation errors (legit or faulty).

    heaths avatar Oct 31 '22 22:10 heaths