grpc-web: add annotation for openAPI

Signed-off-by: Victor Login <batazor111@gmail.com>
shortlink-org · Nov 16, 2022 · bf06929 · bf06929
1 parent 2f79033
commit bf06929
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 8 deletions.
diff --git a/go.work.sum b/go.work.sum
@@ -530,10 +530,16 @@ google.golang.org/grpc v1.49.0/go.mod h1:ZgQEeidpAuNRZ8iRrlBKXZQP1ghovWIVhdJRyCD
 google.golang.org/grpc v1.50.0/go.mod h1:ZgQEeidpAuNRZ8iRrlBKXZQP1ghovWIVhdJRyCDK+GI=
 google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gotest.tools/v3 v3.2.0/go.mod h1:Mcr9QNxkg0uMvy/YElmo4SpXgJKWgQvYrT7Kw5RzJ1A=
+k8s.io/apiextensions-apiserver v0.25.4/go.mod h1:bkSGki5YBoZWdn5pWtNIdGvDrrsRWlmnvl9a+tAw5vQ=
 k8s.io/apiserver v0.25.2/go.mod h1:30r7xyQTREWCkG2uSjgjhQcKVvAAlqoD+YyrqR6Cn+I=
+k8s.io/apiserver v0.25.4/go.mod h1:rPcm567XxjOnnd7jedDUnGJGmDGAo+cT6H7QHAN+xV0=
 k8s.io/code-generator v0.25.2/go.mod h1:f61OcU2VqVQcjt/6TrU0sta1TA5hHkOO6ZZPwkL9Eys=
+k8s.io/code-generator v0.25.4/go.mod h1:9F5fuVZOMWRme7MYj2YT3L9ropPWPokd9VRhVyD3+0w=
+k8s.io/component-base v0.25.4/go.mod h1:nnZJU8OP13PJEm6/p5V2ztgX2oyteIaAGKGMYb2L2cY=
 k8s.io/gengo v0.0.0-20211129171323-c02415ce4185/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E=
+k8s.io/gengo v0.0.0-20221011193443-fad74ee6edd9/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E=
 k8s.io/klog/v2 v2.70.1/go.mod h1:y1WjHnz7Dj687irZUWR/WLkLc5N1YHtjLdmgWjndZn0=
 k8s.io/kubernetes v1.1.0/go.mod h1:ocZa8+6APFNC2tX1DZASIbocyYT5jHzqFVsY5aoB7Jk=
 k8s.io/utils v0.0.0-20220728103510-ee6ede2d64ed/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA=
 sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.32/go.mod h1:fEO7lRTdivWO2qYVCVG7dEADOMo/MLDCVr8So2g88Uw=
+sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.33/go.mod h1:soWkSNf2tZC7aMibXEqVhCd73GOY5fJikn8qbdzemB0=
diff --git a/internal/services/api/application/grpc_web/v1/grpc_api.proto b/internal/services/api/application/grpc_web/v1/grpc_api.proto
@@ -37,31 +37,53 @@ service LinkService {
 }
 
 message GetLinksRequest {
-  domain.link.v1.Link link = 1;
+  domain.link.v1.Link link = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    example: "{\"hash\": \"1234567890\"}"
+    description: "Link hash"
+  }];
 
-  string filter = 2;
+  string filter = 2 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    description: "Filter by link"
+  }];
 }
 
 message GetLinksResponse {
-  repeated domain.link.v1.Link links = 1;
+  repeated domain.link.v1.Link links = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    description: "Links"
+  }];
 }
 
 message GetLinkRequest {
-  domain.link.v1.Link link = 1;
+  domain.link.v1.Link link = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    example: "{\"hash\": \"1234567890\"}"
+    description: "Link hash"
+  }];
 }
 
 message GetLinkResponse {
-  domain.link.v1.Link link = 1;
+  domain.link.v1.Link link = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    example: "{\"hash\": \"1234567890\"}"
+    description: "Link hash"
+  }];
 }
 
 message CreateLinkRequest {
-  domain.link.v1.Link link = 1;
+  domain.link.v1.Link link = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    example: "{\"url\": \"https://google.com\"}"
+    description: "Link"
+  }];
 }
 
 message CreateLinkResponse {
-  domain.link.v1.Link link = 1;
+  domain.link.v1.Link link = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    example: "{\"hash\": \"1234567890\"}"
+    description: "Link hash"
+  }];
 }
 
 message DeleteLinkRequest {
-  domain.link.v1.Link link = 1;
+  domain.link.v1.Link link = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+    example: "{\"hash\": \"1234567890\"}"
+    description: "Link hash"
+  }];
 }