Clarify run_script productive client return shape in docs#183
Merged
Conversation
Note in the scripting docs (served by search_docs) that the injected
productive client returns flattened records and that list returns
{ data, meta } — read field keys directly (id, name, number) rather than
JSON:API .type/.attributes, and bound large queries with opts like
{ per_page: 50 }.
Co-authored-by: Claude <claude@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #183 +/- ##
=======================================
Coverage 97.27% 97.27%
=======================================
Files 266 266
Lines 8867 8867
Branches 2777 2787 +10
=======================================
Hits 8625 8625
Misses 236 236
Partials 6 6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Small docs follow-up from live testing of the runner-backed
run_script.The injected
productiveclient returns flattened records (readid,name,numberdirectly, not JSON:API.type/.attributes) andlistreturns{ data, meta }(e.g.meta.total_count). The scripting docs (surfaced bysearch_docs) now say so, and the example shows bounding large queries with{ per_page: 50 }(a slow unboundedtasks.list({status:'open'})was the one rough edge in testing).Docs-only; no behavior change. 11 doc/search tests pass,
npm run checkclean.🤖 Generated with Claude Code