Skip to content

docs: consolidate stale documentation PRs - #327

Open
tembo[bot] wants to merge 3 commits into
mainfrom
docs/consolidate-stale-documentation-prs
Open

docs: consolidate stale documentation PRs#327
tembo[bot] wants to merge 3 commits into
mainfrom
docs/consolidate-stale-documentation-prs

Conversation

@tembo

@tembo tembo Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Consolidates documentation from 4 stale public API docs PRs into one mergeable PR:

Changes

  1. holds-and-fees.mdx: Added line hold type to the canonical hold types table with accordion documentation
  2. document-processing-workflows.mdx: Expanded with comprehensive webhook documentation for document processing (subscription, endpoint requirements, payload structure, schema versioning, document types)
  3. updates/home.mdx: Added May 22, 2026 release note for current_status filter on GET /containers

Validation

  • npx mintlify validate passed on the edited pages
  • All changes match existing Mintlify/docs style conventions

Test plan

  • Review line hold type documentation is consistent with existing hold types
  • Review document processing webhook docs are accurate and complete
  • Verify current_status filter documentation links work correctly

Want tembo to make any changes? Add a comment with @tembo and i'll get back to work!

View on Tembo  Review in Tembo  View Agent Settings


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Greptile Summary

This PR consolidates public documentation for document-processing webhooks, the line terminal hold type, and container current-status filtering.

  • Expands the document-processing guide with setup, delivery, payload, schema-versioning, and troubleshooting guidance.
  • Adds the line hold to the holds-and-fees guide.
  • Announces 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

Filename Overview
docs/api-docs/in-depth-guides/document-processing-workflows.mdx Substantially expands the workflow guide, but the subscription event names and webhook-trigger request conflict with the current OpenAPI contract.
docs/api-docs/in-depth-guides/holds-and-fees.mdx Adds a focused description and example for the lowercase line hold type without an established changed-code defect.
docs/updates/home.mdx Announces filter[current_status], but the linked OpenAPI-backed List containers reference does not define the new parameter or its serialization.

Fix all with Greploop

Fix All in Codex Fix All in Claude Code

Prompt To Fix All With AI
### Issue 1
docs/api-docs/in-depth-guides/document-processing-workflows.mdx:74-75
**Unsupported subscription event names**

When an integrator copies this subscription request, it submits `document_representation.created` and `document_representation.failed`, but the webhook event enum supports `document.extracted` and `document.extraction_failed`, causing registration to fail instead of subscribing the endpoint to document extraction notifications.

### Issue 2
docs/api-docs/in-depth-guides/document-processing-workflows.mdx:401-404
**Invalid webhook trigger payload**

When an integrator copies this test request, it sends an unsupported event value and a `sample` property that is absent from the trigger request schema, causing the request to be rejected or preventing it from producing the promised document-type-specific payload.

### Issue 3
docs/updates/home.mdx:1115-1117
**Filter missing from API contract**

This release note advertises comma-separated `filter[current_status]` values, but the linked `GET /containers` OpenAPI operation defines no such parameter, causing the canonical API reference and generated consumers to omit the announced feature and its serialization contract.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: consolidate stale documentation PR..." | Re-trigger Greptile

Greptile also left 3 inline comments on this PR.

Context used:

Add line hold type, current_status filter, and webhook docs from:
- PR #185: Document webhook docs  
- PR #314: Document line hold type
- PR #221: Current status filter docs
- PR #299: initial_custom_fields (already merged to main)
@tembo tembo Bot added the tembo Pull request created by Tembo label Aug 17, 2026
@mintlify

mintlify Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
terminal49 🟢 Ready View Preview Aug 17, 2026, 5:36 AM

@tembo
tembo Bot requested a review from dodeja August 17, 2026 05:36
@tembo

tembo Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor Author

Requesting review from @dodeja who has experience with the following files modified in this PR:

  • docs/updates/home.mdx
  • docs/api-docs/in-depth-guides/holds-and-fees.mdx

@vercel

vercel Bot commented Aug 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api Ready Ready Preview Aug 17, 2026 6:18pm

Request Review

Comment thread docs/api-docs/in-depth-guides/document-processing-workflows.mdx Outdated
Comment thread docs/api-docs/in-depth-guides/document-processing-workflows.mdx Outdated
Comment thread docs/updates/home.mdx
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants