docs: consolidate stale documentation PRs - #327
Open
tembo[bot] wants to merge 3 commits into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Requesting review from @dodeja who has experience with the following files modified in this PR:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Address Greptile review comments: - Replace document_representation.created/failed with correct event names document.extracted and document.extraction_failed - Remove invalid sample property from webhook trigger example - The OpenAPI spec and event-catalog.mdx confirm these are the correct event names
Remove redundant "or API" from description since document submission is email-only in this workflow.
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
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.
Summary
Consolidates documentation from 4 stale public API docs PRs into one mergeable PR:
wayfair-docs): Comprehensive document processing webhook documentationbugfix/document-line-hold):linehold type documentationcurrent-status):current_statusfilter docs for containers APIsinan/dev-10929-...):initial_custom_fields- already merged to main, skippedChanges
linehold type to the canonical hold types table with accordion documentationcurrent_statusfilter onGET /containersValidation
npx mintlify validatepassed on the edited pagesTest plan
linehold type documentation is consistent with existing hold typescurrent_statusfilter documentation links work correctlyNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Greptile Summary
This PR consolidates public documentation for document-processing webhooks, the
lineterminal hold type, and container current-status filtering.linehold to the holds-and-fees guide.filter[current_status]support for listing containers.Confidence Score: 2/5
The PR should not merge until the document webhook examples are aligned with the supported API contract and the announced container filter is added to the canonical OpenAPI reference.
The guide currently directs integrators to register unsupported event names and submit an invalid webhook-trigger body, while the new container filter remains absent from the source-of-truth API operation.
Files Needing Attention: docs/api-docs/in-depth-guides/document-processing-workflows.mdx, docs/updates/home.mdx
Important Files Changed
linehold type without an established changed-code defect.filter[current_status], but the linked OpenAPI-backed List containers reference does not define the new parameter or its serialization.Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: consolidate stale documentation PR..." | Re-trigger Greptile
Context used: