atarora commented on code in PR #197: URL: https://github.com/apache/opennlp-sandbox/pull/197#discussion_r1886823882
########## opennlp-grpc/opennlp-grpc-api/README.md: ########## @@ -0,0 +1,53 @@ +# Apache OpenNLP gRPC API + +This module contains the [gRPC](https://grpc.io) schema used in Apache OpenNLP to provide a service side gRPC backend. + +An automatically generated overview of the endpoints and messages can be found [here](opennlp) + +# Main concepts + +The endpoints and messages described by the API are meant to be a minimum. +It does not support every feature of Apache OpenNLP at the moment, but is open for enhancement or further improvement. + +# Maven dependencies + +The Java code generated from the schema is available as a Maven dependency. + +``` + <dependencies> + <dependency> + <groupId>org.apache.opennlp</groupId> + <artifactId>opennlp-grpc-api</artifactId> + <version>VERSION</version> + </dependency> + </dependencies> +``` + +# Code generation + +The Java code can be (re)generated as follows; [docker-protoc](https://github.com/namely/docker-protoc) is used to +generate the code for Java: + +```powershell +docker run -v ${PWD}:/defs namely/protoc-all -f opennlp.proto -l java -o src/main/java +``` + +Since the Java code is provided here and the corresponding JARs will be available from Maven, regenerating from the Review Comment: ```suggestion Since the Java code is provided here and the corresponding JARs will be available from Maven, regenerating from the schema is not necessary. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@opennlp.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
