Document the tenant file store endpoints - #160
Merged
Merged
Conversation
/files upload/list, /files/{id} metadata/tombstone-delete, and
/files/{id}/content, with the file-record and file-list-page schemas.
The list documentation carries the delta-loading recipe (exclusive
updatedSince watermark + includeDeleted tombstone propagation) that the
Precog Files connector follows. Ships in precog/services#3616.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Optional query param on POST /files that starts a load of the named
pipeline (same machinery as POST /pipelines/{pipeline-id}/loads) once the
upload is durably stored; unknown pipeline is a 404 before anything is
stored.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The boundary record re-lists and consumers dedupe by id, closing the same-millisecond page-boundary loss the strict bound allowed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…s) on POST /files Both are implemented responses: PRECOG_FILES_MAX_UPLOAD_BYTES ends an oversized upload with 413, and returnRows against a pipeline whose destination cannot serve deterministic rows answers 422. Nothing is stored in either case. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
OpenAPI documentation for the tenant-scoped file store shipping in precog/services#3616 (chart wiring: precog/devops#1637).
Adds to
reference/public-http-api.yaml:POST /files— multipart upload (part namedfile; filename and MIME from the part)POST /files?postUploadPipeline=<id>— optional upload param that starts a load of the named pipeline (same machinery asPOST /pipelines/{pipeline-id}/loads) once the upload is stored; unknown pipeline is a 404 before anything is storedGET /files— listing withupdatedSince(exclusive epoch-ms watermark),mimeType,includeDeleted,offset/limit; the description carries the full delta-loading recipe including tombstone propagationGET /files/{fileId}— metadata (outlives content access for tombstoned files)DELETE /files/{fileId}— tombstone semantics: bumpsupdatedAtso deletes ride the delta stream; idempotentGET /files/{fileId}/content— bytes with stored Content-Type;410 Gonewhen tombstonedfile-record(reusing the existingepoch-millis) andfile-list-pageThe read-only
/internal/files/{tenantId}mirror is deliberately not documented here — it is cluster-internal with static-token auth, not part of the public surface.npm run lint:openapipasses. Endpoint behavior matches what is deployed and E2E-verified on staging (service-facade:193.4.0-snapshot-8d178a4).🤖 Generated with Claude Code