Skip to content

docs(search): rewrite 2025-11-01-preview swagger comparison — prose/bullets, no tables, by operation category#41023

Closed
Copilot wants to merge 7 commits intomainfrom
copilot/compare-swagger-versions
Closed

docs(search): rewrite 2025-11-01-preview swagger comparison — prose/bullets, no tables, by operation category#41023
Copilot wants to merge 7 commits intomainfrom
copilot/compare-swagger-versions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 5, 2026

Rewrites swagger-comparison-2025-11-01-preview.md for readability: all markdown tables replaced with prose and bullet lists, content regrouped under operation-category headings, and line count reduced from 334 → 234 (−30%) with no information lost.

What changed:

  • No more tables — every table (discriminator values, $select types, body param names, 37-rename list, inline↔$ref conversions, new definitions, new operations, etc.) converted to compact bullet lists or inline prose
  • Operation-category grouping throughout both Breaking and Non-Breaking sections:
    • Breaking: Skillset Operations · Service List Operations · Datasource & KB Operations · ChatCompletion Operations
    • Non-Breaking: Schema & Infrastructure · Model & Definition Changes · Index Operations · Knowledge Base & Indexer Operations · Skillset New Features · All Operations
  • Summary condensed from a count table + three sub-heading lists to two plain bullet paragraphs
  • Old separate §7/§8 (two AzureOpenAI rename entries) merged into a single entry; old §10/§14 (index $select removal and new index stats operations) co-located under Index Operations

PR review workflow diagram

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

spec_pr_review_workflow_diagram

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:

Is this review for (select one):

  • 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: N/A (documentation-only change)
  • Previous API Spec Doc: swagger-comparison-2025-11-01-preview.md (same file, rewritten)
  • Updated paths: specification/search/data-plane/Search/swagger-comparison-2025-11-01-preview.md

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.

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

Tooling

Guidelines & Specifications

Helpful Links

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 Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 5, 2026

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


Comment generated by summarize-checks workflow run.

… vs TSP-compiled)

Co-authored-by: yangylu91 <53235012+yangylu91@users.noreply.github.com>
…ges, refreshed content

Co-authored-by: yangylu91 <53235012+yangylu91@users.noreply.github.com>
Copilot AI changed the title Search 2025-11-01-preview: swagger comparison analysis (hand-authored vs TSP-compiled) docs(search): rewrite 2025-11-01-preview TypeSpec migration comparison with impact-level classification and refreshed swagger analysis Mar 6, 2026
Co-authored-by: yangylu91 <53235012+yangylu91@users.noreply.github.com>
Copilot AI changed the title docs(search): rewrite 2025-11-01-preview TypeSpec migration comparison with impact-level classification and refreshed swagger analysis docs(search): refresh 2025-11-01-preview swagger comparison + add reusable task prompt Mar 6, 2026
… and #41062

Co-authored-by: yangylu91 <53235012+yangylu91@users.noreply.github.com>
Copilot AI changed the title docs(search): refresh 2025-11-01-preview swagger comparison + add reusable task prompt docs(search): retract Accept-header breaking change; it is fixed by PRs #41045/#41062 Mar 6, 2026
Copilot stopped work on behalf of yangylu91 due to an error March 6, 2026 19:59
@yangylu91 yangylu91 changed the title docs(search): retract Accept-header breaking change; it is fixed by PRs #41045/#41062 Search 2026-04-01: cross-version changes summary Mar 6, 2026
@yangylu91 yangylu91 changed the title Search 2026-04-01: cross-version changes summary Search 2025-11-01-preview: Changes for TypeSpec Migration Mar 6, 2026
…impact-level headings

Co-authored-by: yangylu91 <53235012+yangylu91@users.noreply.github.com>
Copilot AI changed the title Search 2025-11-01-preview: Changes for TypeSpec Migration docs(search): regroup 2025-11-01-preview swagger comparison by operation category Mar 6, 2026
…uped by operation category

Co-authored-by: yangylu91 <53235012+yangylu91@users.noreply.github.com>
Copilot AI changed the title docs(search): regroup 2025-11-01-preview swagger comparison by operation category docs(search): rewrite 2025-11-01-preview swagger comparison — prose/bullets, no tables, by operation category Mar 7, 2026
@yangylu91 yangylu91 closed this Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants