bartek commented on code in PR #1702:
URL: https://github.com/apache/tika/pull/1702#discussion_r1544981545


##########
tika-pipes/tika-grpc/src/main/proto/tika.proto:
##########


Review Comment:
   For your consideration @nddipiazza, I ran `buf lint` on this protobuf (as I 
am syncing it to a local repository for development purposes) and here's the 
report:
   
   ```
   services/tika/pbtika/tika.proto:29:9:Service name "Tika" should be suffixed 
with "Service".
   services/tika/pbtika/tika.proto:35:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:35:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:40:RPC request type 
"FetchAndParseRequest" should be named 
"FetchAndParseServerSideStreamingRequest" or 
"TikaFetchAndParseServerSideStreamingRequest".
   services/tika/pbtika/tika.proto:37:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:37:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:37:50:RPC request type 
"FetchAndParseRequest" should be named 
"FetchAndParseBiDirectionalStreamingRequest" or 
"TikaFetchAndParseBiDirectionalStreamingRequest".
   services/tika/pbtika/tika.proto:42:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:52:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:61:10:Field name "fetcherName" should be 
lower_snake_case, such as "fetcher_name".
   services/tika/pbtika/tika.proto:62:10:Field name "fetchKey" should be 
lower_snake_case, such as "fetch_key".
   services/tika/pbtika/tika.proto:67:10:Field name "fetchKey" should be 
lower_snake_case, such as "fetch_key".
   services/tika/pbtika/tika.proto:85:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:90:9:Field name "pageNumber" should be 
lower_snake_case, such as "page_number".
   services/tika/pbtika/tika.proto:91:9:Field name "numFetchersPerPage" should 
be lower_snake_case, such as "num_fetchers_per_page".
   services/tika/pbtika/tika.proto:95:28:Field name "getFetcherReply" should be 
lower_snake_case, such as "get_fetcher_reply".
   Generating protobufs for ./proto/pbingest
   services/tika/pbtika/tika.proto:29:9:Service name "Tika" should be suffixed 
with "Service".
   services/tika/pbtika/tika.proto:35:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:35:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:40:RPC request type 
"FetchAndParseRequest" should be named 
"FetchAndParseServerSideStreamingRequest" or 
"TikaFetchAndParseServerSideStreamingRequest".
   services/tika/pbtika/tika.proto:37:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:37:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:37:50:RPC request type 
"FetchAndParseRequest" should be named 
"FetchAndParseBiDirectionalStreamingRequest" or 
"TikaFetchAndParseBiDirectionalStreamingRequest".
   services/tika/pbtika/tika.proto:42:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:52:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:61:10:Field name "fetcherName" should be 
lower_snake_case, such as "fetcher_name".
   services/tika/pbtika/tika.proto:62:10:Field name "fetchKey" should be 
lower_snake_case, such as "fetch_key".
   services/tika/pbtika/tika.proto:67:10:Field name "fetchKey" should be 
lower_snake_case, such as "fetch_key".
   services/tika/pbtika/tika.proto:85:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:90:9:Field name "pageNumber" should be 
lower_snake_case, such as "page_number".
   services/tika/pbtika/tika.proto:91:9:Field name "numFetchersPerPage" should 
be lower_snake_case, such as "num_fetchers_per_page".
   services/tika/pbtika/tika.proto:95:28:Field name "getFetcherReply" should be 
lower_snake_case, such as "get_fetcher_reply".
   Generating protobufs for ./services/tika/pbtika
   services/tika/pbtika/tika.proto:29:9:Service name "Tika" should be suffixed 
with "Service".
   services/tika/pbtika/tika.proto:35:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:35:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:36:40:RPC request type 
"FetchAndParseRequest" should be named 
"FetchAndParseServerSideStreamingRequest" or 
"TikaFetchAndParseServerSideStreamingRequest".
   services/tika/pbtika/tika.proto:37:3:"tika.FetchAndParseReply" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:37:3:"tika.FetchAndParseRequest" is used as 
the request or response type for multiple RPCs.
   services/tika/pbtika/tika.proto:37:50:RPC request type 
"FetchAndParseRequest" should be named 
"FetchAndParseBiDirectionalStreamingRequest" or 
"TikaFetchAndParseBiDirectionalStreamingRequest".
   services/tika/pbtika/tika.proto:42:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:52:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:61:10:Field name "fetcherName" should be 
lower_snake_case, such as "fetcher_name".
   services/tika/pbtika/tika.proto:62:10:Field name "fetchKey" should be 
lower_snake_case, such as "fetch_key".
   services/tika/pbtika/tika.proto:67:10:Field name "fetchKey" should be 
lower_snake_case, such as "fetch_key".
   services/tika/pbtika/tika.proto:85:10:Field name "fetcherClass" should be 
lower_snake_case, such as "fetcher_class".
   services/tika/pbtika/tika.proto:90:9:Field name "pageNumber" should be 
lower_snake_case, such as "page_number".
   services/tika/pbtika/tika.proto:91:9:Field name "numFetchersPerPage" should 
be lower_snake_case, such as "num_fetchers_per_page".
   services/tika/pbtika/tika.proto:95:28:Field name "getFetcherReply" should be 
lower_snake_case, such as "get_fetcher_reply".
   ```
   
   The [buf linter is pretty aggressive](https://buf.build/docs/lint/rules) but 
I appreciate it for that. Here's the rules I've set:
   
   ```
   lint:
     use:
       - DEFAULT
     except:
       - PACKAGE_VERSION_SUFFIX
       - RPC_RESPONSE_STANDARD_NAME
       - PACKAGE_DIRECTORY_MATCH
     rpc_allow_google_protobuf_empty_responses: true
   ```



-- 
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...@tika.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to