Skip to content

chore: sync FastAPI OAS + update docs for v1.8.2 - #151

Merged
Kizy625 merged 3 commits into
mainfrom
chore/mirror-fastapi-oas-20260930-0906
Sep 30, 2026
Merged

Kizy625 merged 3 commits into
mainfrom
chore/mirror-fastapi-oas-20260930-0906

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 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:16 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:16 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.8.2 added to this branch

Auto-updated

  • catch-all-api.yml: info.version 1.8.1 → 1.8.2. UpdateMonitorRequestDto gains optional schedule and timezone. PATCH /catchAll/monitors/{monitor_id} has a new description, a schedule request example, and a 422 description covering unparseable or too-closely-spaced schedules.
  • changelog.mdx: added the v1.8.2 entry at the top.
  • concepts/event-monitors.mdx: new "Change the schedule" subsection with a 5-tab CodeGroup. Removed the note saying the schedule can't be changed.
  • how-to/configure-event-monitors.mdx: update section now covers schedule changes. Updated the Note and the Tip.

Please review

  • Spec version mismatch: the mirrored fastapi-openapi.yml reports version: 1.10.0, but the release is 1.8.2. I set the live spec to 1.8.2. The structural diff against the previous snapshot only showed the monitor schedule change, so either no 1.9/1.10 API changes exist yet or the version string in the snapshot is ahead.
  • SDK support: the Python, TypeScript, and Java examples use schedule on update_monitor / updateMonitor / UpdateMonitorRequestDto.builder().schedule(...). Please confirm that the published SDKs expose this field. libraries/*.mdx were left unchanged for that reason.
  • I wrote that the monitor "keeps its ID, reference job, webhooks, and execution history" after a schedule change. This follows from it being a PATCH, but it isn't stated explicitly in Notion.

Intentionally skipped

  • "Event monitor" → "Monitor" renaming across tags and descriptions in the auto-generated spec. This is description-only, and the public docs consistently use "Event Monitors" (the new spec also points to a how-to/configure-monitors URL that doesn't exist).
  • embedding_source / Qwen embedding cutover: not in the public spec, so it's internal.
  • Raw Query PIT pagination, Docker images, dev resources, and orchestrator model config: internal. Only the user-visible reliability outcome is in the changelog.
  • Schema reordering in fastapi-openapi.yml: no contract change.

Decisions made

  • Kept the live schema name UpdateMonitorRequestDto, because the live spec already references it with the suffix. Renaming it would break the SDK and docs references.
  • The new 422 response references ValidationErrorResponse, since HTTPValidationError doesn't exist in the live spec.
  • The SDK examples put the timezone inline in the schedule text (every Monday at 9 AM EST), matching existing create-monitor examples. The timezone field is documented in prose.
  • The commit trailer names the model that actually ran (Claude Opus 5.5) instead of the Sonnet 4.6 line in the agent template.

Notion changelog

https://app.notion.com/p/newscatcherapi/1-8-2-3d4b932ccbdc80078fb0d19183e75c7c?source=copy_link


🤖 Generated with Claude Code

@github-actions github-actions Bot changed the title chore: sync FastAPI OAS snapshot 2026-09-30 chore: sync FastAPI OAS + update docs for v1.8.2 Sep 30, 2026
@Kizy625
Kizy625 merged commit 593dabc into main Sep 30, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
staging — cab507b0 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.

2 participants