Populate OpenAPI summary field with first line of endpoint doc comments#252
Merged
Populate OpenAPI summary field with first line of endpoint doc comments#252
Conversation
davepacheco
reviewed
Jan 21, 2022
|
|
||
| [dependencies.syn] | ||
| version = "1.0.85" | ||
| version = "1.0" |
Collaborator
There was a problem hiding this comment.
This is basically unrelated: I'm all for this but FYI I think it's dependabot that's replacing these with more specific versions when it updates deps. It doesn't always do this and I'm not sure exactly when it does. If the Renovate experiment goes well I hope it will give us more control over this.
davepacheco
reviewed
Jan 21, 2022
| ); | ||
| } | ||
|
|
||
| #[test] |
Collaborator
Author
There was a problem hiding this comment.
Note the use of my dope schema crate! ;-)
davepacheco
approved these changes
Jan 21, 2022
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.
Fixes #244
This change causes Dropshot to infer that the first line of the doc commend on an endpoint is the summary; subsequent lines (if there are any) are the description.
Note that there's going to be a bunch of follow-on work required in omicron to properly document endpoints.