Rewrite batch-compliance docs for the api.x.com byte-path flow - #410
Merged
Merged
Conversation
The three narrative pages still documented the legacy GCS flow: storage.googleapis.com upload/download URLs, resumable uploads, and an event vocabulary that no longer matches results. - introduction: complete the endpoint table (upload/download byte paths, cancel), replace the event tables with the real action/reason contract including rehydrate/tweet_edited and scrub_geo/geo_scrubbed. - quickstart: api.x.com signed URLs with expiry fields and lifetimes, one-active-job-per-type note, upload semantics (single PUT, 200, 403 on expired token), NDJSON results with real examples incl. error records and the deleted_at alias, event-priority rule, cancel section. - integrate: full replacement of the GCS resumable-upload guide with an integration guide covering signed-URL lifecycle, job lifecycle, upload limits (1 GiB single PUT, no resumable mode), result-interpretation rules, the problem+json error catalog, and operational best practices.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Decision: upload/download URLs require the App's Authorization header in addition to the signed URL token, replacing the legacy GCS model where pre-signed URLs were self-authorizing. Migrating integrations must add the header; a migration note now flags this in both the quickstart and the integration guide.
tcaldwell-x
marked this pull request as ready for review
September 17, 2026 23:26
This was referenced Sep 17, 2026
This branch was successfully deployed
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.
Do not merge until the prod cutover — merging deploys to docs.x.com. Draft PR for review only.
Rewrites the three batch-compliance narrative pages, which still document the legacy GCS flow (storage.googleapis.com URLs, resumable uploads, stale event vocabulary):
action/reasoncontract, includingrehydrate/tweet_editedandscrub_geo/geo_scrubbed(verified against staging1 finale results, 21/21 graded events).upload_expires_at/download_expires_atand lifetimes (~15 min / ~7 d), one-active-job-per-type 409 note, single-PUT upload semantics, real NDJSON result examples (error records,deleted_atalias, nullableredacted_at), event-priority rule, cancel section.Two decision-dependent spots (checklist #1, byte-path auth): quickstart and integrate say the signed token is the sole credential on byte-paths. If the decision keeps Bearer required, those two sentences flip and two curl examples gain an auth header — everything else stands either way.
Note: the OpenAPI-generated reference stubs are current except two lingering
resumableschema properties, which must be removed in the spec's source repo (this repo's openapi.json is overwritten by the sync Action), gated on checklist decision #3.