[+] support integer64 as string option (google#355)

* [+] support integer64 as string option * [!] make int64/uint64/fixed64 as string default
ajorgensen · May 10, 2022 · c62333b · c62333b
1 parent 8f7dee9
commit c62333b
Show file tree

Hide file tree

Showing 21 changed files with 40 additions and 73 deletions.
diff --git a/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi.yaml b/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi.yaml
@@ -42,8 +42,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         GoogleProtobufAny:
@@ -91,8 +90,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_default_response.yaml b/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_default_response.yaml
@@ -42,8 +42,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         GoogleProtobufAny:
@@ -91,8 +90,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_fq_schema_naming.yaml b/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_fq_schema_naming.yaml
@@ -66,8 +66,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         tests.mapfields.message.v1.Message:
@@ -107,8 +106,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
 tags:

diff --git a/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_json.yaml b/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_json.yaml
@@ -42,8 +42,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         GoogleProtobufAny:
@@ -91,8 +90,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_string_enum.yaml b/cmd/protoc-gen-openapi/examples/tests/mapfields/openapi_string_enum.yaml
@@ -42,8 +42,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         GoogleProtobufAny:
@@ -91,8 +90,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi.yaml b/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi.yaml
@@ -50,8 +50,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_default_response.yaml b/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_default_response.yaml
@@ -50,8 +50,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_fq_schema_naming.yaml b/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_fq_schema_naming.yaml
@@ -66,8 +66,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
 tags:

diff --git a/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_json.yaml b/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_json.yaml
@@ -50,8 +50,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_string_enum.yaml b/cmd/protoc-gen-openapi/examples/tests/noannotations/openapi_string_enum.yaml
@@ -50,8 +50,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     type: string
         Status:

diff --git a/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi.yaml b/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi.yaml
@@ -61,8 +61,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     title: this is an overriden field schema title
                     maxLength: 255

diff --git a/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_default_response.yaml b/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_default_response.yaml
@@ -61,8 +61,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     title: this is an overriden field schema title
                     maxLength: 255

diff --git a/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_fq_schema_naming.yaml b/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_fq_schema_naming.yaml
@@ -77,8 +77,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     title: this is an overriden field schema title
                     maxLength: 255

diff --git a/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_json.yaml b/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_json.yaml
@@ -61,8 +61,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     title: this is an overriden field schema title
                     maxLength: 255

diff --git a/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_string_enum.yaml b/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/openapi_string_enum.yaml
@@ -61,8 +61,7 @@ components:
             type: object
             properties:
                 id:
-                    type: integer
-                    format: int64
+                    type: string
                 label:
                     title: this is an overriden field schema title
                     maxLength: 255

diff --git a/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi.yaml b/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi.yaml
@@ -20,8 +20,7 @@ paths:
                 - name: user_id
                   in: query
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
             responses:
                 "200":
                     description: OK
@@ -74,8 +73,7 @@ paths:
                   in: path
                   required: true
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
                 - name: message_id
                   in: path
                   required: true
@@ -110,8 +108,7 @@ components:
                 message_id:
                     type: string
                 user_id:
-                    type: integer
-                    format: uint64
+                    type: string
                 content:
                     type: string
                 maybe:

diff --git a/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_default_response.yaml b/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_default_response.yaml
@@ -20,8 +20,7 @@ paths:
                 - name: userId
                   in: query
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
             responses:
                 "200":
                     description: OK
@@ -74,8 +73,7 @@ paths:
                   in: path
                   required: true
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
                 - name: messageId
                   in: path
                   required: true
@@ -110,8 +108,7 @@ components:
                 messageId:
                     type: string
                 userId:
-                    type: integer
-                    format: uint64
+                    type: string
                 content:
                     type: string
                 maybe:

diff --git a/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_fq_schema_naming.yaml b/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_fq_schema_naming.yaml
@@ -20,8 +20,7 @@ paths:
                 - name: userId
                   in: query
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
             responses:
                 "200":
                     description: OK
@@ -74,8 +73,7 @@ paths:
                   in: path
                   required: true
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
                 - name: messageId
                   in: path
                   required: true
@@ -126,8 +124,7 @@ components:
                 messageId:
                     type: string
                 userId:
-                    type: integer
-                    format: uint64
+                    type: string
                 content:
                     type: string
                 maybe:

diff --git a/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_json.yaml b/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_json.yaml
@@ -20,8 +20,7 @@ paths:
                 - name: userId
                   in: query
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
             responses:
                 "200":
                     description: OK
@@ -74,8 +73,7 @@ paths:
                   in: path
                   required: true
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
                 - name: messageId
                   in: path
                   required: true
@@ -110,8 +108,7 @@ components:
                 messageId:
                     type: string
                 userId:
-                    type: integer
-                    format: uint64
+                    type: string
                 content:
                     type: string
                 maybe:

diff --git a/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_string_enum.yaml b/cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_string_enum.yaml
@@ -20,8 +20,7 @@ paths:
                 - name: userId
                   in: query
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
             responses:
                 "200":
                     description: OK
@@ -74,8 +73,7 @@ paths:
                   in: path
                   required: true
                   schema:
-                    type: integer
-                    format: uint64
+                    type: string
                 - name: messageId
                   in: path
                   required: true
@@ -110,8 +108,7 @@ components:
                 messageId:
                     type: string
                 userId:
-                    type: integer
-                    format: uint64
+                    type: string
                 content:
                     type: string
                 maybe:

diff --git a/cmd/protoc-gen-openapi/generator/reflector.go b/cmd/protoc-gen-openapi/generator/reflector.go
@@ -189,11 +189,13 @@ func (r *OpenAPIv3Reflector) schemaOrReferenceForField(field protoreflect.FieldD
 		kindSchema = wk.NewStringSchema()
 
 	case protoreflect.Int32Kind, protoreflect.Sint32Kind, protoreflect.Uint32Kind,
-		protoreflect.Int64Kind, protoreflect.Sint64Kind, protoreflect.Uint64Kind,
-		protoreflect.Sfixed32Kind, protoreflect.Fixed32Kind, protoreflect.Sfixed64Kind,
-		protoreflect.Fixed64Kind:
+		protoreflect.Sfixed32Kind, protoreflect.Fixed32Kind:
 		kindSchema = wk.NewIntegerSchema(kind.String())
 
+	case protoreflect.Int64Kind, protoreflect.Sint64Kind, protoreflect.Uint64Kind,
+		protoreflect.Sfixed64Kind, protoreflect.Fixed64Kind:
+		kindSchema = wk.NewStringSchema()
+
 	case protoreflect.EnumKind:
 		kindSchema = wk.NewEnumSchema(*&r.conf.EnumType, field)