Azure Search DP: Clean up or format or update stale examples

[Yangyang Lu (yangylu91)]

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Sync Azure AI Search JSON examples with the AzS source of truth for 2025-11-01-preview, 2026-04-01, 2026-05-01-preview, and 2026-08-01-preview.

• Update 35 source example files, including content and formatting differences.
• Remove 11 GH-only source examples absent from AzS.
• Include six corresponding generated example updates for the May and August 2026 previews.

Examples only: no TypeSpec or OpenAPI schema changes, and no changes to later API versions. The four source example folders have identical filenames and SHA256 hashes to AzS, and all 411 JSON files parse successfully. Full API validation was not run locally.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue: Not provided; examples-only synchronization.

Is this review for (select one): Not a new release; synchronizes examples in existing preview and GA versions.

• a private preview
• a public preview
• GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

• Design Document: Not applicable; no API design changes.
• Previous API Spec Doc: Existing AI Search specifications on main.
• Updated paths: specification/search/data-plane/Search/examples/{2025-11-01-preview,2026-04-01,2026-05-01-preview,2026-08-01-preview}/ and specification/search/data-plane/Search/preview/{2026-05-01-preview,2026-08-01-preview}/examples/.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Release planner

A release plan should have been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Schedule a data plane REST API spec review

Getting help

• First, please carefully read through this PR description, from top to bottom.
• If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
• To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
  This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

[github-actions]

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

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
Swagger	Search-Search
Python	azure-search-documents
Java	com.azure:azure-search-documents

---

Comment generated by After APIView workflow run.