Skip to content

Commit a0fe8d7

Browse files
gostajonassongostajonasson
authored
feat(gen-openapiv2): keep fields next to "$ref" fields (#2986)
1 parent 04a7ec4 commit a0fe8d7

13 files changed

+96
-32
lines changed

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4807,6 +4807,7 @@ definitions:
48074807
type: "integer"
48084808
format: "int64"
48094809
ok:
4810+
description: "DeepEnum description."
48104811
$ref: "#/definitions/NestedDeepEnum"
48114812
description: "Nested is nested type."
48124813
example:
@@ -4939,6 +4940,8 @@ definitions:
49394940
items:
49404941
$ref: "#/definitions/examplepbNumericEnum"
49414942
enumValueAnnotation:
4943+
description: "Numeric enum description."
4944+
title: "Numeric enum title"
49424945
$ref: "#/definitions/examplepbNumericEnum"
49434946
repeatedStringAnnotation:
49444947
type: "array"
@@ -4953,6 +4956,8 @@ definitions:
49534956
items:
49544957
$ref: "#/definitions/ABitOfEverythingNested"
49554958
nestedAnnotation:
4959+
description: "Nested object description."
4960+
title: "Nested object title"
49564961
$ref: "#/definitions/ABitOfEverythingNested"
49574962
int64OverrideType:
49584963
type: "integer"
@@ -5444,6 +5449,8 @@ definitions:
54445449
items:
54455450
$ref: "#/definitions/examplepbNumericEnum"
54465451
enumValueAnnotation:
5452+
description: "Numeric enum description."
5453+
title: "Numeric enum title"
54475454
$ref: "#/definitions/examplepbNumericEnum"
54485455
repeatedStringAnnotation:
54495456
type: "array"
@@ -5458,6 +5465,8 @@ definitions:
54585465
items:
54595466
$ref: "#/definitions/ABitOfEverythingNested"
54605467
nestedAnnotation:
5468+
description: "Nested object description."
5469+
title: "Nested object title"
54615470
$ref: "#/definitions/ABitOfEverythingNested"
54625471
int64OverrideType:
54635472
type: "integer"
@@ -5523,6 +5532,7 @@ definitions:
55235532
type: "integer"
55245533
format: "int64"
55255534
ok:
5535+
description: "DeepEnum description."
55265536
$ref: "#/definitions/NestedDeepEnum"
55275537
description: "Nested is nested type."
55285538
example: "{\"ok\":\"TRUE\"}"
@@ -5640,6 +5650,8 @@ definitions:
56405650
items:
56415651
$ref: "#/definitions/examplepbNumericEnum"
56425652
enumValueAnnotation:
5653+
description: "Numeric enum description."
5654+
title: "Numeric enum title"
56435655
$ref: "#/definitions/examplepbNumericEnum"
56445656
repeatedStringAnnotation:
56455657
type: "array"
@@ -5654,6 +5666,8 @@ definitions:
56545666
items:
56555667
$ref: "#/definitions/ABitOfEverythingNested"
56565668
nestedAnnotation:
5669+
description: "Nested object description."
5670+
title: "Nested object title"
56575671
$ref: "#/definitions/ABitOfEverythingNested"
56585672
int64OverrideType:
56595673
type: "integer"
@@ -5836,6 +5850,8 @@ definitions:
58365850
items:
58375851
$ref: "#/definitions/examplepbNumericEnum"
58385852
enumValueAnnotation:
5853+
description: "Numeric enum description."
5854+
title: "Numeric enum title"
58395855
$ref: "#/definitions/examplepbNumericEnum"
58405856
repeatedStringAnnotation:
58415857
type: "array"
@@ -5850,6 +5866,8 @@ definitions:
58505866
items:
58515867
$ref: "#/definitions/ABitOfEverythingNested"
58525868
nestedAnnotation:
5869+
description: "Nested object description."
5870+
title: "Nested object title"
58535871
$ref: "#/definitions/ABitOfEverythingNested"
58545872
int64OverrideType:
58555873
type: "integer"
@@ -6017,6 +6035,8 @@ definitions:
60176035
items:
60186036
$ref: "#/definitions/examplepbNumericEnum"
60196037
enumValueAnnotation:
6038+
description: "Numeric enum description."
6039+
title: "Numeric enum title"
60206040
$ref: "#/definitions/examplepbNumericEnum"
60216041
repeatedStringAnnotation:
60226042
type: "array"
@@ -6031,6 +6051,8 @@ definitions:
60316051
items:
60326052
$ref: "#/definitions/ABitOfEverythingNested"
60336053
nestedAnnotation:
6054+
description: "Nested object description."
6055+
title: "Nested object title"
60346056
$ref: "#/definitions/ABitOfEverythingNested"
60356057
int64OverrideType:
60366058
type: "integer"
@@ -6188,6 +6210,8 @@ definitions:
61886210
items:
61896211
$ref: "#/definitions/examplepbNumericEnum"
61906212
enumValueAnnotation:
6213+
description: "Numeric enum description."
6214+
title: "Numeric enum title"
61916215
$ref: "#/definitions/examplepbNumericEnum"
61926216
repeatedStringAnnotation:
61936217
type: "array"
@@ -6202,6 +6226,8 @@ definitions:
62026226
items:
62036227
$ref: "#/definitions/ABitOfEverythingNested"
62046228
nestedAnnotation:
6229+
description: "Nested object description."
6230+
title: "Nested object title"
62056231
$ref: "#/definitions/ABitOfEverythingNested"
62066232
int64OverrideType:
62076233
type: "integer"

‎examples/internal/clients/abe/model_a_bit_of_everything.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,13 @@ type ABitOfEverything struct {
4848
RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
4949
// Repeated numeric enum description.
5050
RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
51+
// Numeric enum description.
5152
EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
5253
// Repeated string description.
5354
RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
5455
// Repeated nested object description.
5556
RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
57+
// Nested object description.
5658
NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
5759
Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
5860
RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

‎examples/internal/clients/abe/model_a_bit_of_everything_1.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,13 @@ type ABitOfEverything1 struct {
4949
RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
5050
// Repeated numeric enum description.
5151
RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
52+
// Numeric enum description.
5253
EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
5354
// Repeated string description.
5455
RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
5556
// Repeated nested object description.
5657
RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
58+
// Nested object description.
5759
NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
5860
Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
5961
RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

‎examples/internal/clients/abe/model_a_bit_of_everything_2.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,13 @@ type ABitOfEverything2 struct {
4848
RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
4949
// Repeated numeric enum description.
5050
RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
51+
// Numeric enum description.
5152
EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
5253
// Repeated string description.
5354
RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
5455
// Repeated nested object description.
5556
RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
57+
// Nested object description.
5658
NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
5759
Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
5860
RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

‎examples/internal/clients/abe/model_a_bit_of_everything_3.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,13 @@ type ABitOfEverything3 struct {
4848
RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
4949
// Repeated numeric enum description.
5050
RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
51+
// Numeric enum description.
5152
EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
5253
// Repeated string description.
5354
RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
5455
// Repeated nested object description.
5556
RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
57+
// Nested object description.
5658
NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
5759
Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
5860
RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

‎examples/internal/clients/abe/model_a_bit_of_everything_4.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,13 @@ type ABitOfEverything4 struct {
4848
RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
4949
// Repeated numeric enum description.
5050
RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
51+
// Numeric enum description.
5152
EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
5253
// Repeated string description.
5354
RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
5455
// Repeated nested object description.
5556
RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
57+
// Nested object description.
5658
NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
5759
Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
5860
RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation,omitempty"`

‎examples/internal/clients/abe/model_a_bit_of_everything_nested.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ type ABitOfEverythingNested struct {
1515
// name is nested field.
1616
Name string `json:"name,omitempty"`
1717
Amount int64 `json:"amount,omitempty"`
18+
// DeepEnum description.
1819
Ok *NestedDeepEnum `json:"ok,omitempty"`
1920
}

‎examples/internal/clients/abe/model_examplepb_a_bit_of_everything.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,13 @@ type ExamplepbABitOfEverything struct {
4949
RepeatedEnumValue []ExamplepbNumericEnum `json:"repeatedEnumValue,omitempty"`
5050
// Repeated numeric enum description.
5151
RepeatedEnumAnnotation []ExamplepbNumericEnum `json:"repeatedEnumAnnotation,omitempty"`
52+
// Numeric enum description.
5253
EnumValueAnnotation *ExamplepbNumericEnum `json:"enumValueAnnotation,omitempty"`
5354
// Repeated string description.
5455
RepeatedStringAnnotation []string `json:"repeatedStringAnnotation,omitempty"`
5556
// Repeated nested object description.
5657
RepeatedNestedAnnotation []ABitOfEverythingNested `json:"repeatedNestedAnnotation,omitempty"`
58+
// Nested object description.
5759
NestedAnnotation *ABitOfEverythingNested `json:"nestedAnnotation,omitempty"`
5860
Int64OverrideType int64 `json:"int64OverrideType,omitempty"`
5961
RequiredStringViaFieldBehaviorAnnotation string `json:"requiredStringViaFieldBehaviorAnnotation"`

‎examples/internal/clients/abe/model_v1exampledeep_pathsingle_nested_name_single_nested.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@ package abe
1313
// Nested is nested type.
1414
type V1exampledeepPathsingleNestedNameSingleNested struct {
1515
Amount int64 `json:"amount,omitempty"`
16+
// DeepEnum description.
1617
Ok *NestedDeepEnum `json:"ok,omitempty"`
1718
}

‎examples/internal/proto/examplepb/a_bit_of_everything.swagger.json‎

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2480,7 +2480,9 @@
24802480
"title": "Repeated numeric enum title"
24812481
},
24822482
"enumValueAnnotation": {
2483-
"$ref": "#/definitions/examplepbNumericEnum"
2483+
"$ref": "#/definitions/examplepbNumericEnum",
2484+
"description": "Numeric enum description.",
2485+
"title": "Numeric enum title"
24842486
},
24852487
"repeatedStringAnnotation": {
24862488
"type": "array",
@@ -2499,7 +2501,9 @@
24992501
"title": "Repeated nested object title"
25002502
},
25012503
"nestedAnnotation": {
2502-
"$ref": "#/definitions/ABitOfEverythingNested"
2504+
"$ref": "#/definitions/ABitOfEverythingNested",
2505+
"description": "Nested object description.",
2506+
"title": "Nested object title"
25032507
},
25042508
"int64OverrideType": {
25052509
"type": "integer",
@@ -4724,7 +4728,8 @@
47244728
"format": "int64"
47254729
},
47264730
"ok": {
4727-
"$ref": "#/definitions/NestedDeepEnum"
4731+
"$ref": "#/definitions/NestedDeepEnum",
4732+
"description": "DeepEnum description."
47284733
}
47294734
},
47304735
"description": "Nested is nested type."
@@ -4864,7 +4869,9 @@
48644869
"title": "Repeated numeric enum title"
48654870
},
48664871
"enumValueAnnotation": {
4867-
"$ref": "#/definitions/examplepbNumericEnum"
4872+
"$ref": "#/definitions/examplepbNumericEnum",
4873+
"description": "Numeric enum description.",
4874+
"title": "Numeric enum title"
48684875
},
48694876
"repeatedStringAnnotation": {
48704877
"type": "array",
@@ -4883,7 +4890,9 @@
48834890
"title": "Repeated nested object title"
48844891
},
48854892
"nestedAnnotation": {
4886-
"$ref": "#/definitions/ABitOfEverythingNested"
4893+
"$ref": "#/definitions/ABitOfEverythingNested",
4894+
"description": "Nested object description.",
4895+
"title": "Nested object title"
48874896
},
48884897
"int64OverrideType": {
48894898
"type": "integer",
@@ -5521,7 +5530,9 @@
55215530
"title": "Repeated numeric enum title"
55225531
},
55235532
"enumValueAnnotation": {
5524-
"$ref": "#/definitions/examplepbNumericEnum"
5533+
"$ref": "#/definitions/examplepbNumericEnum",
5534+
"description": "Numeric enum description.",
5535+
"title": "Numeric enum title"
55255536
},
55265537
"repeatedStringAnnotation": {
55275538
"type": "array",
@@ -5540,7 +5551,9 @@
55405551
"title": "Repeated nested object title"
55415552
},
55425553
"nestedAnnotation": {
5543-
"$ref": "#/definitions/ABitOfEverythingNested"
5554+
"$ref": "#/definitions/ABitOfEverythingNested",
5555+
"description": "Nested object description.",
5556+
"title": "Nested object title"
55445557
},
55455558
"int64OverrideType": {
55465559
"type": "integer",
@@ -5828,7 +5841,9 @@
58285841
"title": "Repeated numeric enum title"
58295842
},
58305843
"enumValueAnnotation": {
5831-
"$ref": "#/definitions/examplepbNumericEnum"
5844+
"$ref": "#/definitions/examplepbNumericEnum",
5845+
"description": "Numeric enum description.",
5846+
"title": "Numeric enum title"
58325847
},
58335848
"repeatedStringAnnotation": {
58345849
"type": "array",
@@ -5847,7 +5862,9 @@
58475862
"title": "Repeated nested object title"
58485863
},
58495864
"nestedAnnotation": {
5850-
"$ref": "#/definitions/ABitOfEverythingNested"
5865+
"$ref": "#/definitions/ABitOfEverythingNested",
5866+
"description": "Nested object description.",
5867+
"title": "Nested object title"
58515868
},
58525869
"int64OverrideType": {
58535870
"type": "integer",
@@ -6645,7 +6662,9 @@
66456662
"title": "Repeated numeric enum title"
66466663
},
66476664
"enumValueAnnotation": {
6648-
"$ref": "#/definitions/examplepbNumericEnum"
6665+
"$ref": "#/definitions/examplepbNumericEnum",
6666+
"description": "Numeric enum description.",
6667+
"title": "Numeric enum title"
66496668
},
66506669
"repeatedStringAnnotation": {
66516670
"type": "array",
@@ -6664,7 +6683,9 @@
66646683
"title": "Repeated nested object title"
66656684
},
66666685
"nestedAnnotation": {
6667-
"$ref": "#/definitions/ABitOfEverythingNested"
6686+
"$ref": "#/definitions/ABitOfEverythingNested",
6687+
"description": "Nested object description.",
6688+
"title": "Nested object title"
66686689
},
66696690
"int64OverrideType": {
66706691
"type": "integer",
@@ -6836,7 +6857,8 @@
68366857
"format": "int64"
68376858
},
68386859
"ok": {
6839-
"$ref": "#/definitions/NestedDeepEnum"
6860+
"$ref": "#/definitions/NestedDeepEnum",
6861+
"description": "DeepEnum description."
68406862
}
68416863
},
68426864
"description": "Nested is nested type."
@@ -7003,7 +7025,9 @@
70037025
"title": "Repeated numeric enum title"
70047026
},
70057027
"enumValueAnnotation": {
7006-
"$ref": "#/definitions/examplepbNumericEnum"
7028+
"$ref": "#/definitions/examplepbNumericEnum",
7029+
"description": "Numeric enum description.",
7030+
"title": "Numeric enum title"
70077031
},
70087032
"repeatedStringAnnotation": {
70097033
"type": "array",
@@ -7022,7 +7046,9 @@
70227046
"title": "Repeated nested object title"
70237047
},
70247048
"nestedAnnotation": {
7025-
"$ref": "#/definitions/ABitOfEverythingNested"
7049+
"$ref": "#/definitions/ABitOfEverythingNested",
7050+
"description": "Nested object description.",
7051+
"title": "Nested object title"
70267052
},
70277053
"int64OverrideType": {
70287054
"type": "integer",

0 commit comments

Comments
 (0)