add comment

grpc-ecosystem · Sep 3, 2023 · 9cb391d · 9cb391d
1 parent d620c55
commit 9cb391d
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/protoc-gen-openapiv2/internal/genopenapi/generator.go b/protoc-gen-openapiv2/internal/genopenapi/generator.go
@@ -163,6 +163,15 @@ func (po openapiPathsObject) MarshalYAML() (interface{}, error) {
 	return pathObjectNode, nil
 }
 
+// We can simplify this implementation once the go-yaml bug is resolved. See: https://github.com/go-yaml/yaml/issues/643.
+//
+//	func (pio *openapiPathItemObject) toYAMLNode() (*yaml.Node, error) {
+//		var node yaml.Node
+//		if err := node.Encode(pio); err != nil {
+//			return nil, err
+//		}
+//		return &node, nil
+//	}
 func (pio *openapiPathItemObject) toYAMLNode() (*yaml.Node, error) {
 	var doc yaml.Node
 	var buf bytes.Buffer