Skip to content

docs(sdk): document loadNdjson; retire stale version claims - #18

Merged
aaltshuler merged 1 commit into
mainfrom
docs/loadndjson-readme
Aug 9, 2026
Merged

aaltshuler merged 1 commit into
mainfrom
docs/loadndjson-readme

Conversation

@aaltshuler

@aaltshuler aaltshuler commented Aug 9, 2026 •

Copy link
Copy Markdown
Contributor

README catch-up for the 0.9.0 sync (#17): documents og.loadNdjson() with envelope shapes and bounds, adds it to the retry table, corrects the append retry row for 0.9.0 key-conflict semantics, and stops hardcoding a 0.7.x server target in favor of the Server compatibility section. npm shows this README from the next publish; GitHub immediately.

Greptile Summary

The README now documents the 0.9.0 loadNdjson() API and removes a stale fixed-version compatibility claim.

  • Adds the raw NDJSON request example, accepted node and edge envelopes, batching limits, and commit semantics.
  • Adds loadNdjson() to the retry guidance and clarifies version-dependent append behavior.
  • Directs readers to the Server compatibility section for the supported server release range.

Confidence Score: 5/5

The documentation-only PR appears safe to merge with no actionable correctness or security issues identified.

The new method signature, request encoding, envelope examples, default merge mode, size-limit behavior, and retry guidance agree with the SDK and server contracts.

Important Files Changed

Filename Overview
packages/sdk/README.md Documentation changes accurately reflect the SDK signature, generated API contract, server parser, defaults, and retry behavior.

Reviews (1): Last reviewed commit: "docs(sdk): document loadNdjson; retire t..." | Re-trigger Greptile

…laims

- Bulk-load section gains og.loadNdjson() (server 0.9.0+): raw
  application/x-ndjson body, strict bounded graph batch, envelope
  shapes, 413 bound, fork-if-missing rule.
- Retry table adds loadNdjson and corrects the append row: a 0.9.0+
  server rejects duplicate ids with a key conflict instead of
  absorbing them.
- The intro note now points at Server compatibility instead of
  hardcoding a 0.7.x target.
@aaltshuler
aaltshuler merged commit 1ffc4c9 into main Aug 9, 2026
3 checks passed
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