[Search] Add api.md and api.metadata.yml for azure-search-documents#47710
Open
hizixin wants to merge 1 commit into
Open
[Search] Add api.md and api.metadata.yml for azure-search-documents#47710hizixin wants to merge 1 commit into
hizixin wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
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.ymlwithapiMdSha256,parserVersion(0.3.28), andpythonVersion(3.12.13). - Adds the corresponding
api.mdcapturing the public API surface ofazure.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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
General Guidelines and Best Practices
Testing Guidelines