Skip to content

[Search] Add api.md and api.metadata.yml for azure-search-documents#47710

Merged
hizixin merged 1 commit into
mainfrom
search/api-md
Jun 29, 2026
Merged

[Search] Add api.md and api.metadata.yml for azure-search-documents#47710
hizixin merged 1 commit into
mainfrom
search/api-md

Conversation

@hizixin

@hizixin hizixin commented Jun 28, 2026

Copy link
Copy Markdown
Member

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 28, 2026 00:18
@hizixin hizixin requested review from a team as code owners June 28, 2026 00:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR adds the generated API surface snapshot files for the azure-search-documents package: api.md (the textual API stub) and api.metadata.yml (metadata used by the API-md consistency CI check). These files allow CI to detect unintended API surface changes by comparing committed snapshots against freshly generated ones.

Changes:

  • Adds api.metadata.yml with apiMdSha256, parserVersion (0.3.28), and pythonVersion (3.12.13).
  • Adds the corresponding api.md capturing the public API surface of azure.search.documents.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.

File Description
sdk/search/azure-search-documents/api.metadata.yml Adds API metadata (hash + parser/python versions) consumed by the api-md consistency CI gate; follows the standard 3-key format.
sdk/search/azure-search-documents/api.md Adds the generated API surface snapshot (not shown in the visible diff); verified present and well-formed.

@github-project-automation github-project-automation Bot moved this from Untriaged to In Progress in Azure SDK for Search Jun 29, 2026
@hizixin hizixin merged commit e65edd4 into main Jun 29, 2026
24 checks passed
@hizixin hizixin deleted the search/api-md branch June 29, 2026 17:53
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Azure SDK for Search Jun 29, 2026
msyyc pushed a commit that referenced this pull request Jun 30, 2026
…47710)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants