fix!: Refresh OpenAPI schema to 0.32.1 - #8
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by @wagnercosta
🔴 Review tier: HIGH — human review required
asknews apicommands (the wholenewsletters,analyticsandchartsgroups, plusnews get-sources-report). Users who call the newsletter commands today lose them.mainupdates the release-please Release PR; a human merge of that Release PR publishes the npm CLI.What
claude-fable-5-1,claude-opus-5-5,gpt-6-astra, andgpt-6-sol.--metricoption (surface,citation,grounded) toasknews api distribution top-n-articles-for-domains.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, andput_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_sentimentandget_sources_reportnow return 403 for anyone who is not an admin, so dropping those 3 commands changes nothing for customers.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_newsletteraccounts for the difference (15 operations, 14 commands).Versioning: the empty
fix!:commitaf33848and thefix!:PR title mark this as breaking for release-please. Withbump-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 withCOMMIT_OR_PR_TITLE, so with two commits the squash title defaults to the PR title. When merging, keep the squash title asfix!: 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:pnpm check— 118 passed, 3 skippedpnpm buildpnpm package:tarballand install smoke (--version,--help)pnpm sync:openapi:checkgit diff --checkand a public-history environment-leak scannpm publish --dry-runcorrectly stops because unchanged version 0.2.5 already exists; release-please owns versioningaf33848is an empty commit (no file changes), so these results still apply.Reviewer re-check at
5aeea7b: the pinned schema matches the livehttps://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.mdor README references a removed operation;pnpm checkandpnpm sync:openapi:checkpass; GitHub CI is green.Risk / rollback
High: the 14 generated
asknews apicommand 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-knownskill, 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.