Document Tika proto#1826
Closed
bartek wants to merge 1 commit into
Closed
Conversation
bartek
commented
Jun 19, 2024
| // 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 |
Author
There was a problem hiding this comment.
I'm not sure if this is the ideal link to reference class names.
| 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?) |
Author
There was a problem hiding this 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?
| // 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. |
Author
There was a problem hiding this 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.
Contributor
|
incorporated changes in grpc branch |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds documentation to the Tika protobuf, specifically on the fields which may be ambiguous at initial glance.
Thanks for your contribution to Apache Tika! Your help is appreciated!