optionally include descriptions in schema

changelog/v0.41.1/exclude-descriptions-in-schema.yaml

@@ -0,0 +1,6 @@
+changelog:
+  - type: NON_USER_FACING
+    issueLink: https://github.com/solo-io/gloo-mesh-enterprise/issues/18562
+    description: >
+      Add option to exclude descriptions in schema. 
+    skipCI: "false"

codegen/collector/executor.go

@@ -70,7 +70,7 @@ type OpenApiProtocExecutor struct {
 	OutputDir string
 
 	// Whether to include descriptions in validation schemas
-	IncludeDescriptionsInSchema bool
+	ExcludeDescriptionsInSchema 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
@@ -108,11 +108,12 @@ func (o *OpenApiProtocExecutor) Execute(protoFile string, toFile string, imports
 	_, fileName := filepath.Split(protoFile)
 	directoryName := fileName[0 : len(fileName)-len(filepath.Ext(fileName))]
 
-	baseArgument := "--openapi_out=yaml=true,single_file=false,include_description=true,multiline_description=true,proto_oneof=true,int_native=true"
+	baseArgument := "--openapi_out=yaml=true,single_file=false,multiline_description=true,proto_oneof=true,int_native=true"
 	baseArgument = fmt.Sprintf("%s,enum_as_int_or_string=%v", baseArgument, o.EnumAsIntOrString)
 	baseArgument = fmt.Sprintf("%s,additional_empty_schema=%v", baseArgument, strings.Join(o.MessagesWithEmptySchema, "+"))
 	baseArgument = fmt.Sprintf("%s,disable_kube_markers=%v", baseArgument, o.DisableKubeMarkers)
 	baseArgument = fmt.Sprintf("%s,ignored_kube_marker_substrings=%v", baseArgument, strings.Join(o.IgnoredKubeMarkerSubstrings, "+"))
+	baseArgument = fmt.Sprintf("%s,include_description=%v", baseArgument, !o.ExcludeDescriptionsInSchema)
 
 	// Create the directory
 	directoryPath := filepath.Join(o.OutputDir, directoryName)

codegen/proto/schemagen/generator.go

@@ -8,6 +8,9 @@ const (
 )
 
 type ValidationSchemaOptions struct {
+	// Whether to include descriptions in validation schemas
+	ExcludeDescriptionsInSchema 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

@@ -44,6 +44,7 @@ func (p *protocGenerator) GetJSONSchemas(protoFiles []string, imports []string,
 		EnumAsIntOrString:           p.validationSchemaOptions.EnumAsIntOrString,
 		MessagesWithEmptySchema:     p.validationSchemaOptions.MessagesWithEmptySchema,
 		DisableKubeMarkers:          p.validationSchemaOptions.DisableKubeMarkers,
+		ExcludeDescriptionsInSchema: p.validationSchemaOptions.ExcludeDescriptionsInSchema,
 		IgnoredKubeMarkerSubstrings: p.validationSchemaOptions.IgnoredKubeMarkerSubstrings,
 	}