docs: Benchling metadata field documentation#4748
Merged
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
drernie
force-pushed
the
docs-benchling-metadata
branch
from
9432283 to
8b4d123
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4748 +/- ##
=======================================
Coverage 45.62% 45.62%
=======================================
Files 831 831
Lines 33597 33597
Branches 5727 5727
=======================================
Hits 15328 15328
Misses 16264 16264
Partials 2005 2005
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:
|
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
kevinemoore
previously approved these changes
Mar 4, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Benchling webhook documentation to explicitly enumerate which Benchling metadata fields are synchronized into each Quilt package, so downstream workflows can validate package metadata against known keys and formats.
Changes:
- Replaces the vague “(experiment IDs, authors, etc.)” text with an explicit list of synced metadata fields and their expected formats.
- Adds inline examples for identifier-like fields (e.g.,
display_id,entry_id) and timestamp fields.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
@drernie ping |
Indent metadata field list as sub-items under "Synchronizes metadata" bullet, add missing quiltsync-push.png image reference, and update PR description to match actual bullet-list format. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
Summary
Documents the specific metadata fields the Benchling webhook synchronizes into each Quilt package. A customer needed this detail to design a metadata-validating workflow — knowing the exact field names, types, and formats lets them write reliable workflow schemas against the package metadata.
Change
docs/examples/benchling.md — Replaces the vague "(experiment IDs, authors, etc.)" with an explicit field list:
authors(list)created_at(ISO timestamp)creator(e.g."First Last <user_id@ent_XXXX>")display_id(e.g."EXP0000XXXXXX")entry_id(e.g."etr_XXXXXX")files(list)modified_at(ISO timestamp)web_url(URL string)docs/examples/quiltsync.md — Adds the missing
quiltsync-push.pngimage reference in the Committing Changes section.🤖 Generated with Claude Code