Skip to content

Docs | Update CatchAll API docs for v1.10.0 - #153

Merged
Kizy625 merged 1 commit into
mainfrom
docs/update-v1.10.0
Sep 30, 2026
Merged

Kizy625 merged 1 commit into
mainfrom
docs/update-v1.10.0

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Changes for v1.10.0

Auto-updated

  • catch-all-api.yml: version bump 1.9.0 → 1.10.0. No schema changes needed (see below).
  • changelog.mdx: added v1.10.0 entry (Multi-turn search, Per-company clustering for Company Monitors, common-word company name matching).
  • concepts/jobs.mdx: new ### Search turns section under Get job status, and a note that fetching/clustering/enriching can repeat when a job moves to a new turn.
  • concepts/company-monitors.mdx: new ### Records per company section under Get results, plus a <Note> on common-word company names/aliases being matched via NER.

Spec diff summary

  • Old snapshot (1.8.1, c00b246~1) → new snapshot (1.10.0): the only structural change is schedule + timezone on UpdateMonitorRequestDto. Both are already in catch-all-api.yml (documented in 1.8.2), so nothing was added (L-002).
  • Remaining auto-spec diff is the "Event Monitors" → "Monitors" wording in tags/descriptions. Skipped — see Decisions.

Please review

  • job_info.turn is not documented. The Notion Band Iteration page says job_info.turn (1-indexed) is now returned by GET /catchAll/status/{job_id}, POST /catchAll/bulk_status, GET /catchAll/pull/{job_id}, GET /catchAll/job_info/{job_id}, and GET/POST /catchAll/jobs/user. However, job_info doesn't exist in either fastapi-openapi.yml or catch-all-api.yml, so I left it out of the spec, the changelog, and the guides. If it's meant to be public, it should be added to the response schemas (and the FastAPI models) in a follow-up.
  • The changelog says low-limit jobs "often finish after the first turn, in around four minutes". That comes from Notion's "observed jobs complete in around 4 minutes". Check that this is fine to state publicly. jobs.mdx still says "Jobs typically take 10-15 minutes", which I left unchanged.
  • The Notion feature pages call entity splitting configurable (CLUSTERING_SPLIT_BY_ENTITY, default true). The docs describe it as always on for connected jobs.

Decisions made

  • Kept "Event Monitors" terminology. The auto-generated spec renamed "Event Monitors" → "Monitors", but commit 73c7bb9 intentionally renamed pages and the live spec the other way ("Monitors" → "Event Monitors"). The auto-sync overwrote that change in fastapi-openapi.yml. I treated this as description-only and did not revert the docs.
  • Kept the existing UpdateMonitorRequestDto schema name in catch-all-api.yml (an exception to the L-008 Dto-stripping convention that already existed). Renaming it would have meant changing $refs, which is outside the scope of this release.
  • Left out internal details from Notion: rank windows per turn, Beyond News running only on turn 2, source-group rank handling, advisory locks, billing baselines, env vars, and the common-word list size.
  • Notion features came from the release page's Features relation (Band Iteration, Entity-based clustering). The inline linked database wasn't accessible to the integration.
  • Pre-existing drift between catch-all-api.yml and fastapi-openapi.yml (for example SubmitRequest.schema, CreateDatasetRequest.project_id, and MonitorRecord fields) is older than this release and was not touched.
  • mintlify broken-links passes.

Notion changelog

https://app.notion.com/p/newscatcherapi/1-10-0-3eab932ccbdc80dab034fdc2508b425e?source=copy_link


🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
newscatcherinc 🟢 Ready View Preview Sep 30, 2026, 9:28 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@mintlify

mintlify Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
newscatcherinc-docs 🟢 Ready View Preview Sep 30, 2026, 9:28 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@Kizy625
Kizy625 merged commit 8a9ed82 into main Sep 30, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
staging — 17e59570 Deployed Sep 30, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant