feat(gen-openapiv2): support trailing comments (#2965)

* feat(gen-openapiv2): support trailing comments

* feat(gen-openapiv2): add examplepb for trailing comments

* fix typo

Co-authored-by: Johan Brandhorst-Satzkorn <[email protected]>

* fix indent

* fix: regenerate the example files

Co-authored-by: Johan Brandhorst-Satzkorn <[email protected]>

Author: ionling

examples/internal/clients/abe/api/swagger.yaml

@@ -65,4 +65,11 @@ type ABitOfEverything struct {
 	RequiredStringField2 string `json:"requiredStringField2"`
 	RequiredFieldBehaviorJsonNameCustom string `json:"required_field_behavior_json_name_custom"`
 	RequiredFieldSchemaJsonNameCustom string `json:"required_field_schema_json_name_custom"`
+	TrailingOnly string `json:"trailingOnly,omitempty"`
+	// Trailing only dot.
+	TrailingOnlyDot string `json:"trailingOnlyDot,omitempty"`
+	// Trailing both.
+	TrailingBoth string `json:"trailingBoth,omitempty"`
+	// This is an example of a multi-line comment.  Trailing multiline.
+	TrailingMultiline string `json:"trailingMultiline,omitempty"`
 }

examples/internal/clients/abe/api_a_bit_of_everything_service.go

@@ -66,4 +66,11 @@ type ABitOfEverything1 struct {
 	RequiredStringField2 string `json:"requiredStringField2"`
 	RequiredFieldBehaviorJsonNameCustom string `json:"required_field_behavior_json_name_custom"`
 	RequiredFieldSchemaJsonNameCustom string `json:"required_field_schema_json_name_custom"`
+	TrailingOnly string `json:"trailingOnly,omitempty"`
+	// Trailing only dot.
+	TrailingOnlyDot string `json:"trailingOnlyDot,omitempty"`
+	// Trailing both.
+	TrailingBoth string `json:"trailingBoth,omitempty"`
+	// This is an example of a multi-line comment.  Trailing multiline.
+	TrailingMultiline string `json:"trailingMultiline,omitempty"`
 }

examples/internal/clients/abe/model_a_bit_of_everything.go

@@ -65,4 +65,11 @@ type ABitOfEverything2 struct {
 	RequiredStringField2 string `json:"requiredStringField2"`
 	RequiredFieldBehaviorJsonNameCustom string `json:"required_field_behavior_json_name_custom"`
 	RequiredFieldSchemaJsonNameCustom string `json:"required_field_schema_json_name_custom"`
+	TrailingOnly string `json:"trailingOnly,omitempty"`
+	// Trailing only dot.
+	TrailingOnlyDot string `json:"trailingOnlyDot,omitempty"`
+	// Trailing both.
+	TrailingBoth string `json:"trailingBoth,omitempty"`
+	// This is an example of a multi-line comment.  Trailing multiline.
+	TrailingMultiline string `json:"trailingMultiline,omitempty"`
 }

examples/internal/clients/abe/model_a_bit_of_everything_1.go

@@ -65,4 +65,11 @@ type ABitOfEverything3 struct {
 	RequiredStringField2 string `json:"requiredStringField2"`
 	RequiredFieldBehaviorJsonNameCustom string `json:"required_field_behavior_json_name_custom"`
 	RequiredFieldSchemaJsonNameCustom string `json:"required_field_schema_json_name_custom"`
+	TrailingOnly string `json:"trailingOnly,omitempty"`
+	// Trailing only dot.
+	TrailingOnlyDot string `json:"trailingOnlyDot,omitempty"`
+	// Trailing both.
+	TrailingBoth string `json:"trailingBoth,omitempty"`
+	// This is an example of a multi-line comment.  Trailing multiline.
+	TrailingMultiline string `json:"trailingMultiline,omitempty"`
 }

examples/internal/clients/abe/model_a_bit_of_everything_2.go

@@ -65,4 +65,11 @@ type ABitOfEverything4 struct {
 	RequiredStringField2 string `json:"requiredStringField2,omitempty"`
 	RequiredFieldBehaviorJsonNameCustom string `json:"required_field_behavior_json_name_custom,omitempty"`
 	RequiredFieldSchemaJsonNameCustom string `json:"required_field_schema_json_name_custom,omitempty"`
+	TrailingOnly string `json:"trailingOnly,omitempty"`
+	// Trailing only dot.
+	TrailingOnlyDot string `json:"trailingOnlyDot,omitempty"`
+	// Trailing both.
+	TrailingBoth string `json:"trailingBoth,omitempty"`
+	// This is an example of a multi-line comment.  Trailing multiline.
+	TrailingMultiline string `json:"trailingMultiline,omitempty"`
 }

examples/internal/clients/abe/model_a_bit_of_everything_3.go

@@ -66,4 +66,11 @@ type ExamplepbABitOfEverything struct {
 	RequiredStringField2 string `json:"requiredStringField2"`
 	RequiredFieldBehaviorJsonNameCustom string `json:"required_field_behavior_json_name_custom"`
 	RequiredFieldSchemaJsonNameCustom string `json:"required_field_schema_json_name_custom"`
+	TrailingOnly string `json:"trailingOnly,omitempty"`
+	// Trailing only dot.
+	TrailingOnlyDot string `json:"trailingOnlyDot,omitempty"`
+	// Trailing both.
+	TrailingBoth string `json:"trailingBoth,omitempty"`
+	// This is an example of a multi-line comment.  Trailing multiline.
+	TrailingMultiline string `json:"trailingMultiline,omitempty"`
 }

examples/internal/clients/abe/model_a_bit_of_everything_4.go

@@ -406,6 +406,15 @@ message ABitOfEverything {
     (google.api.field_behavior) = REQUIRED
   ];
   string required_field_schema_json_name = 46 [json_name = "required_field_schema_json_name_custom"];
+
+  string trailing_only = 47; // Trailing only
+  string trailing_only_dot = 48; // Trailing only dot.
+  // Leading both
+  string trailing_both = 49; // Trailing both.
+  // Leading multiline
+  //
+  // This is an example of a multi-line comment.
+  string trailing_multiline = 50; // Trailing multiline.
 }
 
 // ABitOfEverythingRepeated is used to validate repeated path parameter functionality