Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4454 +/- ##
========================================
Coverage 37.97% 37.97%
========================================
Files 826 826
Lines 36388 36388
Branches 5955 5955
========================================
Hits 13819 13819
- Misses 21345 22048 +703
+ Partials 1224 521 -703
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Greptile Summary
This PR updates the Quilt Catalog search documentation (docs/Catalog/Search.md) to align with the actual Elasticsearch implementation. The key changes include:
- Elasticsearch version update: Updated from version 6.7 to 6.8 reference
- Reorganized search fields: Split search parameters into object-specific and package-specific categories for better clarity
- Three-document structure documentation: Added comprehensive explanation of how package metadata is indexed using three different document types:
- Manifests (
mnfst): contain package metadata, hash, comment, and workflow information - Pointers (
ptr): represent named package revisions, associating manifests with names and tags - Entries (
entry): represent individual objects in packages with their metadata
- Manifests (
- Accurate field names: Updated field names to match actual implementation (e.g.,
handle→ptr_name,comment→mnfst_message,hash→mnfst_hash) - Expanded field coverage: Added many new searchable fields with detailed examples and descriptions
This documentation update makes the search functionality more discoverable and usable by providing users with the correct field names and a better understanding of the underlying data structure. The changes integrate well with the existing Quilt catalog system, as they document the actual Elasticsearch schema that powers the search functionality across the platform.
Confidence score: 4/5
- This PR is very safe to merge as it only updates documentation to match the actual implementation
- High confidence because it's a documentation-only change that improves accuracy and usability without touching any code
- No files need additional attention as this is purely documentation enhancement
1 file reviewed, no comments
sir-sigurd
left a comment
There was a problem hiding this comment.
do we promote these fields as something stable?
I hope we don't and if we don't might make sense to make it clear
no, i think we don't |
kevinemoore
left a comment
There was a problem hiding this comment.
These docs changes are very helpful. We should also link to the schema in the docs for the Python search (https://docs.quilt.bio/quilt-python-sdk/api-reference/api#search).
|
@kevinemoore Please approve if this addressed your concern. |
Python API doc string to be updated in a subsequent PR
|
follow-up: #4488 |
No description provided.