Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from Nov 1, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 26 additions & 0 deletions examples/internal/clients/abe/api/swagger.yaml
View file
Open in desktop
Expand Up @@ -4807,6 +4807,7 @@ definitions:
type: "integer"
format: "int64"
ok:
description: "DeepEnum description."
$ref: "#/definitions/NestedDeepEnum"
description: "Nested is nested type."
example:
Expand Down Expand Up @@ -4939,6 +4940,8 @@ definitions:
items:
$ref: "#/definitions/examplepbNumericEnum"
enumValueAnnotation:
description: "Numeric enum description."
title: "Numeric enum title"
$ref: "#/definitions/examplepbNumericEnum"
repeatedStringAnnotation:
type: "array"
Expand All @@ -4953,6 +4956,8 @@ definitions:
items:
$ref: "#/definitions/ABitOfEverythingNested"
nestedAnnotation:
description: "Nested object description."
title: "Nested object title"
$ref: "#/definitions/ABitOfEverythingNested"
int64OverrideType:
type: "integer"
Expand Down Expand Up @@ -5444,6 +5449,8 @@ definitions:
items:
$ref: "#/definitions/examplepbNumericEnum"
enumValueAnnotation:
description: "Numeric enum description."
title: "Numeric enum title"
$ref: "#/definitions/examplepbNumericEnum"
repeatedStringAnnotation:
type: "array"
Expand All @@ -5458,6 +5465,8 @@ definitions:
items:
$ref: "#/definitions/ABitOfEverythingNested"
nestedAnnotation:
description: "Nested object description."
title: "Nested object title"
$ref: "#/definitions/ABitOfEverythingNested"
int64OverrideType:
type: "integer"
Expand Down Expand Up @@ -5523,6 +5532,7 @@ definitions:
type: "integer"
format: "int64"
ok:
description: "DeepEnum description."
$ref: "#/definitions/NestedDeepEnum"
description: "Nested is nested type."
example: "{\"ok\":\"TRUE\"}"
Expand Down Expand Up @@ -5640,6 +5650,8 @@ definitions:
items:
$ref: "#/definitions/examplepbNumericEnum"
enumValueAnnotation:
description: "Numeric enum description."
title: "Numeric enum title"
$ref: "#/definitions/examplepbNumericEnum"
repeatedStringAnnotation:
type: "array"
Expand All @@ -5654,6 +5666,8 @@ definitions:
items:
$ref: "#/definitions/ABitOfEverythingNested"
nestedAnnotation:
description: "Nested object description."
title: "Nested object title"
$ref: "#/definitions/ABitOfEverythingNested"
int64OverrideType:
type: "integer"
Expand Down Expand Up @@ -5836,6 +5850,8 @@ definitions:
items:
$ref: "#/definitions/examplepbNumericEnum"
enumValueAnnotation:
description: "Numeric enum description."
title: "Numeric enum title"
$ref: "#/definitions/examplepbNumericEnum"
repeatedStringAnnotation:
type: "array"
Expand All @@ -5850,6 +5866,8 @@ definitions:
items:
$ref: "#/definitions/ABitOfEverythingNested"
nestedAnnotation:
description: "Nested object description."
title: "Nested object title"
$ref: "#/definitions/ABitOfEverythingNested"
int64OverrideType:
type: "integer"
Expand Down Expand Up @@ -6017,6 +6035,8 @@ definitions:
items:
$ref: "#/definitions/examplepbNumericEnum"
enumValueAnnotation:
description: "Numeric enum description."
title: "Numeric enum title"
$ref: "#/definitions/examplepbNumericEnum"
repeatedStringAnnotation:
type: "array"
Expand All @@ -6031,6 +6051,8 @@ definitions:
items:
$ref: "#/definitions/ABitOfEverythingNested"
nestedAnnotation:
description: "Nested object description."
title: "Nested object title"
$ref: "#/definitions/ABitOfEverythingNested"
int64OverrideType:
type: "integer"
Expand Down Expand Up @@ -6188,6 +6210,8 @@ definitions:
items:
$ref: "#/definitions/examplepbNumericEnum"
enumValueAnnotation:
description: "Numeric enum description."
title: "Numeric enum title"
$ref: "#/definitions/examplepbNumericEnum"
repeatedStringAnnotation:
type: "array"
Expand All @@ -6202,6 +6226,8 @@ definitions:
items:
$ref: "#/definitions/ABitOfEverythingNested"
nestedAnnotation:
description: "Nested object description."
title: "Nested object title"
$ref: "#/definitions/ABitOfEverythingNested"
int64OverrideType:
type: "integer"
Expand Down
2 changes: 2 additions & 0 deletions examples/internal/clients/abe/model_a_bit_of_everything.go
View file
Open in desktop
Expand Up @@ -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"`
Expand Down
2 changes: 2 additions & 0 deletions examples/internal/clients/abe/model_a_bit_of_everything_1.go
View file
Open in desktop
Expand Up @@ -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"`
Expand Down
2 changes: 2 additions & 0 deletions examples/internal/clients/abe/model_a_bit_of_everything_2.go
View file
Open in desktop
Expand Up @@ -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"`
Expand Down
2 changes: 2 additions & 0 deletions examples/internal/clients/abe/model_a_bit_of_everything_3.go
View file
Open in desktop
Expand Up @@ -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"`
Expand Down
2 changes: 2 additions & 0 deletions examples/internal/clients/abe/model_a_bit_of_everything_4.go
View file
Open in desktop
Expand Up @@ -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"`
Expand Down
1 change: 1 addition & 0 deletions examples/internal/clients/abe/model_a_bit_of_everything_nested.go
View file
Open in desktop
Expand Up @@ -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"`
}
2 changes: 2 additions & 0 deletions examples/internal/clients/abe/model_examplepb_a_bit_of_everything.go
View file
Open in desktop
Expand Up @@ -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"`
Expand Down
1 change: 1 addition & 0 deletions examples/internal/clients/abe/model_v1exampledeep_pathsingle_nested_name_single_nested.go
View file
Open in desktop
Expand Up @@ -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"`
}
54 changes: 40 additions & 14 deletions examples/internal/proto/examplepb/a_bit_of_everything.swagger.json
View file
Open in desktop
Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -4724,7 +4728,8 @@
"format": "int64"
},
"ok": {
"$ref": "#/definitions/NestedDeepEnum"
"$ref": "#/definitions/NestedDeepEnum",
"description": "DeepEnum description."
}
},
"description": "Nested is nested type."
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -6836,7 +6857,8 @@
"format": "int64"
},
"ok": {
"$ref": "#/definitions/NestedDeepEnum"
"$ref": "#/definitions/NestedDeepEnum",
"description": "DeepEnum description."
}
},
"description": "Nested is nested type."
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down