Support disabling default response rendering

internal/descriptor/registry.go

@@ -132,6 +132,10 @@ type Registry struct {
 	// disableServiceTags disables the generation of service tags.
 	// This is useful if you do not want to expose the names of your backend grpc services.
 	disableServiceTags bool
+
+	// disableDefaultResponses disables the generation of default responses.
+	// Useful if you have to support custom response codes that are not 200.
+	disableDefaultResponses bool
 }
 
 type repeatedFieldSeparator struct {
@@ -758,3 +762,13 @@ func (r *Registry) SetDisableServiceTags(use bool) {
 func (r *Registry) GetDisableServiceTags() bool {
 	return r.disableServiceTags
 }
+
+// SetDisableDefaultResponses setsdisableDefaultResponses
+func (r *Registry) SetDisableDefaultResponses(use bool) {
+	r.disableDefaultResponses = use
+}
+
+// GetDisableDefaultResponses returns disableDefaultResponses
+func (r *Registry) GetDisableDefaultResponses() bool {
+	return r.disableDefaultResponses
+}

protoc-gen-openapiv2/internal/genopenapi/template.go

@@ -1369,13 +1369,15 @@ func renderServices(services []*descriptor.Service, paths openapiPathsObject, re
 
 				operationObject := &openapiOperationObject{
 					Parameters: parameters,
-					Responses: openapiResponsesObject{
-						"200": openapiResponseObject{
-							Description: desc,
-							Schema:      responseSchema,
-							Headers:     openapiHeadersObject{},
-						},
-					},
+					Responses:  openapiResponsesObject{},
+				}
+
+				if !reg.GetDisableDefaultResponses() {
+					operationObject.Responses["200"] = openapiResponseObject{
+						Description: desc,
+						Schema:      responseSchema,
+						Headers:     openapiHeadersObject{},
+					}
 				}
 
 				if !reg.GetDisableServiceTags() {

protoc-gen-openapiv2/internal/genopenapi/template_test.go

@@ -3316,6 +3316,17 @@ func TestApplyTemplateProtobufAny(t *testing.T) {
 			},
 			wantNumDefinitions: 3,
 		},
+		{
+			// we have a protobufAny in a message but with automatic rendering of responses disabled
+			name: "protobufAny_referenced_in_message_with_default_responses_disabled",
+			args: args{
+				msgContainsAny: true,
+				regConfig: func(reg *descriptor.Registry) {
+					reg.SetDisableDefaultResponses(true)
+				},
+			},
+			wantNumDefinitions: 4,
+		},
 	}
 
 	for _, tt := range tests {

protoc-gen-openapiv2/main.go

@@ -41,6 +41,7 @@ var (
 	outputFormat                   = flag.String("output_format", string(genopenapi.FormatJSON), fmt.Sprintf("output content format. Allowed values are: `%s`, `%s`", genopenapi.FormatJSON, genopenapi.FormatYAML))
 	visibilityRestrictionSelectors = utilities.StringArrayFlag(flag.CommandLine, "visibility_restriction_selectors", "list of `google.api.VisibilityRule` visibility labels to include in the generated output when a visibility annotation is defined. Repeat this option to supply multiple values. Elements without visibility annotations are unaffected by this setting.")
 	disableServiceTags             = flag.Bool("disable_service_tags", false, "if set, disables generation of service tags. This is useful if you do not want to expose the names of your backend grpc services.")
+	disableDefaultResponses        = flag.Bool("disable_default_responses", false, "if set, disables generation of default responses. Useful if you have to support custom response codes that are not 200.")
 )
 
 // Variables set by goreleaser at build time
@@ -126,6 +127,7 @@ func main() {
 	reg.SetOmitEnumDefaultValue(*omitEnumDefaultValue)
 	reg.SetVisibilityRestrictionSelectors(*visibilityRestrictionSelectors)
 	reg.SetDisableServiceTags(*disableServiceTags)
+	reg.SetDisableDefaultResponses(*disableDefaultResponses)
 	if err := reg.SetRepeatedPathParamSeparator(*repeatedPathParamSeparator); err != nil {
 		emitError(err)
 		return