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

API formatting #128

Open
BLuedtke opened this issue Nov 12, 2023 · 2 comments
Open

API formatting #128

BLuedtke opened this issue Nov 12, 2023 · 2 comments

Comments

@BLuedtke
Copy link
Collaborator

Currently, the API returns results in a pure text-based manner, with some similar formats across different handler, but without a specification for it. This makes parsing a chore.
A common formatting standard (e.g., JSON) should help make parsing easier. However, which standard to choose and how to name its fields has to be discussed still.

@BLuedtke
Copy link
Collaborator Author

BLuedtke commented May 7, 2024

First prototype for /monitor/* API implemented in linked branch (json-experiments). But clients have not been adjusted there. Also, need to check if any other APIs need changing.

@BLuedtke
Copy link
Collaborator Author

The API format rework has now evolved into a significant rewrite/reformatting of the major handler_X implementations. As I'm significantly modifying these handlers anyway, I'm fixing a few issues with them and also will improve upon some logging, locking etc. aspects. I propose then running this version in a 'dev'-like staging branch for a while, until the clients are also adapted and tested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant