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

[PR #5584] [MERGED] Introduction of APIs to handle Schedule + a bit more. #36206

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

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/5584
Author: @karimkodera
Created: 8/20/2025
Status: ✅ Merged
Merged: 9/8/2025
Merged by: @MikesGlitch

Base: master ← Head: schedule-api

📝 Commits (10+)

  • 305a26f Introduction of APIs to handle Schedule + a bit more. Refer to updated API documentation PR2811 on documentation.
  • e3a00d2 Fixed lint Error
  • 9aaca54 Removed unused declarations
  • 56d6ddd Fixed Bug in Test module
  • 66741dc Avoiding type Coercion fixes and direct assignment on conditions array.
  • 201498a Lint Error Fixes
  • 5d5b7c7 more issues fixed
  • 0f3bb1a lint errors
  • 5b18b10 Remove with Mutation in Get function. Fixed quotes. updated getIDyName for error handling
  • 2f072d7 More lint errors

📊 Changes

6 files changed (+437 additions, -1 deletions)

View changed files

📝 packages/api/methods.test.ts (+119 -0)
📝 packages/api/methods.ts (+28 -0)
📝 packages/loot-core/src/server/api-models.ts (+61 -0)
📝 packages/loot-core/src/server/api.ts (+200 -1)
📝 packages/loot-core/src/types/api-handlers.ts (+23 -0)
➕ upcoming-release-notes/5584.md (+6 -0)

📄 Description

Introduction of APIs to handle Schedule + a bit more

Create necessary CRUD functions for schedule.
Get server version API.
getIDByName Function to simply creating of schedules and other API as well.
Alec have started the initial implementation based on my original request. The PR never made it because it needed documentation. As I worked to write docs and tests, I found the APIs are exposing internal APIs to the user which was not easy to document. I have opted to follow the way the API code was structured by creating a model to translate the internal structure and build the API based on the CRUD model described on the web for other apis. Full documentation of the API on PR # 729 https://github.com/actualbudget/docs/pull/729 on the documentation.

🔄 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/5584 **Author:** [@karimkodera](https://github.com/karimkodera) **Created:** 8/20/2025 **Status:** ✅ Merged **Merged:** 9/8/2025 **Merged by:** [@MikesGlitch](https://github.com/MikesGlitch) **Base:** `master` ← **Head:** `schedule-api` --- ### 📝 Commits (10+) - [`305a26f`](https://github.com/actualbudget/actual/commit/305a26fe6a3ab2a18b9161d3d4069ea71bb985dd) Introduction of APIs to handle Schedule + a bit more. Refer to updated API documentation PR2811 on documentation. - [`e3a00d2`](https://github.com/actualbudget/actual/commit/e3a00d2e647baacb1033a1cad82907f5347a1435) Fixed lint Error - [`9aaca54`](https://github.com/actualbudget/actual/commit/9aaca54da7ff6234ac17fb89eac422f5db4c74ae) Removed unused declarations - [`56d6ddd`](https://github.com/actualbudget/actual/commit/56d6ddd03c498fba5330f728e00e4d68a1ceb27d) Fixed Bug in Test module - [`66741dc`](https://github.com/actualbudget/actual/commit/66741dc20f6bc232b0581e81dbd1dbaf42c089df) Avoiding type Coercion fixes and direct assignment on conditions array. - [`201498a`](https://github.com/actualbudget/actual/commit/201498aa6a16b91a27888a90f4c785c8c6b5fbb6) Lint Error Fixes - [`5d5b7c7`](https://github.com/actualbudget/actual/commit/5d5b7c7656dedd4c3a112e899d94959dd43f4b7d) more issues fixed - [`0f3bb1a`](https://github.com/actualbudget/actual/commit/0f3bb1a6687c174e3fc856adb60eaf5c924a32da) lint errors - [`5b18b10`](https://github.com/actualbudget/actual/commit/5b18b104e9a7f4d0439e69e0d03a3f417996af38) Remove with Mutation in Get function. Fixed quotes. updated getIDyName for error handling - [`2f072d7`](https://github.com/actualbudget/actual/commit/2f072d7ed07909c8f3216249be84a84bc36a0755) More lint errors ### 📊 Changes **6 files changed** (+437 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `packages/api/methods.test.ts` (+119 -0) 📝 `packages/api/methods.ts` (+28 -0) 📝 `packages/loot-core/src/server/api-models.ts` (+61 -0) 📝 `packages/loot-core/src/server/api.ts` (+200 -1) 📝 `packages/loot-core/src/types/api-handlers.ts` (+23 -0) ➕ `upcoming-release-notes/5584.md` (+6 -0) </details> ### 📄 Description Introduction of APIs to handle Schedule + a bit more Create necessary CRUD functions for schedule. Get server version API. getIDByName Function to simply creating of schedules and other API as well. Alec have started the initial implementation based on my original request. The PR never made it because it needed documentation. As I worked to write docs and tests, I found the APIs are exposing internal APIs to the user which was not easy to document. I have opted to follow the way the API code was structured by creating a model to translate the internal structure and build the API based on the CRUD model described on the web for other apis. Full documentation of the API on PR # 729 https://github.com/actualbudget/docs/pull/729 on the documentation. --- <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:05:07 -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#36206
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?