Skip to content

feat: add support for required query parameters #452

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add support for required query parameters #452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 23 additions & 6 deletions cmd/protoc-gen-openapi/generator/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,12 +286,29 @@ func (g *OpenAPIv3Generator) buildQueryParamsV3(field *protogen.Field) []*v3.Par
return g._buildQueryParamsV3(field, depths)
}

// isFieldRequired checks if a field has the REQUIRED field behavior annotation
func (g *OpenAPIv3Generator) isFieldRequired(field protoreflect.FieldDescriptor) bool {
extension := proto.GetExtension(field.Options(), annotations.E_FieldBehavior)
if extension != nil {
switch v := extension.(type) {
case []annotations.FieldBehavior:
for _, vv := range v {
if vv == annotations.FieldBehavior_REQUIRED {
return true
}
}
}
}
return false
}

// depths are used to keep track of how many times a message's fields has been seen
func (g *OpenAPIv3Generator) _buildQueryParamsV3(field *protogen.Field, depths map[string]int) []*v3.ParameterOrReference {
parameters := []*v3.ParameterOrReference{}

queryFieldName := g.reflect.formatFieldName(field.Desc)
fieldDescription := g.filterCommentString(field.Comments.Leading)
isRequired := g.isFieldRequired(field.Desc)

if field.Desc.IsMap() {
// Map types are not allowed in query parameteres
Expand All @@ -310,7 +327,7 @@ func (g *OpenAPIv3Generator) _buildQueryParamsV3(field *protogen.Field, depths m
Name: queryFieldName,
In: "query",
Description: fieldDescription,
Required: false,
Required: isRequired,
Schema: fieldSchema,
},
},
Expand All @@ -329,7 +346,7 @@ func (g *OpenAPIv3Generator) _buildQueryParamsV3(field *protogen.Field, depths m
Name: queryFieldName,
In: "query",
Description: fieldDescription,
Required: false,
Required: isRequired,
Schema: fieldSchema,
},
},
Expand All @@ -345,7 +362,7 @@ func (g *OpenAPIv3Generator) _buildQueryParamsV3(field *protogen.Field, depths m
Name: queryFieldName,
In: "query",
Description: fieldDescription,
Required: false,
Required: isRequired,
Schema: fieldSchema,
},
},
Expand All @@ -360,7 +377,7 @@ func (g *OpenAPIv3Generator) _buildQueryParamsV3(field *protogen.Field, depths m
Name: queryFieldName,
In: "query",
Description: fieldDescription,
Required: false,
Required: isRequired,
Schema: fieldSchema,
},
},
Expand All @@ -383,7 +400,7 @@ func (g *OpenAPIv3Generator) _buildQueryParamsV3(field *protogen.Field, depths m
Name: queryFieldName,
In: "query",
Description: fieldDescription,
Required: false,
Required: isRequired,
Schema: fieldSchema,
},
},
Expand Down Expand Up @@ -423,7 +440,7 @@ func (g *OpenAPIv3Generator) _buildQueryParamsV3(field *protogen.Field, depths m
Name: queryFieldName,
In: "query",
Description: fieldDescription,
Required: false,
Required: isRequired,
Schema: fieldSchema,
},
},
Expand Down