add context for not adding field_behavior if schema is a reference

grpc-ecosystem · Feb 5, 2021 · 5f29c67 · 5f29c67
1 parent 26825b0
commit 5f29c67
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/protoc-gen-openapiv2/internal/genopenapi/template.go b/protoc-gen-openapiv2/internal/genopenapi/template.go
@@ -2168,6 +2168,8 @@ func updateswaggerObjectFromJSONSchema(s *openapiSchemaObject, j *openapi_option
 }
 
 func updateSwaggerObjectFromFieldBehavior(s *openapiSchemaObject, j []annotations.FieldBehavior, field *descriptor.Field) {
+	// Per the JSON Referene syntax: Any members other than "$ref" in a JSON Reference object SHALL be ignored.
+	// https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3
 	if s.Ref != "" {
 		return
 	}