Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow parenthesis in examples #1960

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Allow parenthesis in examples #1960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ff9139
Make tag regexes non-greedy
mloesch Jan 9, 2025
bbdc5f0
Use last parenthesis to find attr
mloesch Jan 9, 2025
b8dd84f
Extend test cases
mloesch Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions operation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,23 +426,23 @@ const (

var regexAttributes = map[string]*regexp.Regexp{
// for Enums(A, B)
enumsTag: regexp.MustCompile(`(?i)\s+enums\(.*\)`),
enumsTag: regexp.MustCompile(`(?Ui)\s+enums\(.*\)`),
// for maximum(0)
maximumTag: regexp.MustCompile(`(?i)\s+maxinum|maximum\(.*\)`),
maximumTag: regexp.MustCompile(`(?Ui)\s+maxinum|maximum\(.*\)`),
// for minimum(0)
minimumTag: regexp.MustCompile(`(?i)\s+mininum|minimum\(.*\)`),
minimumTag: regexp.MustCompile(`(?Ui)\s+mininum|minimum\(.*\)`),
// for default(0)
defaultTag: regexp.MustCompile(`(?i)\s+default\(.*\)`),
defaultTag: regexp.MustCompile(`(?Ui)\s+default\(.*\)`),
// for minlength(0)
minLengthTag: regexp.MustCompile(`(?i)\s+minlength\(.*\)`),
minLengthTag: regexp.MustCompile(`(?Ui)\s+minlength\(.*\)`),
// for maxlength(0)
maxLengthTag: regexp.MustCompile(`(?i)\s+maxlength\(.*\)`),
maxLengthTag: regexp.MustCompile(`(?Ui)\s+maxlength\(.*\)`),
// for format(email)
formatTag: regexp.MustCompile(`(?i)\s+format\(.*\)`),
formatTag: regexp.MustCompile(`(?Ui)\s+format\(.*\)`),
// for extensions(x-example=test)
extensionsTag: regexp.MustCompile(`(?i)\s+extensions\(.*\)`),
extensionsTag: regexp.MustCompile(`(?Ui)\s+extensions\(.*\)`),
// for collectionFormat(csv)
collectionFormatTag: regexp.MustCompile(`(?i)\s+collectionFormat\(.*\)`),
collectionFormatTag: regexp.MustCompile(`(?Ui)\s+collectionFormat\(.*\)`),
// example(0)
exampleTag: regexp.MustCompile(`(?i)\s+example\(.*\)`),
// schemaExample(0)
Expand Down Expand Up @@ -490,7 +490,7 @@ func (operation *Operation) parseParamAttribute(comment, objectType, schemaType,
func findAttr(re *regexp.Regexp, commentLine string) (string, error) {
attr := re.FindString(commentLine)

l, r := strings.Index(attr, "("), strings.Index(attr, ")")
l, r := strings.Index(attr, "("), strings.LastIndex(attr, ")")
if l == -1 || r == -1 {
return "", fmt.Errorf("can not find regex=%s, comment=%s", re.String(), commentLine)
}
Expand Down
8 changes: 4 additions & 4 deletions operation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1919,7 +1919,7 @@ func TestParseParamCommentByExampleInt(t *testing.T) {
func TestParseParamCommentByExampleString(t *testing.T) {
t.Parallel()

comment := `@Param some_id query string true "Some ID" Example(True feelings)`
comment := `@Param some_id query string true "Some ID" Example(True feelings (maybe))`
operation := NewOperation(nil)
err := operation.ParseComment(comment, nil)

Expand All @@ -1928,7 +1928,7 @@ func TestParseParamCommentByExampleString(t *testing.T) {
expected := `[
{
"type": "string",
"example": "True feelings",
"example": "True feelings (maybe)",
"description": "Some ID",
"name": "some_id",
"in": "query",
Expand Down Expand Up @@ -1958,7 +1958,7 @@ func TestParseParamCommentByExampleUnsupportedType(t *testing.T) {
func TestParseParamCommentBySchemaExampleString(t *testing.T) {
t.Parallel()

comment := `@Param some_id body string true "Some ID" SchemaExample(True feelings)`
comment := `@Param some_id body string true "Some ID" SchemaExample(True feelings (maybe))`
operation := NewOperation(nil)
err := operation.ParseComment(comment, nil)

Expand All @@ -1972,7 +1972,7 @@ func TestParseParamCommentBySchemaExampleString(t *testing.T) {
"required": true,
"schema": {
"type": "string",
"example": "True feelings"
"example": "True feelings (maybe)"
}
}
]`
Expand Down