feat(gen-openapiv2): keep fields next to "$ref" fields (#2986)

grpc-ecosystem · Nov 1, 2022 · a0fe8d7 · a0fe8d7
1 parent 04a7ec4
commit a0fe8d7
Show file tree

Hide file tree

Showing 13 changed files with 96 additions and 32 deletions.
diff --git a/examples/internal/clients/abe/api/swagger.yaml b/examples/internal/clients/abe/api/swagger.yaml
@@ -4807,6 +4807,7 @@ definitions:
         type: "integer"
         format: "int64"
       ok:
+        description: "DeepEnum description."
         $ref: "#/definitions/NestedDeepEnum"
     description: "Nested is nested type."
     example:
@@ -4939,6 +4940,8 @@ definitions:
         items:
           $ref: "#/definitions/examplepbNumericEnum"
       enumValueAnnotation:
+        description: "Numeric enum description."
+        title: "Numeric enum title"
         $ref: "#/definitions/examplepbNumericEnum"
       repeatedStringAnnotation:
         type: "array"
@@ -4953,6 +4956,8 @@ definitions:
         items:
           $ref: "#/definitions/ABitOfEverythingNested"
       nestedAnnotation:
+        description: "Nested object description."
+        title: "Nested object title"
         $ref: "#/definitions/ABitOfEverythingNested"
       int64OverrideType:
         type: "integer"
@@ -5444,6 +5449,8 @@ definitions:
         items:
           $ref: "#/definitions/examplepbNumericEnum"
       enumValueAnnotation:
+        description: "Numeric enum description."
+        title: "Numeric enum title"
         $ref: "#/definitions/examplepbNumericEnum"
       repeatedStringAnnotation:
         type: "array"
@@ -5458,6 +5465,8 @@ definitions:
         items:
           $ref: "#/definitions/ABitOfEverythingNested"
       nestedAnnotation:
+        description: "Nested object description."
+        title: "Nested object title"
         $ref: "#/definitions/ABitOfEverythingNested"
       int64OverrideType:
         type: "integer"
@@ -5523,6 +5532,7 @@ definitions:
         type: "integer"
         format: "int64"
       ok:
+        description: "DeepEnum description."
         $ref: "#/definitions/NestedDeepEnum"
     description: "Nested is nested type."
     example: "{\"ok\":\"TRUE\"}"
@@ -5640,6 +5650,8 @@ definitions:
         items:
           $ref: "#/definitions/examplepbNumericEnum"
       enumValueAnnotation:
+        description: "Numeric enum description."
+        title: "Numeric enum title"
         $ref: "#/definitions/examplepbNumericEnum"
       repeatedStringAnnotation:
         type: "array"
@@ -5654,6 +5666,8 @@ definitions:
         items:
           $ref: "#/definitions/ABitOfEverythingNested"
       nestedAnnotation:
+        description: "Nested object description."
+        title: "Nested object title"
         $ref: "#/definitions/ABitOfEverythingNested"
       int64OverrideType:
         type: "integer"
@@ -5836,6 +5850,8 @@ definitions:
         items:
           $ref: "#/definitions/examplepbNumericEnum"
       enumValueAnnotation:
+        description: "Numeric enum description."
+        title: "Numeric enum title"
         $ref: "#/definitions/examplepbNumericEnum"
       repeatedStringAnnotation:
         type: "array"
@@ -5850,6 +5866,8 @@ definitions:
         items:
           $ref: "#/definitions/ABitOfEverythingNested"
       nestedAnnotation:
+        description: "Nested object description."
+        title: "Nested object title"
         $ref: "#/definitions/ABitOfEverythingNested"
       int64OverrideType:
         type: "integer"
@@ -6017,6 +6035,8 @@ definitions:
         items:
           $ref: "#/definitions/examplepbNumericEnum"
       enumValueAnnotation:
+        description: "Numeric enum description."
+        title: "Numeric enum title"
         $ref: "#/definitions/examplepbNumericEnum"
       repeatedStringAnnotation:
         type: "array"
@@ -6031,6 +6051,8 @@ definitions:
         items:
           $ref: "#/definitions/ABitOfEverythingNested"
       nestedAnnotation:
+        description: "Nested object description."
+        title: "Nested object title"
         $ref: "#/definitions/ABitOfEverythingNested"
       int64OverrideType:
         type: "integer"
@@ -6188,6 +6210,8 @@ definitions:
         items:
           $ref: "#/definitions/examplepbNumericEnum"
       enumValueAnnotation:
+        description: "Numeric enum description."
+        title: "Numeric enum title"
         $ref: "#/definitions/examplepbNumericEnum"
       repeatedStringAnnotation:
         type: "array"
@@ -6202,6 +6226,8 @@ definitions:
         items:
           $ref: "#/definitions/ABitOfEverythingNested"
       nestedAnnotation:
+        description: "Nested object description."
+        title: "Nested object title"
         $ref: "#/definitions/ABitOfEverythingNested"
       int64OverrideType:
         type: "integer"

diff --git a/examples/internal/clients/abe/model_a_bit_of_everything.go b/examples/internal/clients/abe/model_a_bit_of_everything.go
@@ -48,11 +48,13 @@ type ABitOfEverything struct {
 	RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
 	// Repeated numeric enum description.
 	RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
+	// Numeric enum description.
 	EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
 	// Repeated string description.
 	RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
 	// Repeated nested object description.
 	RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
+	// Nested object description.
 	NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
 	Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
 	RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

diff --git a/examples/internal/clients/abe/model_a_bit_of_everything_1.go b/examples/internal/clients/abe/model_a_bit_of_everything_1.go
@@ -49,11 +49,13 @@ type ABitOfEverything1 struct {
 	RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
 	// Repeated numeric enum description.
 	RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
+	// Numeric enum description.
 	EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
 	// Repeated string description.
 	RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
 	// Repeated nested object description.
 	RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
+	// Nested object description.
 	NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
 	Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
 	RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

diff --git a/examples/internal/clients/abe/model_a_bit_of_everything_2.go b/examples/internal/clients/abe/model_a_bit_of_everything_2.go
@@ -48,11 +48,13 @@ type ABitOfEverything2 struct {
 	RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
 	// Repeated numeric enum description.
 	RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
+	// Numeric enum description.
 	EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
 	// Repeated string description.
 	RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
 	// Repeated nested object description.
 	RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
+	// Nested object description.
 	NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
 	Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
 	RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

diff --git a/examples/internal/clients/abe/model_a_bit_of_everything_3.go b/examples/internal/clients/abe/model_a_bit_of_everything_3.go
@@ -48,11 +48,13 @@ type ABitOfEverything3 struct {
 	RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
 	// Repeated numeric enum description.
 	RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
+	// Numeric enum description.
 	EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
 	// Repeated string description.
 	RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
 	// Repeated nested object description.
 	RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
+	// Nested object description.
 	NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
 	Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
 	RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

diff --git a/examples/internal/clients/abe/model_a_bit_of_everything_4.go b/examples/internal/clients/abe/model_a_bit_of_everything_4.go
@@ -48,11 +48,13 @@ type ABitOfEverything4 struct {
 	RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
 	// Repeated numeric enum description.
 	RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
+	// Numeric enum description.
 	EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
 	// Repeated string description.
 	RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
 	// Repeated nested object description.
 	RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
+	// Nested object description.
 	NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
 	Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
 	RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation,omitempty"`

diff --git a/examples/internal/clients/abe/model_a_bit_of_everything_nested.go b/examples/internal/clients/abe/model_a_bit_of_everything_nested.go
@@ -15,5 +15,6 @@ type ABitOfEverythingNested struct {
 	// name is nested field.
 	Name string `json:"name,omitempty"`
 	Amount int64 `json:"amount,omitempty"`
+	// DeepEnum description.
 	Ok *NestedDeepEnum `json:"ok,omitempty"`
 }
diff --git a/examples/internal/clients/abe/model_examplepb_a_bit_of_everything.go b/examples/internal/clients/abe/model_examplepb_a_bit_of_everything.go
@@ -49,11 +49,13 @@ type ExamplepbABitOfEverything struct {
 	RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
 	// Repeated numeric enum description.
 	RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
+	// Numeric enum description.
 	EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
 	// Repeated string description.
 	RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
 	// Repeated nested object description.
 	RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
+	// Nested object description.
 	NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
 	Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
 	RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

diff --git a/examples/internal/clients/abe/model_v1exampledeep_pathsingle_nested_name_single_nested.go b/examples/internal/clients/abe/model_v1exampledeep_pathsingle_nested_name_single_nested.go
@@ -13,5 +13,6 @@ package abe
 // Nested is nested type.
 type V1exampledeepPathsingleNestedNameSingleNested struct {
 	Amount int64 `json:"amount,omitempty"`
+	// DeepEnum description.
 	Ok *NestedDeepEnum `json:"ok,omitempty"`
 }
diff --git a/examples/internal/proto/examplepb/a_bit_of_everything.swagger.json b/examples/internal/proto/examplepb/a_bit_of_everything.swagger.json
@@ -2480,7 +2480,9 @@
                   "title": "Repeated numeric enum title"
                 },
                 "enumValueAnnotation": {
-                  "$ref": "#/definitions/examplepbNumericEnum"
+                  "$ref": "#/definitions/examplepbNumericEnum",
+                  "description": "Numeric enum description.",
+                  "title": "Numeric enum title"
                 },
                 "repeatedStringAnnotation": {
                   "type": "array",
@@ -2499,7 +2501,9 @@
                   "title": "Repeated nested object title"
                 },
                 "nestedAnnotation": {
-                  "$ref": "#/definitions/ABitOfEverythingNested"
+                  "$ref": "#/definitions/ABitOfEverythingNested",
+                  "description": "Nested object description.",
+                  "title": "Nested object title"
                 },
                 "int64OverrideType": {
                   "type": "integer",
@@ -4724,7 +4728,8 @@
                       "format": "int64"
                     },
                     "ok": {
-                      "$ref": "#/definitions/NestedDeepEnum"
+                      "$ref": "#/definitions/NestedDeepEnum",
+                      "description": "DeepEnum description."
                     }
                   },
                   "description": "Nested is nested type."
@@ -4864,7 +4869,9 @@
                   "title": "Repeated numeric enum title"
                 },
                 "enumValueAnnotation": {
-                  "$ref": "#/definitions/examplepbNumericEnum"
+                  "$ref": "#/definitions/examplepbNumericEnum",
+                  "description": "Numeric enum description.",
+                  "title": "Numeric enum title"
                 },
                 "repeatedStringAnnotation": {
                   "type": "array",
@@ -4883,7 +4890,9 @@
                   "title": "Repeated nested object title"
                 },
                 "nestedAnnotation": {
-                  "$ref": "#/definitions/ABitOfEverythingNested"
+                  "$ref": "#/definitions/ABitOfEverythingNested",
+                  "description": "Nested object description.",
+                  "title": "Nested object title"
                 },
                 "int64OverrideType": {
                   "type": "integer",
@@ -5521,7 +5530,9 @@
                   "title": "Repeated numeric enum title"
                 },
                 "enumValueAnnotation": {
-                  "$ref": "#/definitions/examplepbNumericEnum"
+                  "$ref": "#/definitions/examplepbNumericEnum",
+                  "description": "Numeric enum description.",
+                  "title": "Numeric enum title"
                 },
                 "repeatedStringAnnotation": {
                   "type": "array",
@@ -5540,7 +5551,9 @@
                   "title": "Repeated nested object title"
                 },
                 "nestedAnnotation": {
-                  "$ref": "#/definitions/ABitOfEverythingNested"
+                  "$ref": "#/definitions/ABitOfEverythingNested",
+                  "description": "Nested object description.",
+                  "title": "Nested object title"
                 },
                 "int64OverrideType": {
                   "type": "integer",
@@ -5828,7 +5841,9 @@
                   "title": "Repeated numeric enum title"
                 },
                 "enumValueAnnotation": {
-                  "$ref": "#/definitions/examplepbNumericEnum"
+                  "$ref": "#/definitions/examplepbNumericEnum",
+                  "description": "Numeric enum description.",
+                  "title": "Numeric enum title"
                 },
                 "repeatedStringAnnotation": {
                   "type": "array",
@@ -5847,7 +5862,9 @@
                   "title": "Repeated nested object title"
                 },
                 "nestedAnnotation": {
-                  "$ref": "#/definitions/ABitOfEverythingNested"
+                  "$ref": "#/definitions/ABitOfEverythingNested",
+                  "description": "Nested object description.",
+                  "title": "Nested object title"
                 },
                 "int64OverrideType": {
                   "type": "integer",
@@ -6645,7 +6662,9 @@
                       "title": "Repeated numeric enum title"
                     },
                     "enumValueAnnotation": {
-                      "$ref": "#/definitions/examplepbNumericEnum"
+                      "$ref": "#/definitions/examplepbNumericEnum",
+                      "description": "Numeric enum description.",
+                      "title": "Numeric enum title"
                     },
                     "repeatedStringAnnotation": {
                       "type": "array",
@@ -6664,7 +6683,9 @@
                       "title": "Repeated nested object title"
                     },
                     "nestedAnnotation": {
-                      "$ref": "#/definitions/ABitOfEverythingNested"
+                      "$ref": "#/definitions/ABitOfEverythingNested",
+                      "description": "Nested object description.",
+                      "title": "Nested object title"
                     },
                     "int64OverrideType": {
                       "type": "integer",
@@ -6836,7 +6857,8 @@
           "format": "int64"
         },
         "ok": {
-          "$ref": "#/definitions/NestedDeepEnum"
+          "$ref": "#/definitions/NestedDeepEnum",
+          "description": "DeepEnum description."
         }
       },
       "description": "Nested is nested type."
@@ -7003,7 +7025,9 @@
           "title": "Repeated numeric enum title"
         },
         "enumValueAnnotation": {
-          "$ref": "#/definitions/examplepbNumericEnum"
+          "$ref": "#/definitions/examplepbNumericEnum",
+          "description": "Numeric enum description.",
+          "title": "Numeric enum title"
         },
         "repeatedStringAnnotation": {
           "type": "array",
@@ -7022,7 +7046,9 @@
           "title": "Repeated nested object title"
         },
         "nestedAnnotation": {
-          "$ref": "#/definitions/ABitOfEverythingNested"
+          "$ref": "#/definitions/ABitOfEverythingNested",
+          "description": "Nested object description.",
+          "title": "Nested object title"
         },
         "int64OverrideType": {
           "type": "integer",