Skip to content

protoc-gen-openapi: add flag for 64-bit integer serialization method #479

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

Open
cusher wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −2
Open

protoc-gen-openapi: add flag for 64-bit integer serialization method #479

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions cmd/protoc-gen-openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,17 @@ refers to additional .proto files in the same directory as
schema:
$ref: '#/components/schemas/google.rpc.Status'
```
9. `int64_as_string`: use string for 64-bit integer serialization.
Using "false" generates a scheme incompatible with official proto JSON serialization, but maybe more accurately represent the types used in some cases.
- **default**: true
- `false`: output all 64-bit integer fields as type `integer` and the specific type under format
```yaml
schema:
type: integer
format: int64
```
- `true`: setting type to `string`
```yaml
schema:
type: string
```
1 change: 1 addition & 0 deletions cmd/protoc-gen-openapi/generator/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ type Configuration struct {
CircularDepth *int
DefaultResponse *bool
OutputMode *string
Int64AsString *bool
}

const (
Expand Down
15 changes: 13 additions & 2 deletions cmd/protoc-gen-openapi/generator/reflector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,14 @@ func (r *OpenAPIv3Reflector) schemaOrReferenceForMessage(message protoreflect.Me
case ".google.protobuf.Int32Value", ".google.protobuf.UInt32Value":
return wk.NewIntegerSchema(getValueKind(message))

case ".google.protobuf.StringValue", ".google.protobuf.Int64Value", ".google.protobuf.UInt64Value":
case ".google.protobuf.Int64Value", ".google.protobuf.UInt64Value":
if *r.conf.Int64AsString {
return wk.NewStringSchema()
} else {
return wk.NewIntegerSchema(getValueKind(message))
}

case ".google.protobuf.StringValue":
return wk.NewStringSchema()

case ".google.protobuf.FloatValue", ".google.protobuf.DoubleValue":
Expand Down Expand Up @@ -213,7 +220,11 @@ func (r *OpenAPIv3Reflector) schemaOrReferenceForField(field protoreflect.FieldD

case protoreflect.Int64Kind, protoreflect.Sint64Kind, protoreflect.Uint64Kind,
protoreflect.Sfixed64Kind, protoreflect.Fixed64Kind:
kindSchema = wk.NewStringSchema()
if *r.conf.Int64AsString {
kindSchema = wk.NewStringSchema()
} else {
kindSchema = wk.NewIntegerSchema(kind.String())
}

case protoreflect.EnumKind:
kindSchema = wk.NewEnumSchema(*&r.conf.EnumType, field)
Expand Down
1 change: 1 addition & 0 deletions cmd/protoc-gen-openapi/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ func main() {
CircularDepth: flags.Int("depth", 2, "depth of recursion for circular messages"),
DefaultResponse: flags.Bool("default_response", true, `add default response. If "true", automatically adds a default response to operations which use the google.rpc.Status message. Useful if you use envoy or grpc-gateway to transcode as they use this type for their default error responses.`),
OutputMode: flags.String("output_mode", "merged", `output generation mode. By default, a single openapi.yaml is generated at the out folder. Use "source_relative' to generate a separate '[inputfile].openapi.yaml' next to each '[inputfile].proto'.`),
Int64AsString: flags.Bool("int64_as_string", true, `serialize 64-bit integer types as string. If false, will serialize as integer which is incompatible with the official proto JSON serialization.`),
}

opts := protogen.Options{
Expand Down