Skip to content

Spotter memory doc fix - #550

Open
ShashiSubramanya wants to merge 2 commits into
26.9.0.clfrom
spotter-memory-doc-fix
Open

ShashiSubramanya wants to merge 2 commits into
26.9.0.clfrom
spotter-memory-doc-fix

Conversation

@ShashiSubramanya

Copy link
Copy Markdown
Collaborator

Export memory response shape and other fixes

ShashiSubramanya and others added 2 commits September 18, 2026 08:04
The doc showed content.recipe as a nested YAML mapping in both the
export response and the edit-and-reimport YAML example. The server
stores and accepts recipe as a scalar string only — a nested mapping
node causes a SCHEMA validation error on import.

Changes:
- Add IMPORTANT admonition after the export JSON block clarifying that
  the response renders recipe as a JSON object for readability only;
  the actual content field always contains a YAML scalar string
- Extend existing IMPORTANT in the Updating section to explain both
  recipe scalar formats (task/steps double-quoted JSON scalar; NLSv2
  literal-block scalar with |- chomping)
- Fix both RECIPE entries in the YAML example: task/steps entry now
  uses a double-quoted JSON scalar; NLSv2 entry now uses |- literal block
- Add follow-on paragraph after the YAML block explaining the two formats
- Update RECIPE row in Memory item fields table: recipe is an opaque
  scalar string, never a nested YAML mapping
- Update recipe length row in Limits table to note scalar string
- Fix type bullet in export response description to include ALWAYS_APPLY_RULES
- Add SCHEMA error tip in Validation error reference section"
@vercel

vercel Bot commented Sep 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
developer-docs Building Building Preview Sep 18, 2026 4:26am UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview 8ff23eda Deployed Sep 18, 2026 by vercel[bot]
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.

1 participant