Add a description field to step/path/graph meta - #220
Merged
Conversation
|
🔍 Preview deployed: https://12d01bbe.toolpath.pages.dev |
Promotes description from additionalProperties to a first-class key on StepMeta, PathMeta, and GraphMeta: a human-readable summary of the object itself, distinct from intent (the initial goal of the work). Carried through the JSONL PathOpen/PathMeta line kinds so the typed field round-trips instead of being dropped on write. Reworded the schema and RFC descriptions of intent to match its actual definition. toolpath 0.7.0 -> 0.7.1 (additive). Closes #181
ben-emp
force-pushed
the
ben/meta-description
branch
from
August 21, 2026 15:44
398074d to
e87a52a
Compare
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
2 participants
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.
Closes #181.
Adds an optional
descriptionfield tostepMeta,pathMeta, andgraphMeta: a human-readable summary of the object itself, distinct fromintent, which records the initial goal of the work.schema/toolpath.schema.json:descriptionadded to all three meta shapes;intentdescriptions reworded to match its actual definition ("The initial goal of the work")crates/toolpath/src/types.rs:description: Option<String>onStepMeta,PathMeta,GraphMeta(serde-optional,skip_serializing_if)crates/toolpath/src/jsonl.rs: carried throughPathOpenMetaandPathMetaPatch(plus reader mapping, patch application, emptiness checks, and thePathOpenprojection) — without this, promoting the key out of theextraflatten would have silently dropped it when writing JSONL. Round-trip and patch-line tests added.descriptiondocumented in the meta table, with a paragraph on how it differs fromintentExisting documents are unaffected:
metaallowsadditionalProperties: true, so this promotes the key to a first-class, documented field.Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.