-
-
Notifications
You must be signed in to change notification settings - Fork 12
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
New API server for v5 #60
base: main
Are you sure you want to change the base?
Conversation
For the documentation we could look into OpenAPI specs and hosting this via SwaggerUI? I already started working on something like this here and it can be hosted via SwaggerIO or Redoc (or both) for common and decent API documentation. There's also the system the existing one uses called Scalar, however looking at the Rust example I'm not too sure how we could integrate that, but perhaps this is something you could look into if you would like. Scalar looks the nicest, but OpenAPI/Swagger/Redoc are common and good too! |
Thanks for the info, I ended up using the same system the existing API uses, it seemed pretty nice to me. |
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Note: The image is not pushed anywhere yet, that'll hopefully be done by our local CD witch later. Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Signed-off-by: Lilly Rose Berner <[email protected]>
Description
In addition to the API surface receiving a small overhaul here's some highlights:
These things are not done yet, but I will get to them in the next few days hopefully:
Checklist