Add instance Elasticsearch verification - #95
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The verification API, errors, documentation, and tests are covered with no unresolved review comments.
Pull request overview
Adds async Elasticsearch backend verification for directly constructed Annotator instances, including identity validation, structured errors, cleanup, tests, and documentation.
Changes:
- Adds index-independent verification clients and server checks.
- Introduces and exports
BackendVerificationError. - Adds
verify_backend()with comprehensive tests and README guidance.
File summaries
| File | Description |
|---|---|
tests/test_elasticsearch.py |
Tests verification success, failures, identity checks, cleanup, and exports. |
README.md |
Documents direct verification usage and results. |
biothings_annotator/annotator/utils.py |
Builds uncached verification clients. |
biothings_annotator/annotator/exceptions.py |
Defines structured verification errors. |
biothings_annotator/annotator/elasticsearch.py |
Adds connection and server identity validation. |
biothings_annotator/annotator/annotator.py |
Adds verify_backend(). |
biothings_annotator/annotator/__init__.py |
Re-exports the new exception. |
biothings_annotator/__init__.py |
Exposes the exception publicly. |
Review details
- Files reviewed: 8/8 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
add verification method to instance usage