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

Rename the operation ID for /:analyze-conversations path

Open bidisha-c opened this issue 3 years ago • 9 comments

Rename the operation ID for /:analyze-conversations path for supporting better organization of documents. As the operation ID between sync and async vary, the documents are not organized together for sync and async unlike the "Analyze-Text" operations.

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.

bidisha-c avatar Oct 07 '22 05:10 bidisha-c

Hi, @bidisha-c 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]

    openapi-workflow-bot[bot] avatar Oct 07 '22 05:10 openapi-workflow-bot[bot]

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/e5f92f21e064e71b57cebcaa2cbca8e75c4fe2f4/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.42/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\nFATAL: swagger-document/compose - FAILED\nFATAL: Error: '$["x-ms-parameterized-host"].hostTemplate' has incompatible values (---\n'Endpoint/language'\n,
    ---\n'Endpoint/language/authoring'\n).\n Error: '$["x-ms-parameterized-host"].hostTemplate' has incompatible values (---\n'Endpoint/language'\n,
    ---\n'Endpoint/language/authoring'\n).\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_2022-07-01-preview",
    "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 succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation
    ️️✔️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?

    openapi-pipeline-app[bot] avatar Oct 07 '22 05:10 openapi-pipeline-app[bot]

    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 7b7f4b52c549d6ba62c387f569477ececf45f9f3. 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 7b7f4b52c549d6ba62c387f569477ececf45f9f3. 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
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
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
    Posted by Swagger Pipeline | How to fix these errors?

    openapi-pipeline-app[bot] avatar Oct 07 '22 05:10 openapi-pipeline-app[bot]

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

    openapi-pipeline-app[bot] avatar Oct 07 '22 05:10 openapi-pipeline-app[bot]

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

    openapi-workflow-bot[bot] avatar Oct 07 '22 05:10 openapi-workflow-bot[bot]

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

    openapi-workflow-bot[bot] avatar Oct 07 '22 05:10 openapi-workflow-bot[bot]

    @heaths Sorry to ping on this, is there anything else we need to do to merge this change?

    hazemelh avatar Oct 18 '22 11:10 hazemelh

    There's the lintdiff error. I can't force merge with failed required checks. Few can, which is by design. The best way to fix this is to change all swaggers' host templates to just "/language" and transport "/authoring" from those swaggers with "/language/authoring" back into the individual endpoints. This is unfortunate, and I opened bug https://github.com/Azure/azure-sdk-tools/issues/4419 to track resolving it. /cc @akning-ms

    heaths avatar Oct 18 '22 22:10 heaths

    @weshaggard @lmazuel I fixed one lintdiff error going forward, but the remaining one will require more work than I can simply do now. I filed #21173 to track and will work with the service team on resolving. Can one of you force-merge this for now?

    heaths avatar Oct 18 '22 23:10 heaths

    There's the lintdiff error. I can't force merge with failed required checks. Few can, which is by design. The best way to fix this is to change all swaggers' host templates to just "/language" and transport "/authoring" from those swaggers with "/language/authoring" back into the individual endpoints. This is unfortunate, and I opened bug Azure/azure-sdk-tools#4419 to track resolving it. /cc @akning-ms

    The issue has been fixed by @jianyexi in new Liner version which is running in "staging Swagger Lintdiff" without this issue

    akning-ms avatar Oct 21 '22 08:10 akning-ms