Skip to content

Update search doc#4454

Merged
nl0 merged 6 commits intomasterfrom
up-search-docs
Aug 25, 2025
Merged

Update search doc#4454
nl0 merged 6 commits intomasterfrom
up-search-docs

Conversation

@nl0
Copy link
Member

@nl0 nl0 commented Jul 24, 2025

No description provided.

@nl0 nl0 requested review from drernie, fiskus and sir-sigurd July 24, 2025 12:01
@codecov
Copy link

codecov bot commented Jul 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 37.97%. Comparing base (07cc956) to head (d8868de).
⚠️ Report is 2 commits behind head on master.

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     
Flag Coverage Δ
api-python 91.44% <ø> (ø)
catalog 17.83% <ø> (ø)
lambda 92.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

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:

  1. Elasticsearch version update: Updated from version 6.7 to 6.8 reference
  2. Reorganized search fields: Split search parameters into object-specific and package-specific categories for better clarity
  3. 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
  4. Accurate field names: Updated field names to match actual implementation (e.g., handleptr_name, commentmnfst_message, hashmnfst_hash)
  5. 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

Edit Code Review Bot Settings | Greptile

Copy link
Member

@sir-sigurd sir-sigurd left a comment

Choose a reason for hiding this comment

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

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

@nl0
Copy link
Member Author

nl0 commented Jul 24, 2025

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

@drernie drernie requested a review from kevinemoore July 25, 2025 16:07
Copy link
Contributor

@kevinemoore kevinemoore left a comment

Choose a reason for hiding this comment

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

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

drernie
drernie previously approved these changes Aug 20, 2025
@drernie drernie requested a review from kevinemoore August 22, 2025 20:48
@drernie
Copy link
Member

drernie commented Aug 22, 2025

@kevinemoore Please approve if this addressed your concern.

@nl0 nl0 enabled auto-merge August 25, 2025 10:27
@nl0 nl0 dismissed kevinemoore’s stale review August 25, 2025 10:28

Python API doc string to be updated in a subsequent PR

@nl0 nl0 added this pull request to the merge queue Aug 25, 2025
Merged via the queue into master with commit 2803f9a Aug 25, 2025
40 checks passed
@nl0 nl0 deleted the up-search-docs branch August 25, 2025 10:34
@nl0
Copy link
Member Author

nl0 commented Aug 25, 2025

follow-up: #4488

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants