-
Notifications
You must be signed in to change notification settings - Fork 3
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
Comments
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. |
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. |
To add a bit of context to the things going on in the api-and-handler-overhaul branch: I thought that, if I'm already changing most of the handlers and some related code, it'd be okay to also check a few other problems and inconsistencies. A partial summary:
A change I need to think about some more: In the dyn_containers_interface, I removed quite a few "const" qualifiers where (I thought) they didn't add much value (mostly happened in commit df7588d1ba04ae71ea9c7a4f29f5bf67114773e7). Looking back, I'm not sure if this was really necessary/helpful, at least for the pointers. However, I rarely see that kind of const used for pointers in practice ( |
What remains now is...
So plenty of work left. |
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.
The text was updated successfully, but these errors were encountered: