Add File Cache API documentation #16
Open
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 PR adds comprehensive documentation for the File Cache feature in OpenSearch. The documentation includes:
getRef
method implementation across different cache classesThis documentation will help developers understand how to work with the File Cache system and manage reference counting in OpenSearch's caching mechanism. The new documentation provides clear examples and implementation details that were previously undocumented.
Location of new documentation:
opensearch/api/file-cache.md