optionally include descriptions in schema

Author: puertomontt

codegen/collector/executor.go

@@ -108,14 +108,20 @@ func (o *OpenApiProtocExecutor) Execute(protoFile string, toFile string, imports
 	directoryPath := filepath.Join(o.OutputDir, directoryName)
 	_ = os.Mkdir(directoryPath, os.ModePerm)
 
-	cmd.Args = append(cmd.Args,
-		fmt.Sprintf("--openapi_out=yaml=true,single_file=false,include_description=true,multiline_description=true,enum_as_int_or_string=%v,proto_oneof=true,int_native=true,additional_empty_schema=%v,disable_kube_markers=%v:%s",
-			o.EnumAsIntOrString,
-			strings.Join(o.MessagesWithEmptySchema, "+"),
-			o.DisableKubeMarkers,
-			directoryPath),
+	args := fmt.Sprintf("--openapi_out=yaml=true,single_file=false,multiline_description=true,enum_as_int_or_string=%v,proto_oneof=true,int_native=true,additional_empty_schema=%v,disable_kube_markers=%v",
+		o.EnumAsIntOrString,
+		strings.Join(o.MessagesWithEmptySchema, "+"),
+		o.DisableKubeMarkers,
 	)
 
+	if !o.IncludeDescriptionsInSchema {
+		args += ",include_description=false"
+	}
+
+	args = fmt.Sprintf("%s:%s", args, directoryPath)
+
+	cmd.Args = append(cmd.Args, args)
+
 	cmd.Args = append(cmd.Args,
 		"-o",
 		toFile,

codegen/proto/schemagen/generator.go

@@ -8,6 +8,9 @@ const (
 )
 
 type ValidationSchemaOptions struct {
+	// Whether to include descriptions in validation schemas
+	IncludeDescriptionsInSchema bool
+
 	// Whether to assign Enum fields the `x-kubernetes-int-or-string` property
 	// which allows the value to either be an integer or a string
 	// If this is false, only string values are allowed

codegen/proto/schemagen/protoc.go

@@ -40,10 +40,11 @@ func (p *protocGenerator) GetJSONSchemas(protoFiles []string, imports []string,
 
 	// The Executor used to compile protos
 	protocExecutor := &collector.OpenApiProtocExecutor{
-		OutputDir:               tmpOutputDir,
-		EnumAsIntOrString:       p.validationSchemaOptions.EnumAsIntOrString,
-		MessagesWithEmptySchema: p.validationSchemaOptions.MessagesWithEmptySchema,
-		DisableKubeMarkers:      p.validationSchemaOptions.DisableKubeMarkers,
+		OutputDir:                   tmpOutputDir,
+		EnumAsIntOrString:           p.validationSchemaOptions.EnumAsIntOrString,
+		MessagesWithEmptySchema:     p.validationSchemaOptions.MessagesWithEmptySchema,
+		DisableKubeMarkers:          p.validationSchemaOptions.DisableKubeMarkers,
+		IncludeDescriptionsInSchema: p.validationSchemaOptions.IncludeDescriptionsInSchema,
 	}
 
 	// 1. Generate the openApiSchemas for the project, writing them to a temp directory (schemaOutputDir)