Skip to content

chore: sync FastAPI OAS + update docs for v1.10.2 - #158

Merged
Kizy625 merged 2 commits into
mainfrom
chore/mirror-fastapi-oas-20261022-1421
Oct 23, 2026
Merged

Kizy625 merged 2 commits into
mainfrom
chore/mirror-fastapi-oas-20261022-1421

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Automated sync of web-search-api/api-reference/fastapi-openapi.yml from https://catchall.newscatcherapi.com/openapi.json.

Review checklist:

  • Diff looks expected — no accidental drops of descriptions or schema renames
  • If new endpoints appear, note them (MDX pages will be needed — handled in Stage 2)
  • If anything looks wrong, close this PR and fix it in the FastAPI service

@mintlify

mintlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
newscatcherinc 🟢 Ready View Preview Oct 23, 2026, 8:26 AM

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

@mintlify

mintlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
newscatcherinc-docs 🟢 Ready View Preview Oct 23, 2026, 8:26 AM

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

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

Copy link
Copy Markdown
Contributor Author

Docs update for v1.10.2 added to this branch (commit 8d3199d).

Auto-updated

  • catch-all-api.yml: info.version 1.10.0 → 1.10.2. Added the new JobIterationInfo schema (turn). Added a job_info field to StatusResponseDto, PullJobResponseDto, and UserJob (the live-spec counterpart of UserJobResponseDto). Added one sentence to the PublicJobStatus description saying later turns repeat fetching/clustering/enriching.
  • changelog.mdx: added the v1.10.2 entry at the top
  • concepts/jobs.mdx: added job_info.turn to the Search turns section and to the status, results, and list-jobs response examples
  • get-started/quickstart.mdx: added job_info to the status response example

Please review

  • Version mismatch: the mirrored fastapi-openapi.yml reports 1.10.3, but this release is 1.10.2. I bumped the live spec to 1.10.2 as RELEASE_VERSION says. job_info / JobIterationInfo is the only public schema change between the two snapshots, and the 1.10.2 Notion page doesn't mention it. It may have shipped in 1.10.3. If so, move the "Search turn in job responses" changelog section to a 1.10.3 entry.
  • "Local News compatibility is restored" comes straight from Notion. Local News isn't documented anywhere in the CatchAll docs, so please reword or remove it if it means nothing to public users.
  • The changelog says queries match "full article content" and "translated article content", based on the Notion business-impact notes. The 1.10.0 entry says the first turn matches titles and summaries. Please check whether the two statements conflict.

Skipped (internal / not public API)

  • Listing and disabling organization admin API keys: no such endpoint in the public spec.
  • Internal raw-query search filters, quality-check reporting, LLM/provider resilience, observability, config/dependency upgrades, and release maintenance.

Decisions made

  • Kept the live spec's existing Dto schema names (StatusResponseDto, PullJobResponseDto) and used the non-Dto name JobIterationInfo for the new schema, as the source spec does.
  • Left the SDK polling code samples in jobs.mdx unchanged. Whether the SDKs expose job_info yet is unknown, so only the JSON examples and the prose were updated.

Notion changelog: https://app.notion.com/p/newscatcherapi/1-10-2-3f3b932ccbdc80e7b867f3df7c940cc6


🤖 Generated with Claude Code

@github-actions github-actions Bot changed the title chore: sync FastAPI OAS snapshot 2026-10-22 chore: sync FastAPI OAS + update docs for v1.10.2 Oct 23, 2026
@Kizy625
Kizy625 merged commit ec10c17 into main Oct 23, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
staging — 8d3199d9 Deployed Oct 23, 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