Repository navigation
feat: Validate swagger definitions - #5694
Merged
Merged
Conversation
johnstcn
reviewed
Jan 13, 2023
johnstcn
left a comment
Member
There was a problem hiding this comment.
I haven't gone through the generated docs with a fine-toothed comb, but I just had a couple of questions/observations about the Swagger parser.
Member
|
Love how easily the go parser was to get comment groups. I would suggest we should comment what each assertion does. Some are obvious, but it would be helpful to have some english.
Do you intend to dig into the functions and seeing if the return type is called via |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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: #3522
This PR concludes the autogenerating docs initiative with a basic Swagger validator and custom rules, that will let us keep the better quality of docs. The validator uses
go/astto parse comments and Go structure fields. It covers OSS and Enterprisechihandlers.Checks:
@Summaryand@ID.@Successand/or@Failure.@...@Securitytag is present.@Acceptannotation.@Produceannotation.uuid.UUIDandtime.Timefields are formatted.To reviewer:
coderdtest/swaggerparser.go.