[Proposal] Use Protocol Buffers as spec definition format rather than OpenAPI(swagger) about grafeas

[vbatts]

(carried over comment from email) Cool. From my experience, protobuf to jsonschema are not a one-to-one, and ultimately _something_ needs to be decided as the authoritative source. Given that this is an API, it could go either way (grpc or more RESTish).

…

On Oct 13 2017, at 2:33 pm, R2wenD2 ***@***.***> wrote: @chen-keinan (https://github.com/chen-keinan?recipient=reply%2B000105e9270d276887169973580a4777a6e4a41edc09f15692cf0000000115f8c8ff92a169ce0fd15d8f%40reply.github.com) and @vbatts (https://github.com/vbatts?recipient=reply%2B000105e9270d276887169973580a4777a6e4a41edc09f15692cf0000000115f8c8ff92a169ce0fd15d8f%40reply.github.com) I mentioned this to both of you privately - Can you review give feedback here? Thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub (#50), or mute the thread (https://github.com/notifications/unsubscribe-auth/AAEF6fnUNt-eRiDBDf59ubRDysD7zRn5ks5sr6z_gaJpZM4P44RR?recipient=reply%2B000105e9270d276887169973580a4777a6e4a41edc09f15692cf0000000115f8c8ff92a169ce0fd15d8f%40reply.github.com).

[R2wenD2]

grpc is in progress. Sorry for the delay - I think its probably worth waiting for. I'm hoping to have the issues worked out by end of week or early next week.

[R2wenD2]

@chen-keinan and @vbatts I mentioned this to both of you privately - Can you review give feedback here?

Thanks!

[bitvector2]

+1 for GRPC!

[chen-keinan]

I'm in favor for GRPC, it's much flexible, faster and simplifies the programming paradigm.

[dnascimento]

+1 for GRPC

[R2wenD2]

#61

Introduced proto - need to update ref impl to use proto and generate files as well.

[vbatts]

@R2wenD2 how is your protoc installed your build host?
On master (2ff2bea) I'm getting:

[vbatts@getdown] {master *} ~/src/github.com/grafeas/grafeas$ make build                                                                                                                      
go get -u -v github.com/golang/protobuf/protoc-gen-go
github.com/golang/protobuf (download)
protoc \
        -I. \
        -I ./vendor/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
        -I ./vendor/github.com/googleapis/googleapis \
        --go_out=. \
        v1alpha1/proto/grafeas.proto && \
        touch .protoc_middleman_go
google/protobuf/empty.proto: File not found.
google/protobuf/descriptor.proto: File not found.
google/api/annotations.proto: Import "google/protobuf/descriptor.proto" was not found or had errors.
google/api/annotations.proto:28:8: "google.protobuf.MethodOptions" is not defined.
google/protobuf/timestamp.proto: File not found.
google/protobuf/any.proto: File not found.
google/rpc/status.proto: Import "google/protobuf/any.proto" was not found or had errors.
google/rpc/status.proto:91:12: "google.protobuf.Any" is not defined.
google/longrunning/operations.proto: Import "google/api/annotations.proto" was not found or had errors.
google/longrunning/operations.proto: Import "google/protobuf/any.proto" was not found or had errors.
google/longrunning/operations.proto: Import "google/protobuf/empty.proto" was not found or had errors.
google/longrunning/operations.proto: Import "google/rpc/status.proto" was not found or had errors.
google/longrunning/operations.proto:92:3: "google.protobuf.Any" is not defined.
google/longrunning/operations.proto:104:5: "google.rpc.Status" is not defined.
google/longrunning/operations.proto:114:5: "google.protobuf.Any" is not defined.
google/longrunning/operations.proto:61:56: "google.protobuf.Empty" is not defined.
google/longrunning/operations.proto:75:56: "google.protobuf.Empty" is not defined.
google/devtools/source/v1/source_context.proto: Import "google/api/annotations.proto" was not found or had errors.
v1alpha1/proto/grafeas.proto: Import "google/protobuf/empty.proto" was not found or had errors.
v1alpha1/proto/grafeas.proto: Import "google/api/annotations.proto" was not found or had errors.
v1alpha1/proto/grafeas.proto: Import "google/protobuf/timestamp.proto" was not found or had errors.
v1alpha1/proto/grafeas.proto: Import "google/longrunning/operations.proto" was not found or had errors.
v1alpha1/proto/grafeas.proto: Import "google/devtools/source/v1/source_context.proto" was not found or had errors.
v1alpha1/proto/grafeas.proto:176:14: "google.longrunning.Operation" is not defined.
v1alpha1/proto/grafeas.proto:185:5: "google.longrunning.Operation" is not defined.
v1alpha1/proto/grafeas.proto:195:5: "google.longrunning.Operation" is not defined.
v1alpha1/proto/grafeas.proto:201:5: "google.protobuf.Timestamp" is not defined.
v1alpha1/proto/grafeas.proto:203:5: "google.protobuf.Timestamp" is not defined.
v1alpha1/proto/grafeas.proto:473:9: "google.longrunning.Operation" is not defined.
v1alpha1/proto/grafeas.proto:564:5: "google.protobuf.Timestamp" is not defined.
v1alpha1/proto/grafeas.proto:568:5: "google.protobuf.Timestamp" is not defined.
v1alpha1/proto/grafeas.proto:572:5: "google.protobuf.Timestamp" is not defined.
v1alpha1/proto/grafeas.proto:622:5: "google.protobuf.Timestamp" is not defined.
v1alpha1/proto/grafeas.proto:625:5: "google.protobuf.Timestamp" is not defined.
v1alpha1/proto/grafeas.proto:801:5: "google.devtools.source.v1.ExtendedSourceContext" is not defined.
v1alpha1/proto/grafeas.proto:807:14: "google.devtools.source.v1.ExtendedSourceContext" is not defined.
v1alpha1/proto/grafeas.proto:1014:14: "google.protobuf.Empty" is not defined.
v1alpha1/proto/grafeas.proto:1058:48: "google.protobuf.Empty" is not defined.
v1alpha1/proto/grafeas.proto:1090:14: "google.longrunning.Operation" is not defined.
v1alpha1/proto/grafeas.proto:1101:14: "google.longrunning.Operation" is not defined.
make: *** [Makefile:25: .protoc_middleman_go] Error 1
[vbatts@getdown] {master *} ~/src/github.com/grafeas/grafeas$ protoc --version
libprotoc 3.2.0

[vbatts]

oh. bugger. the fedora protobuf package doesn't have them, but they're in the -devel subpackage. Sorry for noise. :-|

[vbatts]

I opened #64 to clean things up a bit. Though I'm looking at the go source is the compiler is not passing through comments.
Looks like kubernetes is using https://github.com/gogo/protobuf which does seem to pass through the comments, allowing for more consumable golang source. Thoughts?

[R2wenD2]

I'm fine with using gogo/probuf in place of the other generated files.

[vbatts]

I'm still looking at getting the gprc interfaces to be generated.

…

On Fri, Oct 20, 2017 at 4:22 PM, R2wenD2 ***@***.***> wrote: I'm fine with using gogo/probuf in place of the other generated files. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#50 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAEF6elO7BZ9mSoAXsqJ4K-j9TpiX_Pjks5suQEOgaJpZM4P44RR> .

[vbatts]

https://github.com/grpc-ecosystem/grpc-gateway seems to be a popular enough grpc REST bridge

[furuholm]

What's the status of this? I was planning to implement project listing (#74) but I'm not sure if I should complete the implementation using the swagger generator or if I should wait until the gprc infrastructure is in place. Suggestions and thoughts?

[R2wenD2]

@vbatts I'm going to get grpc-gateway setup before closing this issue.

[vbatts]

@R2wenD2 right on

[vbatts]

looks like we're just about here, for this issue. Now even with a swagger representation of the protobuf JSON bridge. Should we delete ./v1alpha1/grafeas.json and close this issue?