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

[Feature request]: OpenAPI or gRPC spec or different machine readable API docs #419

Open
1 task done
endigma opened this issue Aug 11, 2024 · 1 comment
Open
1 task done
Labels
bug Something isn't working

Comments

@endigma
Copy link

endigma commented Aug 11, 2024

Verified issue does not already exist?

  • I have searched and found no existing issue

What happened?

I'm working on an API integration for ActualBudget replacing part of the actual-server with my own code, but I'm worried about keeping up to date with the client. Have you considered adding a versioned spec layer in-between the client and server? It would be helpful to be able to generate stubs on both sides for building on Actual.

What error did you receive?

No response

Where are you hosting Actual?

None

What browsers are you seeing the problem on?

No response

Operating System

None

@endigma endigma added the bug Something isn't working label Aug 11, 2024
@endigma endigma changed the title [Request]: OpenAPI or gRPC spec or different machine readable API docs [Feature request]: OpenAPI or gRPC spec or different machine readable API docs Aug 11, 2024
@tcrasset
Copy link
Contributor

I'm not a maintainer, but I've tried to see what could be done. This is an express app, and there is express-openapi that could help creating these docs, but I think a lot of the steps are manual e.g. for each route, one needs to create the doc, it doesn't seem (AFAIK) to be autogenerated.

It seems this has already been attempted (possibly on a previous version of the server), here: #62

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants