Field and schema extensions

grpc-ecosystem · Nov 8, 2021 · b0e52fa · b0e52fa
1 parent 6964da5
commit b0e52fa
Show file tree

Hide file tree

Showing 34 changed files with 1,288 additions and 1,051 deletions.
diff --git a/examples/internal/clients/abe/api/swagger.yaml b/examples/internal/clients/abe/api/swagger.yaml
@@ -158,6 +158,7 @@ paths:
         in: "query"
         required: false
         type: "string"
+        x-internal: true
         x-exportParamName: "Uuid"
         x-optionalDataType: "String"
       - name: "floatValue"
@@ -470,6 +471,7 @@ paths:
         in: "query"
         required: false
         type: "string"
+        x-internal: true
         x-exportParamName: "Uuid"
         x-optionalDataType: "String"
       - name: "floatValue"
@@ -773,6 +775,7 @@ paths:
         in: "query"
         required: false
         type: "string"
+        x-internal: true
         x-exportParamName: "Uuid"
         x-optionalDataType: "String"
       - name: "floatValue"
@@ -1066,6 +1069,7 @@ paths:
         in: "path"
         required: true
         type: "string"
+        x-internal: true
         x-exportParamName: "Uuid"
       - name: "singleNested.name"
         in: "query"
@@ -1544,6 +1548,7 @@ paths:
         in: "query"
         required: false
         type: "string"
+        x-internal: true
         x-exportParamName: "Uuid"
         x-optionalDataType: "String"
       - name: "bytesValue"
@@ -1733,6 +1738,7 @@ paths:
         in: "path"
         required: true
         type: "string"
+        x-internal: true
         x-exportParamName: "Uuid"
       - in: "body"
         name: "body"
@@ -2203,6 +2209,7 @@ paths:
         in: "path"
         required: true
         type: "string"
+        x-internal: true
         x-exportParamName: "AbeUuid"
       - in: "body"
         name: "body"
@@ -2251,6 +2258,7 @@ paths:
         in: "path"
         required: true
         type: "string"
+        x-internal: true
         x-exportParamName: "AbeUuid"
       - in: "body"
         name: "body"
@@ -2649,6 +2657,7 @@ paths:
         in: "path"
         required: true
         type: "string"
+        x-internal: true
         x-exportParamName: "AbeUuid"
       - in: "body"
         name: "body"
@@ -2785,6 +2794,7 @@ definitions:
         type: "string"
         minLength: 1
         pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
+        x-internal: true
       nested:
         type: "array"
         items:
@@ -2919,6 +2929,7 @@ definitions:
     example:
       int64_value: 12
       double_value: 12.3
+    x-a-bit-of-everything-foo: "bar"
   examplepbABitOfEverythingRepeated:
     type: "object"
     properties:
@@ -3334,6 +3345,7 @@ definitions:
     example:
       int64_value: 12
       double_value: 12.3
+    x-a-bit-of-everything-foo: "bar"
 externalDocs:
   description: "More about gRPC-Gateway"
   url: "https://github.com/grpc-ecosystem/grpc-gateway"

diff --git a/examples/internal/helloworld/helloworld.pb.go b/examples/internal/helloworld/helloworld.pb.go
diff --git a/examples/internal/proto/examplepb/a_bit_of_everything.pb.go b/examples/internal/proto/examplepb/a_bit_of_everything.pb.go
diff --git a/examples/internal/proto/examplepb/a_bit_of_everything.proto b/examples/internal/proto/examplepb/a_bit_of_everything.proto
@@ -243,6 +243,12 @@ message ABitOfEverything {
 			description: "Find out more about ABitOfEverything";
 		}
 		example: "{\"int64_value\": 12, \"double_value\": 12.3}"
+		extensions: {
+            key: "x-a-bit-of-everything-foo";
+            value {
+                string_value: "bar";
+            }
+        }
 	};
 
 	// Nested is nested type.
@@ -266,7 +272,7 @@ message ABitOfEverything {
 	}
 	Nested single_nested = 25;
 
-	string uuid = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", min_length: 1}];
+	string uuid = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", min_length: 1, extensions: {key: "x-internal"; value {bool_value: true}}}];
 	repeated Nested nested = 2;
 	float float_value = 3 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "Float value field", default: "0.2", required: ['float_value']}];
 	double double_value = 4;

diff --git a/examples/internal/proto/examplepb/a_bit_of_everything.swagger.json b/examples/internal/proto/examplepb/a_bit_of_everything.swagger.json
@@ -238,7 +238,8 @@
             "name": "uuid",
             "in": "query",
             "required": false,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "floatValue",
@@ -579,7 +580,8 @@
             "name": "uuid",
             "in": "query",
             "required": false,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "floatValue",
@@ -913,7 +915,8 @@
             "name": "uuid",
             "in": "query",
             "required": false,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "floatValue",
@@ -1234,7 +1237,8 @@
             "name": "uuid",
             "in": "path",
             "required": true,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "singleNested.name",
@@ -1766,7 +1770,8 @@
             "name": "uuid",
             "in": "query",
             "required": false,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "bytesValue",
@@ -2055,7 +2060,8 @@
             "name": "uuid",
             "in": "path",
             "required": true,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "body",
@@ -2258,7 +2264,8 @@
                 "doubleValue",
                 "floatValue",
                 "requiredStringViaFieldBehaviorAnnotation"
-              ]
+              ],
+              "x-a-bit-of-everything-foo": "bar"
             }
           }
         ],
@@ -2808,7 +2815,8 @@
             "name": "abe.uuid",
             "in": "path",
             "required": true,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "body",
@@ -2874,7 +2882,8 @@
             "name": "abe.uuid",
             "in": "path",
             "required": true,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "body",
@@ -3442,7 +3451,8 @@
             "name": "abe.uuid",
             "in": "path",
             "required": true,
-            "type": "string"
+            "type": "string",
+            "x-internal": true
           },
           {
             "name": "body",
@@ -3568,7 +3578,8 @@
         "uuid": {
           "type": "string",
           "minLength": 1,
-          "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
+          "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+          "x-internal": true
         },
         "nested": {
           "type": "array",
@@ -3758,7 +3769,8 @@
         "doubleValue",
         "floatValue",
         "requiredStringViaFieldBehaviorAnnotation"
-      ]
+      ],
+      "x-a-bit-of-everything-foo": "bar"
     },
     "examplepbABitOfEverythingRepeated": {
       "type": "object",

diff --git a/examples/internal/proto/examplepb/echo_service.pb.go b/examples/internal/proto/examplepb/echo_service.pb.go
diff --git a/examples/internal/proto/examplepb/flow_combination.pb.go b/examples/internal/proto/examplepb/flow_combination.pb.go
diff --git a/examples/internal/proto/examplepb/generate_unbound_methods.pb.go b/examples/internal/proto/examplepb/generate_unbound_methods.pb.go
diff --git a/examples/internal/proto/examplepb/generated_input.swagger.json b/examples/internal/proto/examplepb/generated_input.swagger.json
@@ -101,7 +101,8 @@
         "uuid": {
           "type": "string",
           "minLength": 1,
-          "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
+          "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+          "x-internal": true
         },
         "nested": {
           "type": "array",
@@ -291,7 +292,8 @@
         "doubleValue",
         "floatValue",
         "requiredStringViaFieldBehaviorAnnotation"
-      ]
+      ],
+      "x-a-bit-of-everything-foo": "bar"
     },
     "examplepbNumericEnum": {
       "type": "string",

diff --git a/examples/internal/proto/examplepb/non_standard_names.pb.go b/examples/internal/proto/examplepb/non_standard_names.pb.go
diff --git a/examples/internal/proto/examplepb/openapi_merge_a.pb.go b/examples/internal/proto/examplepb/openapi_merge_a.pb.go
diff --git a/examples/internal/proto/examplepb/openapi_merge_b.pb.go b/examples/internal/proto/examplepb/openapi_merge_b.pb.go
diff --git a/examples/internal/proto/examplepb/response_body_service.pb.go b/examples/internal/proto/examplepb/response_body_service.pb.go
diff --git a/examples/internal/proto/examplepb/stream.pb.go b/examples/internal/proto/examplepb/stream.pb.go
diff --git a/examples/internal/proto/examplepb/stream.swagger.json b/examples/internal/proto/examplepb/stream.swagger.json
@@ -228,7 +228,8 @@
         "uuid": {
           "type": "string",
           "minLength": 1,
-          "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
+          "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+          "x-internal": true
         },
         "nested": {
           "type": "array",
@@ -418,7 +419,8 @@
         "doubleValue",
         "floatValue",
         "requiredStringViaFieldBehaviorAnnotation"
-      ]
+      ],
+      "x-a-bit-of-everything-foo": "bar"
     },
     "examplepbNumericEnum": {
       "type": "string",

diff --git a/examples/internal/proto/examplepb/unannotated_echo_service.pb.go b/examples/internal/proto/examplepb/unannotated_echo_service.pb.go
diff --git a/examples/internal/proto/examplepb/use_go_template.pb.go b/examples/internal/proto/examplepb/use_go_template.pb.go
diff --git a/examples/internal/proto/examplepb/wrappers.pb.go b/examples/internal/proto/examplepb/wrappers.pb.go
diff --git a/examples/internal/proto/pathenum/path_enum.pb.go b/examples/internal/proto/pathenum/path_enum.pb.go