github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-05-05 22:52:20 -05:00
Code Issues 1.5k Packages Projects Releases 54 Wiki Activity

[PR #7096] [MERGED] [AI] Correct API docs to match actual implementation #37133

New Issue
Closed
opened 2026-04-20 23:55:38 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-20 23:55:38 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/7096
Author: @tifandotme
Created: 2/28/2026
Status: ✅ Merged
Merged: 3/11/2026
Merged by: @MikesGlitch

Base: master ← Head: fix/api-reference-discrepancies

📝 Commits (4)

  • 097870f [AI] docs(api): fix API reference discrepancies in reference.md
  • dae6a0c [autofix.ci] apply automated fixes
  • 1120e9c docs: update API reference for init and updateRule methods
  • 79c45c0 docs(7096.md): add release notes for API reference documentation fix

📊 Changes

2 files changed (+23 additions, -9 deletions)

View changed files

📝 packages/docs/docs/api/reference.md (+17 -9)
➕ upcoming-release-notes/7096.md (+6 -0)

📄 Description

Description

The API reference documentation was wrong about several method signatures. I found these while building Actual Budget agent skills and comparing the docs to the actual implementation in packages/api/methods.ts.

Fixes:

  • updateRule takes the full rule object, not (id, fields) like other update methods
  • getPayeeRules returns Rule[], not PayeeRule[]
  • createSchedule, init, runImport, batchBudgetUpdates had unnecessary nesting in the docs - their arguments are actually flat
  • getCommonPayees wasn't documented at all

Related issue(s)

None - found this while working with the API directly.

Testing

Compared every signature change against the actual implementation in packages/api/methods.ts. Docs only, no code changes.

Checklist

  • Release notes added
  • No regressions (docs change)
  • Self-reviewed

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/7096 **Author:** [@tifandotme](https://github.com/tifandotme) **Created:** 2/28/2026 **Status:** ✅ Merged **Merged:** 3/11/2026 **Merged by:** [@MikesGlitch](https://github.com/MikesGlitch) **Base:** `master` ← **Head:** `fix/api-reference-discrepancies` --- ### 📝 Commits (4) - [`097870f`](https://github.com/actualbudget/actual/commit/097870f507b831e02a66d0f2e700381553d01439) [AI] docs(api): fix API reference discrepancies in reference.md - [`dae6a0c`](https://github.com/actualbudget/actual/commit/dae6a0cd1d3a3f4025cdf00bc9d8fa393c1d1c9a) [autofix.ci] apply automated fixes - [`1120e9c`](https://github.com/actualbudget/actual/commit/1120e9c6d64ea48f1d550e480c6d6d6d39fd27d9) docs: update API reference for init and updateRule methods - [`79c45c0`](https://github.com/actualbudget/actual/commit/79c45c07cb5e8d69d4daea40ec215d61610208bf) docs(7096.md): add release notes for API reference documentation fix ### 📊 Changes **2 files changed** (+23 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `packages/docs/docs/api/reference.md` (+17 -9) ➕ `upcoming-release-notes/7096.md` (+6 -0) </details> ### 📄 Description <!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. --> ## Description The API reference documentation was wrong about several method signatures. I found these while building [Actual Budget agent skills](https://github.com/tifandotme/dotfiles/tree/master/dot_agents/skills) and comparing the docs to the actual implementation in `packages/api/methods.ts`. Fixes: - `updateRule` takes the full rule object, not `(id, fields)` like other update methods - `getPayeeRules` returns `Rule[]`, not `PayeeRule[]` - `createSchedule`, `init`, `runImport`, `batchBudgetUpdates` had unnecessary nesting in the docs - their arguments are actually flat - `getCommonPayees` wasn't documented at all ## Related issue(s) None - found this while working with the API directly. ## Testing Compared every signature change against the actual implementation in `packages/api/methods.ts`. Docs only, no code changes. ## Checklist - [x] Release notes added - [x] No regressions (docs change) - [x] Self-reviewed <!--- actual-bot-sections ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-20 23:55:38 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#37133
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?