#78 feat: extract doc comments for OpenAPI descriptions#86
Closed
RAprogramm wants to merge 1 commit into77-http-handlersfrom
Closed
#78 feat: extract doc comments for OpenAPI descriptions#86RAprogramm wants to merge 1 commit into77-http-handlersfrom
RAprogramm wants to merge 1 commit into77-http-handlersfrom
Conversation
4 tasks
Codecov Report❌ Patch coverage is 📢 Thoughts on this report? Let us know! |
22995b7 to
776de7d
Compare
- Add utils/docs.rs module for doc comment extraction - Extract /// comments from entity struct for tag descriptions - Extract /// comments from fields for schema descriptions - Use entity doc as fallback for tag_description in OpenAPI - 6 unit tests for doc extraction functions
8ffe30b to
480a572
Compare
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
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.
Summary
utils/docs.rsmodule for extracting doc comments from Rust attributes///comments from entity structs and fieldsUsage
In OpenAPI:
Extracted Functions
extract_doc_comments(attrs)- Get full doc comment as stringextract_doc_summary(attrs)- Get first line only (for summaries)Test plan
Closes #78
Depends on #85