Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: API docs incorrect #2235

Closed
1 task done
paulocr opened this issue Jan 15, 2024 · 3 comments
Closed
1 task done

[Bug]: API docs incorrect #2235

paulocr opened this issue Jan 15, 2024 · 3 comments
Labels
API Issues with the @actual-app/api package bug Something isn't working

Comments

@paulocr
Copy link

paulocr commented Jan 15, 2024

Verified issue does not already exist?

  • I have searched and found no existing issue

What happened?

Hello,

I am a new user and have started playing out with the API in order to migrate from a custom system I developed for my own use. I have encountered a couple methods here and there that are listed in the documentation in the API reference https://actualbudget.org/docs/api/reference but that actually do not exist in the package.

If PRs are welcome I am happy to do a review and submit one.

Thanks!

What error did you receive?

No response

Where are you hosting Actual?

Docker

What browsers are you seeing the problem on?

No response

Operating System

None

@paulocr paulocr added the bug Something isn't working label Jan 15, 2024
@paulocr
Copy link
Author

paulocr commented Jan 15, 2024

Ugh, I guess I just realized that the API reference says in the first paragraph that it's a work in progress. Apologies, just jumped directly into the methods!

@youngcw
Copy link
Member

youngcw commented Jan 15, 2024

Feel free to put in PRs to help improve things

@joel-jeremy joel-jeremy added the API Issues with the @actual-app/api package label Mar 4, 2024
@MatissJanis
Copy link
Member

actualbudget/docs#340

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Issues with the @actual-app/api package bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants