P-2393 Sync docs to the intentional public API and MCP surface - #134
Merged
Conversation
Sync with getformo/formono's machine-surface parity work: - api/openapi.json: sync with the backend spec — adds the 8 previously undocumented routes (alert test, contract recommendations, contract pipeline toggle, chart summaries/reorder/move/duplicate/saved-query). - Add the 8 matching API reference pages and register them in the Alerts / Charts / Contracts navigation groups. - mcp/overview.mdx: document the 10 new MCP tools — test_alert, execute_saved_chart, reorder_charts, list_contract_recommendations, and the profile write tools (update/upsert/delete/batch/import) with their required permissions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BWrVEx5C374qkrAQUCgx7y
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
yosriady
changed the title
Follow-up to getformo/formono#2182 review decisions:
- Re-sync api/openapi.json: the alert-test, contract-recommendations,
contract-pipeline, and chart-summaries routes are now internal-only
(dashboard utilities), so their paths and pages are removed.
- GET /v0/boards/{boardId}/charts is now lazy by default (summaries) with
?include=results to execute chart queries; list-charts page updated.
- mcp/overview.mdx: remove test_alert, list_contract_recommendations,
and toggle_contract_pipeline (pipeline inclusion is set via
update_contract).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BWrVEx5C374qkrAQUCgx7y
yosriady
changed the title
alerts test, contracts recommendations, and contracts pipeline are gone from the CLI (cli#43); charts list now returns summaries by default with --results as the opt-in. Pipeline inclusion is documented via update --include-in-pipeline. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
2 participants
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.
Syncs the docs site with getformo/formono#2182 (machine-surface parity + surface trim, P-2393).
api/openapi.json: synced with the backend spec (verified byte-identical bases before the first sync). Net effect: documents chartreorder/move/duplicate/ saved-chartquery, theChartSummaryschema, and the charts-listincludeparameter. The alert-test, contract-recommendations, contract-pipeline, and chart-summaries routes are now internal-only in the backend and are not documented.api/boards/query-chart,api/boards/duplicate-chart,api/boards/move-chart,api/boards/reorder-charts), registered in the Charts navigation group.api/boards/list-chartsnow describes the lazy default +include=results.mcp/overview.mdx: documents the 8 new MCP tools —execute_saved_chart,reorder_charts, and the profile write tools (update_profile_properties,upsert_profile_labels,delete_profile_label, batch variants,import_wallets) — and removestoggle_contract_pipeline(pipeline inclusion is set viaupdate_contract). The Profiles section now covers writes, not just enrichment reads.Note for a follow-up (not in this PR):
api/openapi.jsonis a manual copy of the backend spec with no CI drift check. Adocs-ci.ymlstep diffing it againsthttps://api.formo.so/openapi.jsonwould prevent future drift.Companion PR: getformo/cli#43.
🤖 Generated with Claude Code
https://claude.ai/code/session_01BWrVEx5C374qkrAQUCgx7y
Generated by Claude Code
<img alt="View with [code]smith" src="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v2.svg"><a href="https://backend.blacksmith.sh/track/enable-autofix?expires=1788594737&installation_model_id=21031&pr_number=134&repository=getformo%2Fdocs.formo.so&return_to=https%3A%2F%2Fgithub.com%2Fgetformo%2Fdocs.formo.so%2Fpull%2F134&signature=bad3ffdf759b31a57a80ccf73775880171c3a886a2777e2e8d0f3df153561c84"rel="nofollow noreferrer noopener" target="_blank"><img alt="Autofix with [code]smith" src="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark.svg">Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.<img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg">