docs: correct saveSession JSDoc default in importer config#149
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: correct saveSession JSDoc default in importer config#149devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
The JSDoc above `saveSession` said "Defaults to false", but `DEFAULT_PARAMS` sets it to `true` and the public docs at docs.oneschema.co/docs/javascript state "Defaults to true". Update the inline docstring to match the actual behavior and the public docs. Co-Authored-By: jonathan <jonathan@oneschema.co>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
The JSDoc for
saveSessiononOneSchemaInitParamsinpackages/importer/src/config.tssays "Defaults to false", but:DEFAULT_PARAMSin the same file setssaveSession: true.importer.tsonly reads/writes the resume token whenmergedParams.saveSessionis truthy, so thetruedefault is what's actually observed in practice.This PR updates the inline docstring to "Defaults to true" so it matches the code default and the public docs. No runtime behavior change.
Context: this mismatch came up while debugging a customer who had passed
is_required: trueviatemplateOverridesand saw it silently not take effect. The root cause was that the SDK was resuming a cached session (per the defaultsaveSession: true), which skips re-applyingtemplateOverrides. The defaults are working as designed; the docstring was the only thing out of sync.Scope note: intentionally not touching the
saveSessionJSDoc inpackages/filefeeds/src/config.tsorpackages/filefeeds-react/src/OneSchemaFileFeeds.tsx— the FileFeedsDEFAULT_PARAMSdoes not setsaveSession, so it genuinely defaults to falsy there.Review & Testing Checklist for Human
@oneschema/importergoing forward (matches public docs today).Notes
Pure docstring change; no tests or behavior affected.
Link to Devin session: https://app.devin.ai/sessions/ece94f7d5a6241b8ad1c3ed12a3f0b3b