bartek commented on code in PR #1826:
URL: https://github.com/apache/tika/pull/1826#discussion_r1645276288
##########
tika-pipes/tika-grpc/src/main/proto/tika.proto:
##########
@@ -35,48 +35,69 @@ service Tika {
}
message SaveFetcherRequest {
+ // fetcher_id is the unique identifier for this fetcher as defined by the
user.
string fetcher_id = 1;
+ // fetcher_class is the implementation class name of the fetcher. More
details at:
+ // https://cwiki.apache.org/confluence/display/TIKA/tika-pipes
Review Comment:
I'm not sure if this is the ideal link to reference class names.
##########
tika-pipes/tika-grpc/src/main/proto/tika.proto:
##########
@@ -35,48 +35,69 @@ service Tika {
}
message SaveFetcherRequest {
+ // fetcher_id is the unique identifier for this fetcher as defined by the
user.
string fetcher_id = 1;
+ // fetcher_class is the implementation class name of the fetcher. More
details at:
+ // https://cwiki.apache.org/confluence/display/TIKA/tika-pipes
string fetcher_class = 2;
+ // fetcher_config_json are the parameters for the fetcher in stringified
JSON format.
string fetcher_config_json = 3;
}
message SaveFetcherReply {
+ // fetcher_id is the unique identifier for this fetcher as defined by the
user.
string fetcher_id = 1;
}
message FetchAndParseRequest {
+ // fetcher_id is the unique identifier of the fetcher to be used for
fetching.
string fetcher_id = 1;
+ // fetch_key is the key (eg download URL, path, etc) to be used by the
fetcher. It typically represents the location of the content to be fetched.
string fetch_key = 2;
+ // metadata_json is metadata in stringified JSON format that can be used by
the fetcher and will be echoed back during reply.
string metadata_json = 3;
}
message FetchAndParseReply {
+ // fetch_key is the key (eg download URL, path, etc) used by the fetcher.
string fetch_key = 1;
+ // fields is a collection of echoed metadata (from the request), extracted
metadata, and content.
map<string, string> fields = 2;
+ // status is ... ?? (what possible values? Is it fetcher dependent?)
Review Comment:
I left this as a ? as I am not sure what this may be. Is this a constrained
set of values? Does it vary per fetcher?
##########
tika-pipes/tika-grpc/src/main/proto/tika.proto:
##########
@@ -35,48 +35,69 @@ service Tika {
}
message SaveFetcherRequest {
+ // fetcher_id is the unique identifier for this fetcher as defined by the
user.
string fetcher_id = 1;
+ // fetcher_class is the implementation class name of the fetcher. More
details at:
+ // https://cwiki.apache.org/confluence/display/TIKA/tika-pipes
string fetcher_class = 2;
+ // fetcher_config_json are the parameters for the fetcher in stringified
JSON format.
string fetcher_config_json = 3;
}
message SaveFetcherReply {
+ // fetcher_id is the unique identifier for this fetcher as defined by the
user.
string fetcher_id = 1;
}
message FetchAndParseRequest {
+ // fetcher_id is the unique identifier of the fetcher to be used for
fetching.
string fetcher_id = 1;
+ // fetch_key is the key (eg download URL, path, etc) to be used by the
fetcher. It typically represents the location of the content to be fetched.
string fetch_key = 2;
+ // metadata_json is metadata in stringified JSON format that can be used by
the fetcher and will be echoed back during reply.
string metadata_json = 3;
}
message FetchAndParseReply {
+ // fetch_key is the key (eg download URL, path, etc) used by the fetcher.
string fetch_key = 1;
+ // fields is a collection of echoed metadata (from the request), extracted
metadata, and content.
map<string, string> fields = 2;
+ // status is ... ?? (what possible values? Is it fetcher dependent?)
string status = 3;
+ // error_message is an error message returned by the fetcher or parser in
case of an error.
string error_message = 4;
}
message DeleteFetcherRequest {
+ // fetcher_id is the unique identifier of the fetcher to be deleted.
string fetcher_id = 1;
}
message DeleteFetcherReply {
+ // success is true if the fetcher was successfully deleted.
bool success = 1;
}
message GetFetcherRequest {
+ // fetcher_id is the unique identifier of the fetcher to be obtained.
string fetcher_id = 1;
}
message GetFetcherReply {
+ // fetcher_id is the unique identifier of the obtained fetcher.
string fetcher_id = 1;
+ // fetcher_class is the implementation class name of the fetcher. More
details at:
+ // https://cwiki.apache.org/confluence/display/TIKA/tika-pipes
string fetcher_class = 2;
+ // params are the stored parameters for the fetcher.
Review Comment:
While documenting I notice we use params as a field name here but
`fetcher_config_json` when saving the fetcher. But I think this references the
same underlying resources? Clarification would be great here.
--
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
