Skip to content

docs: Benchling metadata field documentation#4748

Open
drernie wants to merge 2 commits intomasterfrom
docs-benchling-metadata
Open

docs: Benchling metadata field documentation#4748
drernie wants to merge 2 commits intomasterfrom
docs-benchling-metadata

Conversation

@drernie
Copy link
Copy Markdown
Member

@drernie drernie commented Mar 3, 2026

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:

Field Format
authors list
created_at ISO timestamp
creator "First Last <user_id@ent_XXXX>"
display_id "EXP0000XXXXXX"
entry_id "etr_XXXXXX"
files list
modified_at ISO timestamp
web_url string

🤖 Generated with Claude Code

Copy link
Copy Markdown
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.

13 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +59 to +61
5. Click **Push** to upload that revision and set it as latest

Even though data lives in cloud storage, QuiltSync provides local sync
capabilities:
![QuiltSync auto-generated commit](../imgs/quiltsync-commit.png)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

quiltsync-push.png is added in this PR but is not referenced by any markdown file. The Committing Changes section describes a Push step (step 5) and references quiltsync-commit.png, but quiltsync-push.png appears to have been prepared for that section and then forgotten.

Consider either adding a reference to this image in the Committing Changes section, e.g.:

Suggested change
5. Click **Push** to upload that revision and set it as latest
Even though data lives in cloud storage, QuiltSync provides local sync
capabilities:
![QuiltSync auto-generated commit](../imgs/quiltsync-commit.png)
5. Click **Push** to upload that revision and set it as latest
![QuiltSync push](../imgs/quiltsync-push.png)

or removing the file if it is not needed.

@drernie drernie force-pushed the docs-benchling-metadata branch from 9432283 to 8b4d123 Compare March 3, 2026 16:34
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 44.32%. Comparing base (adae9cd) to head (c827640).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4748   +/-   ##
=======================================
  Coverage   44.32%   44.32%           
=======================================
  Files         813      813           
  Lines       32734    32734           
  Branches     5722     5722           
=======================================
  Hits        14509    14509           
  Misses      16221    16221           
  Partials     2004     2004           
Flag Coverage Δ
api-python 92.65% <ø> (ø)
catalog 19.52% <ø> (ø)
lambda 96.63% <ø> (ø)
py-shared 98.18% <ø> (ø)

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.

@drernie drernie self-assigned this Mar 3, 2026
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@drernie drernie requested a review from kevinemoore March 3, 2026 17:30
@drernie drernie enabled auto-merge March 3, 2026 17:30
@drernie drernie requested a review from QuiltSimon March 4, 2026 17:09
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.

2 participants