Endpoints Portals update

51 views
Skip to first unread message

Andrew Gunsch

unread,
Aug 17, 2018, 1:01:38 PM8/17/18
to Cloud Endpoints Portal, google-clou...@googlegroups.com

Hi all,


We've updated your Endpoints Portals!


Some highlights since our last release:


- Sync API for custom docs --- now you can automate this as part of your continuous integration!

- Image support in custom docs --- uploads and links to images in your documentation Git repositories.

- Support for multiple versions of your OpenAPI spec --- previously, the portal would only render docs for the latest version.

- Many bugfixes, especially around Auth0-protected APIs, gRPC documentation, handling of malformed specs.


Let us know if you have any feedback or encounter bugs/issues.

- Andrew



Sean Patrick Hagen

unread,
Aug 22, 2018, 4:22:32 PM8/22/18
to Google Cloud Endpoints
What's the best way to set up imports within a proto file so that things work with the docs?

For example, in my GRPC API I import a few packages:

import "google/api/annotations.proto";
import "github.com/mwitkow/go-proto-validators/validator.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/empty.proto";
import "protoc-gen-swagger/options/annotations.proto";
import "github.com/golang/protobuf/ptypes/wrappers/wrappers.proto";
import "base.proto";
import "meta.proto";

Within my Makefile I have targets to run protoc to do all the auto-generating ( code, validator, grpc descriptor, etc ):

PROTOC=protoc \
 
-I${GOPATH}/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/ \
 
-I${GOPATH}/src/github.com/grpc-ecosystem/grpc-gateway \
 
-I${GOPATH}/src \
 
-I${PROTO_DIR} \
 
-I${GOPATH}/src/$(REPOBASE)/$(PROTO_DIR)


# later


$
(GRPC_DESCRIPTOR): $(PROTO_FILES_IN)
 $
(PROTOC) \
 
--include_imports \
 
--descriptor_set_out=$(PROTO_DIR)/grpc_descriptor.pb \
    $
(PROTO_FILES_IN)

When I deploy my endpoints config using "gcloud endpoints services deploy api/grpc_descriptor.pb grpc-api.yml", the Endpoints Developer Portal gives me the following error for the API:

We encountered the following errors while processing this API specification:Please correct these errors and try again.

Any pointers on what I can do to fix this error? These docs are super useful for the other teams that need to use the API. 

Cheers

Andrew Gunsch

unread,
Aug 22, 2018, 9:13:10 PM8/22/18
to Sean Patrick Hagen, Google Cloud Endpoints
Hey Sean,

Thanks for writing! It's quite possible that's a bug on our end.

If you're willing to let us investigate on your project, could you reply privately to me and either send me your grpc_descriptor.pb file or let me know your GCP project ID and I can load it from there?

- Andrew

--
You received this message because you are subscribed to the Google Groups "Google Cloud Endpoints" group.
To unsubscribe from this group and stop receiving emails from it, send an email to google-cloud-endp...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/google-cloud-endpoints/1c419c0f-2c47-4e76-ad43-b219bd0dbe97%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Reply all
Reply to author
Forward
0 new messages