Point fault handling at the job, not the silo entry - #559
Open
samlown wants to merge 1 commit into
Open
Conversation
The white label guide told integrators to read the faults array from the silo entry, with no mention that the entry only carries faults as a backwards-compatible copy from the job that assigned its last state, and only when that state is an error or failure. A support thread hit exactly that gap: an entry in the error state returned no faults on a GET, and downstream fault mapping broke. Step 4 now splits the two sources — the entry for state and attachments, the job for faults via the webhook's transform_job_id — and the FAQ that recommended the entry over the job is rewritten to match. The webhooks guide gains the same caveat next to the payload's faults field. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
From a support thread: a customer's downstream fault mapping broke because
GET /silo/v1/entries/{id}returned"state":"error"with nofaultsfield, while theinvoices.invoice_sentwebhook for the same entry did carry faults.The behaviour is expected — the entry's
faultsis a backwards-compatibility copy from the job that assigned the entry's most recent state, populated only when that state is an error or failure. It's a sub-query, so there's no consistency window to wait out. The job is the deterministic source: one job, one set of faults, versus one entry to N jobs.The docs didn't say any of that.
workspace/white-label.mdxStep 4 actively pointed integrators at the entry's faults array, and an FAQ recommended the entry over the job.Changes
workspace/white-label.mdx— Step 4 retitled "Fetch the results" and split by source: the entry for state and attachments, the job for faults via the webhook'stransform_job_id. A<Warning>explains why, and notes theallow_invalidexception where the entry's faults do describe the stored document.workspace/white-label.mdx— FAQ "Can I fetch the job instead of the silo entry?" (which said the entry was the better source of truth for faults) becomes "Should I fetch the silo entry or the job?" — entry for the outcome, job for the reason.guides/webhooks.mdx— an<Info>under the payload field list stating the webhook'sfaultsare the faults of the job named bytransform_job_id, and that these plus the job's own array are what to rely on.Not included
SiloEntry.faultsinopenapi/silo_v1.yamlcarries the same neutral description and deserves the caveat too, but the specs here are copies generated from theapiservice. That belongs ininternal/interfaces/web/silo/models.goupstream, followed by a spec re-copy.Testing
mint openapi-check/mint devweren't run — the local Node is 26.7.0 and the Mintlify CLI requires ≤24. Both changed files are prose plus standard Mintlify components (<Warning>,<Info>) already used elsewhere in each file, and no page anchors or nav entries changed. Worth a look at the Mintlify preview build before merging.🤖 Generated with Claude Code