cbsd-rs: openAPI integration#63
Merged
Merged
Conversation
Collaborator
|
I will look into it @s0nea |
UweSchwaeke
reviewed
May 7, 2026
Collaborator
UweSchwaeke
left a comment
There was a problem hiding this comment.
looked into it, only minor tweaks.
UweSchwaeke
previously approved these changes
May 8, 2026
Add design document, implementation plan, and design review for OpenAPI integration (seq 018). Covers utoipa + Scalar UI serving the spec at /api/docs with compile-time generation. Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Tatjana Dehler <[email protected]>
537ff81 to
a102801
Compare
Derive ToSchema on all REST-facing proto types for OpenAPI spec generation (design 018). WebSocket-only types and WorkerToken are excluded — they are internal protocol types, not part of the documented REST API surface. Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Tatjana Dehler <[email protected]>
Derive ToSchema on all server request/response types for OpenAPI spec generation (design 018). Adds explicit schema attributes for serde_json::Value fields so the spec documents them as structured objects rather than opaque strings. Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Tatjana Dehler <[email protected]>
Annotate all REST handlers with #[utoipa::path] and convert route modules to OpenApiRouter for automatic spec collection. This enables compile-time OpenAPI spec generation (design 018). Rate-limited auth routes stay on plain Router. Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Tatjana Dehler <[email protected]>
Add openapi.rs module with security schemes (bearer PASETO + session cookie), spec assembly, and Scalar UI. Serves browsable API docs at /api/docs and JSON spec at /api/docs/openapi.json for future TypeScript type stub generation (design 018). Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: Tatjana Dehler <[email protected]>
a102801 to
a167cbe
Compare
Contributor
Author
|
Hey @UweSchwaeke I addressed all your comments and updated the PR. Could you please take one final look? Thank you! 🙂 |
UweSchwaeke
approved these changes
May 15, 2026
Collaborator
done, sorry for beeing late |
Contributor
Author
No worries. Thank you for your approval 🙂 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The PR integrates the openAPI definition for cbsd-rs.
The browsable API can be found at /api/docs. The openapi.json file at /api/docs/openapi.json.
Co-authored-by: Claude Opus 4.6 (1M context) [email protected]
Signed-off-by: Tatjana Dehler [email protected]