[PR #5291] [CLOSED] [WIP] Added Schedule functionality to the API + a few more funtions #12917

Closed
opened 2026-04-10 21:42:26 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/5291
Author: @karimkodera
Created: 7/5/2025
Status: Closed

Base: masterHead: schedule-api


📝 Commits (10+)

📊 Changes

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

View changed files

📝 packages/api/methods.test.ts (+91 -0)
📝 packages/api/methods.ts (+28 -0)
📝 packages/loot-core/src/server/api-models.ts (+61 -0)
📝 packages/loot-core/src/server/api.ts (+146 -1)
📝 packages/loot-core/src/types/api-handlers.ts (+25 -0)
upcoming-release-notes/5291.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. 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/5291 **Author:** [@karimkodera](https://github.com/karimkodera) **Created:** 7/5/2025 **Status:** ❌ Closed **Base:** `master` ← **Head:** `schedule-api` --- ### 📝 Commits (10+) - [`b516e7b`](https://github.com/actualbudget/actual/commit/b516e7be3a7095d938920a2e9cfacce8641c4105) Added Schedule API++ - [`ad725e4`](https://github.com/actualbudget/actual/commit/ad725e4e82a1b725b3bd39e627e5f658b0368b81) Updated Release notes - [`3e14eae`](https://github.com/actualbudget/actual/commit/3e14eae8c80a0e459ecc52d176b09702b1368f9a) Fixed lint errors - [`05f1bd2`](https://github.com/actualbudget/actual/commit/05f1bd231482fe09cee5bb81dc3146b0d81bcce1) Fixed lint errors - [`413fd17`](https://github.com/actualbudget/actual/commit/413fd1764426621b50ddb93837da7e6f75e1f1d2) Release notes is now one line - [`aab4ad1`](https://github.com/actualbudget/actual/commit/aab4ad1d65cd6600033f9ceb949ac8976ef6ecb4) Fixed unnecessary imports in api-handlers.ts - [`ed09fbf`](https://github.com/actualbudget/actual/commit/ed09fbf46e7ab7c2d4536c7b7ed23bf0922f909d) [autofix.ci] apply automated fixes - [`4064a3c`](https://github.com/actualbudget/actual/commit/4064a3c76d5148bc054c25767e0cfcc3e5776c50) Added Loading budget to the test function at the beginning. - [`2d0828f`](https://github.com/actualbudget/actual/commit/2d0828f1b47a89e59a94eeddf62fdc6b934fe1c6) Merge branch 'schedule-api' of https://github.com/karimkodera/actual into schedule-api - [`ecd4366`](https://github.com/actualbudget/actual/commit/ecd43668e078c1fbd08af2c5da7cd073f17d3748) Fixed test equal function ### 📊 Changes **6 files changed** (+357 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `packages/api/methods.test.ts` (+91 -0) 📝 `packages/api/methods.ts` (+28 -0) 📝 `packages/loot-core/src/server/api-models.ts` (+61 -0) 📝 `packages/loot-core/src/server/api.ts` (+146 -1) 📝 `packages/loot-core/src/types/api-handlers.ts` (+25 -0) ➕ `upcoming-release-notes/5291.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. 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-10 21:42:26 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#12917