[Search] Add ResetDocs API

[shuyangmsft]

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:

• 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: ⚠️

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 (including refactoring) 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.

[openapi-workflow-bot]

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

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

Swagger Validation Report

️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]

• Compared Swaggers (Based on Oad v0.9.0)
  • current:preview/2021-04-30-Preview/searchservice.json compared with base:preview/2021-04-30-Preview/searchservice.json

Rule	Message
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L335:5
❌ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'statusDetail' in response that was not found in the old version. New: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L6507:7 Old: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L6431:7
❌ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'currentState' in response that was not found in the old version. New: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L6507:7 Old: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L6431:7

️⚠️LintDiff: 1 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • data-plane/Azure.Search/readme.md tag:package-2021-04-searchservice-preview
• Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • data-plane/Azure.Search/readme.md tag:package-2021-04-searchservice-preview

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R4000 - ParameterDescriptionRequired	'keysOrIds' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Azure.Search/preview/2021-04-30-Preview/searchservice.json#L358

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/2021-04-30-Preview/searchservice.json#L412

️️✔️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 tags are being changed in this PR
• search/data-plane/Azure.Search/readme.md#package-2021-04-searchservice-preview

The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:

️️✔️[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]

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-track2 failed [Detail]

• ❌Failed [Logs]Release - Generate from 1df5cd4. 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/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  cmderr	[Automation-Sdk-Generate.ps1] �[91mWrite-Error: �[91mError occurred while generating code for Azure.Search.Documents
  cmderr	[Automation-Sdk-Generate.ps1] �[0m

• ❌Azure.Search.Documents [View full logs]  [Release SDK Changes]

  info	[Changelog]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-workflow-bot]

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[tg-msft]

Signing off on the high level API design discussed in the API Stewardship Board review at #15612

[dereklegenzoff]

@shuyangmsft - is this PR ready to merge?
@tg-msft - will we need to get an exception to merge this since it's marked as a breaking change?

[dereklegenzoff]

@shuyangmsft - I also noticed that this PR contains Reset Docs only and not Reset Skills. Is that intentional? I'm under the assumption that we'll want to add both to the preview SDK

[shuyangmsft]

@shuyangmsft - I also noticed that this PR contains Reset Docs only and not Reset Skills. Is that intentional? I'm under the assumption that we'll want to add both to the preview SDK

I was only assigned the ResetDocs work so it's intentional. I'll follow up with my manager on the ResetSkills change.

[shuyangmsft]

@shuyangmsft - is this PR ready to merge?
@tg-msft - will we need to get an exception to merge this since it's marked as a breaking change?

Not yet. I just merged my backend change and I think we'll need to wait for it to be deployed. I'll keep you updated.

[shuyangmsft]

@shuyangmsft - is this PR ready to merge?
@tg-msft - will we need to get an exception to merge this since it's marked as a breaking change?

This PR is ready to merge. Also add the PR asignee here @anuchandy
Thank you!