docs: export and import a graph component as one file - #66
Open
olavgg wants to merge 2 commits into
Open
Conversation
Platform branch feat/resource-graph-export-import adds GET /resources/export/{id}
and POST /resources/import: a whole connected component, keyed by externalId,
as one gzip-compressed binary file, with import replaying the file through the
ordinary create pipeline in segments of 50 000 objects and skipping whatever
already exists so a re-upload resumes where a failed one stopped.
Nothing here covered it. Adds a section to the resources reference (what the
file carries and does not, the access each side needs, the skip rules, the
segment semantics, the summary body, the status codes, and a curl pair since
no client wraps the endpoints), a row in the client-coverage table, and the
transfer ceilings on the limits page.
One caution worth reading before trusting the 512 MB figure: the import upload
is not exempt from the general request-body cap, which defaults to 4 MiB and
is deployment-wide, so that is what a default deployment accepts. Written
from the filter code rather than the endpoint's own description.
Verified: npm run build succeeds.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Olav Gjerde <olav@intellistream.ai>
Platform branch fix/graph-import-streams adds POST /resources/import and
GET /resources/export/{id} to the streaming exemption the file endpoints
already had, so the import is consumed as it arrives, bounded only by the
file format's own 512 MB and two-million-object ceilings, and is not
charged to the daily ingest byte quota. The shipped nginx examples gain
matching locations.
The previous commit on this branch documented the cap as it then stood.
That caution is replaced by the rule as it is now.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Olav Gjerde <olav@intellistream.ai>
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
1 participant
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.
Platform branch feat/resource-graph-export-import adds GET /resources/export/{id} and POST /resources/import: a whole connected component, keyed by externalId, as one gzip-compressed binary file, with import replaying the file through the ordinary create pipeline in segments of 50 000 objects and skipping whatever already exists so a re-upload resumes where a failed one stopped.
Nothing here covered it. Adds a section to the resources reference (what the file carries and does not, the access each side needs, the skip rules, the segment semantics, the summary body, the status codes, and a curl pair since no client wraps the endpoints), a row in the client-coverage table, and the transfer ceilings on the limits page.
One caution worth reading before trusting the 512 MB figure: the import upload is not exempt from the general request-body cap, which defaults to 4 MiB and is deployment-wide, so that is what a default deployment accepts. Written from the filter code rather than the endpoint's own description.
Verified: npm run build succeeds.