feat(net/goai): add min, max, length, min-length, max-length and between support for OpenAPIv3 #3914
Conversation
This file contains 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
gqcn
requested changes
Nov 14, 2024
net/goai/goai_shema.go
Outdated
| // Extract validation rules to schema. like min, max, length | ||
| validationRules := ref.Value.ValidationRules | ||
| // remove custom error message | ||
| if idx := strings.Index(ref.Value.ValidationRules, "#"); idx != -1 { |
There was a problem hiding this comment.
You can refer current parsing logic in package goai, which uses gvalid.ParseTagValue to parse the validation pattern:
Line 230 in e8a2629
There was a problem hiding this comment.
up to this point, gvalid.ParseTagValue(validationTagValue) has already been processed. The rules have already removed the custom error messages, and strings.index is no longer needed.
net/goai/goai_shema.go
Outdated
| } | ||
| lstRules := gstr.Split(validationRules, "|") | ||
| for _, rule := range lstRules { | ||
| if strings.HasPrefix(rule, "max") { |
There was a problem hiding this comment.
Do not use hard-coded string, use constant instead. Please refer current usage example:
Line 66 in 7d4c59a
There was a problem hiding this comment.
Indeed, hard-coded is not good practice.
|
@ninjashixuan This PR is awsome! I'm watching this. |
gqcn
changed the title
…o openapi-doc-validate
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.
Improve OpenAPI Documentation Generation
This update primarily enhances the OpenAPI documentation generation by setting the min, max, and max-length constraints for the schema based on request validation.