Skip to content

fix!: Refresh OpenAPI schema to 0.32.1 - #8

Merged
wagnercosta merged 2 commits into
mainfrom
em/openapi-0321
Sep 23, 2026
Merged

wagnercosta merged 2 commits into
mainfrom
em/openapi-0321

Conversation

@emmy-devop

@emmy-devop emmy-devop commented Sep 23, 2026 •

Copy link
Copy Markdown
Collaborator

Requested by @wagnercosta

🔴 Review tier: HIGH — human review required

  • Contract: removes 14 generated asknews api commands (the whole newsletters, analytics and charts groups, plus news get-sources-report). Users who call the newsletter commands today lose them.
  • Release: merging this PR to main updates the release-please Release PR; a human merge of that Release PR publishes the npm CLI.

What

  • Refresh the bundled public OpenAPI snapshot from 0.31.1 to 0.32.1 and regenerate the operation manifest, API command reference, and embedded CLI skill references.
  • Refresh model enums, including claude-fable-5-1, claude-opus-5-5, gpt-6-astra, and gpt-6-sol.
  • Add the new --metric option (surface, citation, grounded) to asknews api distribution top-n-articles-for-domains.
  • Update the generated manifest-count assertion from 46 to 32.

Breaking change

Generated API command coverage drops from 46 to 32, with no new commands. The removed operation IDs are create_charts_endpoint, delete_newsletter, delete_newsletter_contact, get_asset_sentiment, get_newsletter, get_newsletter_contact, get_newsletter_contacts, get_newsletters, get_public_newsletters, get_sources_report, patch_newsletter_contact, post_newsletter, post_newsletter_contacts, and put_newsletter.

The API removed these from its public schema on purpose, in API 0.31.3 ("Remove and deprecate politics/analytics/newsletters"). The runtime behavior differs by group:

  • create_charts_endpoint, get_asset_sentiment and get_sources_report now return 403 for anyone who is not an admin, so dropping those 3 commands changes nothing for customers.
  • The 11 newsletter operations are only hidden from the schema and still work at runtime. Customers who script asknews api newsletters … lose those commands. This is the real break.

The schema changes from 58 to 43 HTTP operations; the existing internal-scope exclusion of unsubscribe_newsletter accounts for the difference (15 operations, 14 commands).

Versioning: the empty fix!: commit af33848 and the fix!: PR title mark this as breaking for release-please. With bump-minor-pre-major, the next release is 0.3.0 (not 0.2.6), and the changelog gets a breaking-changes section. This repo squash-merges with COMMIT_OR_PR_TITLE, so with two commits the squash title defaults to the PR title. When merging, keep the squash title as fix!: Refresh OpenAPI schema to 0.32.1.

Why

Keep published CLI schema-derived commands and model values aligned with the public OpenAPI contract.

How I tested

At 5aeea7b:

  • OpenAPI and help contract tests
  • pnpm check — 118 passed, 3 skipped
  • pnpm build
  • pnpm package:tarball and install smoke (--version, --help)
  • pnpm sync:openapi:check
  • git diff --check and a public-history environment-leak scan
  • npm publish --dry-run correctly stops because unchanged version 0.2.5 already exists; release-please owns versioning

af33848 is an empty commit (no file changes), so these results still apply.

Reviewer re-check at 5aeea7b: the pinned schema matches the live https://api.asknews.app/openapi.json (0.32.1); changes to the remaining operations only add things (4 model enum values, --metric); no curated command, SKILL.md or README references a removed operation; pnpm check and pnpm sync:openapi:check pass; GitHub CI is green.

Risk / rollback

High: the 14 generated asknews api command removals are backward-incompatible for CLI users. No workflow files change. Revert this commit before the Release PR is merged to restore the prior schema snapshot and generated command surface.

Follow-up

The docs-site sync (command pages, .well-known skill, and the two hand-written CLI pages that still mention newsletters) is in a separate frontend MR. That MR should merge only after this CLI version is released.

@wagnercosta wagnercosta changed the title fix: Refresh OpenAPI schema to 0.32.1 fix!: Refresh OpenAPI schema to 0.32.1 Sep 23, 2026
@wagnercosta
wagnercosta merged commit 701868b into main Sep 23, 2026
2 checks passed
@wagnercosta
wagnercosta deleted the em/openapi-0321 branch September 23, 2026 19:51
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