Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLU Public Preview API #16450

Merged
merged 3 commits into from
Oct 20, 2021
Merged

Add CLU Public Preview API #16450

merged 3 commits into from
Oct 20, 2021

Conversation

ChongTang
Copy link
Contributor

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:

  1. 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
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge 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:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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.

@ChongTang ChongTang requested a review from yangyuan as a code owner October 19, 2021 00:58
@openapi-workflow-bot
Copy link

Hi, @ChongTang 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 19, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️🔄[Staging] SDK Track2 Validation inProgress [Detail]
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [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.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 19, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⚠️ azure-sdk-for-net warning [Detail]
    • ⚠️Warning [Logs] Generate from 749450729a3e431c6d55948dc8d642185805833c. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from 749450729a3e431c6d55948dc8d642185805833c. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] opencensus-ext-azure 1.1.0 requires azure-core<2.0.0,>=1.12.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] azure-identity 1.7.0 requires azure-core<2.0.0,>=1.11.0, but you have azure-core 1.6.0 which is incompatible.
      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?

    @openapi-workflow-bot
    Copy link

    Hi @ChongTang, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    Co-authored-by: Heath Stewart <heaths@outlook.com>
    @heaths heaths merged commit 543d352 into Azure:release/cognitiveservices/clu-2021-11-01-preview Oct 20, 2021
    @heaths heaths mentioned this pull request Nov 9, 2021
    fxs130430 pushed a commit to fxs130430/azure-rest-api-specs that referenced this pull request Jan 26, 2022
    * Add CLU Public Preview API
    
    * remove azure-sdk-for-net-track2
    
    * Nit: remove extra space
    
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    
    Co-authored-by: Chong Tang <chot@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    weshaggard pushed a commit that referenced this pull request Mar 9, 2022
    * Adds base for updating Language from version preview/2021-07-15-preview to version 2021-11-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Add CLU Public Preview API (#16450)
    
    * Add CLU Public Preview API
    
    * remove azure-sdk-for-net-track2
    
    * Nit: remove extra space
    
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    
    Co-authored-by: Chong Tang <chot@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    
    * added x-ms-client-name "confidence" (#16646)
    
    * Add SDK owners for CLU (#16718)
    
    * add a clu entry to readme
    
    * making enums compatible
    
    * making TA point to common.json for error
    
    * fixing spaces
    
    * adding questionanswering to custom-words
    
    * Update analyzeconversations.json
    
    adding "non_linked"
    
    * add an owner
    
    * addressing comments
    
    Co-authored-by: Chong Tang <ct4ew@virginia.edu>
    Co-authored-by: Chong Tang <chot@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    Co-authored-by: Ahmed Leithy <v-aleithy@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@microsoft.com>
    Co-authored-by: Farhad Shakerin <fshakerin@microsoft.com>
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    * Adds base for updating Language from version preview/2021-07-15-preview to version 2021-11-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Add CLU Public Preview API (Azure#16450)
    
    * Add CLU Public Preview API
    
    * remove azure-sdk-for-net-track2
    
    * Nit: remove extra space
    
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    
    Co-authored-by: Chong Tang <chot@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    
    * added x-ms-client-name "confidence" (Azure#16646)
    
    * Add SDK owners for CLU (Azure#16718)
    
    * add a clu entry to readme
    
    * making enums compatible
    
    * making TA point to common.json for error
    
    * fixing spaces
    
    * adding questionanswering to custom-words
    
    * Update analyzeconversations.json
    
    adding "non_linked"
    
    * add an owner
    
    * addressing comments
    
    Co-authored-by: Chong Tang <ct4ew@virginia.edu>
    Co-authored-by: Chong Tang <chot@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    Co-authored-by: Ahmed Leithy <v-aleithy@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@microsoft.com>
    Co-authored-by: Farhad Shakerin <fshakerin@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants