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.

Sign up for GitHub

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

Jump to bottom

[Search] Add new TAv3 skills to latest preview swagger #14848

Merged
merged 1 commit into from
Jun 17, 2021
Merged

[Search] Add new TAv3 skills to latest preview swagger #14848

merged 1 commit into from
Jun 17, 2021

Conversation

Careyjmac
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

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
    Done.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    July Preview SDK release
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    All that are supported by Azure Cognitive Search
    • 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, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service

  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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.

@openapi-workflow-bot
Copy link

Hi, @Careyjmac 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-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 Jun 16, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Indexers_Run' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Azure.Search/preview/2020-06-30-Preview/searchservice.json#L333
    ️️✔️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.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"search/data-plane/Azure.Search/readme.md",
    "tag":"package-2020-06-searchservice-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"search/data-plane/Azure.Search/readme.md",
    "tag":"package-2020-06-searchservice-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"search/data-plane/Azure.Search/readme.md",
    "tag":"package-2020-06-searchservice-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 16, 2021 •
    edited
    Loading

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @Careyjmac
    Copy link
    Contributor Author

    Here is the private PR that has already been approved: https://github.com/Azure/azure-rest-api-specs-pr/pull/3395

    @Careyjmac
    Copy link
    Contributor Author

    #sign-off

    Mohit-Chakraborty
    Mohit-Chakraborty reviewed Jun 16, 2021
    View reviewed changes
    specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json
    @@ -7822,6 +7822,162 @@
    },
    "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1."
    },
    "SentimentSkillV3": {
    Copy link
    Contributor

    @Mohit-Chakraborty Mohit-Chakraborty Jun 16, 2021 •
    edited
    Loading

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Do we prefer SentimentSkillV3 or SentimentSkill3 here?
    In the few places in the .NET SDK where we have had to use version numbers in the types, I see we use the latter -

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    There is going to be custom logic implemented for these two V3 skills in the SDK, so I'm not sure it matters. @alzimmermsft is leading those efforts, discussed here: Azure/azure-sdk#2987

    @Careyjmac
    Copy link
    Contributor Author

    @anuchandy Please let me know if there is anything else that needs to be done to merge this, otherwise I am happy with it being merged at this point!

    @anuchandy anuchandy merged commit d910266 into Azure:master Jun 17, 2021
    @Careyjmac Careyjmac deleted the newTASkills branch June 17, 2021 21:08
    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    @Careyjmac
    Copy changes from private repo (Azure#14848)
    2d3c08b
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @Careyjmac @mkarmark
    Copy changes from private repo (Azure#14848)
    7c20b00
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @anuchandy anuchandy anuchandy approved these changes

    @Mohit-Chakraborty Mohit-Chakraborty Mohit-Chakraborty approved these changes

    @AlexGhiondea AlexGhiondea Awaiting requested review from AlexGhiondea

    @arv100kri arv100kri Awaiting requested review from arv100kri arv100kri is a code owner

    @bleroy bleroy Awaiting requested review from bleroy bleroy is a code owner

    @brjohnstmsft brjohnstmsft Awaiting requested review from brjohnstmsft

    @heaths heaths Awaiting requested review from heaths

    Assignees

    @anuchandy anuchandy

    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @Careyjmac @anuchandy @Mohit-Chakraborty