Fix search readme.md

[xiangyan99]

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.

Click here to open a PR for only SDK configuration.

[github-actions]

Next Steps to Merge

Next steps that must be taken to merge this PR:

• ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
• ❌ This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired).
  To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch.
• ❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.

Comment generated by summarize-checks workflow run.

[github-actions]

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
Java	com.azure:azure-search-documents
Python	azure-search-documents
Swagger	Legacy-Search

[raych1]

The breaking change failures are caused by the known limitation in case of renaming files. The PR change doesn't bring the breaking changes.

@mikeharder lintDiff fails in building the specModel, it seems to be an issue while the swagger path wasn't referenced in the previous readme.md. Is it related to the case sensitive problem?

SpecModelError: Swagger file /home/runner/work/azure-rest-api-specs/azure-rest-api-specs/before/specification/search/data-plane/Search/preview/2020-06-30-Preview/searchservice.json not found in specModel.
It must be referenced in the "input-file" section of a tag in a readme.md file or in a swagger JSON file using $ref

[mikeharder]

The breaking change failures are caused by the known limitation in case of renaming files. The PR change doesn't bring the breaking changes.

@mikeharder lintDiff fails in building the specModel, it seems to be an issue while the swagger path wasn't referenced in the previous readme.md. Is it related to the case sensitive problem?

SpecModelError: Swagger file /home/runner/work/azure-rest-api-specs/azure-rest-api-specs/before/specification/search/data-plane/Search/preview/2020-06-30-Preview/searchservice.json not found in specModel.
It must be referenced in the "input-file" section of a tag in a readme.md file or in a swagger JSON file using $ref

@raych1, @xiangyan99: I believe this PR is combining multiple changes:

1. rename folder from "2019-05-06-preview" to "2019-05-06-Preview"
   1. update suppressions.yaml to match
2. swagger changes to one file and example in version "2020-06-30-Preview"
3. add missing existing versions to readme.md
4. add codegen config to readme.md
5. add some "all-api-versions" version to readme.md

It would be easier to review, and answer questions like this, if this were split into multiple PRs, one for each concern.

For this specific error, I think you want to split #2 (change content of 2020-06-30-preview) and #3 (add missing existing versions to readme.md).

If you add the readme versions in an earlier PR, then I think you should get valid LintDiff results, for the content changes to swagger.

[raych1]

For this specific error, I think you want to split #2 (change content of 2020-06-30-preview) and #3 (add missing existing versions to readme.md).

@mikeharder thank you for the clarification and suggestion. Is it possible to improve the error message in order to be self-serviceable?

@xiangyan99 would you mind splitting this PR into two separated ones to make lintDiff tool function?

[xiangyan99]

The breaking change failures are caused by the known limitation in case of renaming files. The PR change doesn't bring the breaking changes.
@mikeharder lintDiff fails in building the specModel, it seems to be an issue while the swagger path wasn't referenced in the previous readme.md. Is it related to the case sensitive problem?

SpecModelError: Swagger file /home/runner/work/azure-rest-api-specs/azure-rest-api-specs/before/specification/search/data-plane/Search/preview/2020-06-30-Preview/searchservice.json not found in specModel.
It must be referenced in the "input-file" section of a tag in a readme.md file or in a swagger JSON file using $ref

@raych1, @xiangyan99: I believe this PR is combining multiple changes:

1. rename folder from "2019-05-06-preview" to "2019-05-06-Preview"

   1. update suppressions.yaml to match

2. swagger changes to one file and example in version "2020-06-30-Preview"

3. add missing existing versions to readme.md

4. add codegen config to readme.md

5. add some "all-api-versions" version to readme.md

It would be easier to review, and answer questions like this, if this were split into multiple PRs, one for each concern.

For this specific error, I think you want to split #2 (change content of 2020-06-30-preview) and #3 (add missing existing versions to readme.md).

If you add the readme versions in an earlier PR, then I think you should get valid LintDiff results, for the content changes to swagger.

Hi @mikeharder if I split the PR, we'll run into some Swagger Avocado failures.

e.g. #40118

My understanding is we don’t want to merge the change with those Swagger Avocado failures, which is why I made some extra tweaks in the PR.