Skip to content

Add File Cache API documentation #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dev-docs-github-app-dev[bot]
Copy link

This PR adds comprehensive documentation for the File Cache API, including:

  • Detailed API reference for retrieving file cache reference counts
  • Path parameters and example request/response formats
  • Implementation details of the file cache system
  • Usage considerations and best practices
  • Links to related documentation

The new file-cache.md documentation helps developers understand how to:

  • Monitor and debug file cache usage through reference count queries
  • Properly integrate with the file cache system
  • Understand thread-safety considerations and performance implications

Note: Documentation includes a warning about the API's internal nature and potential for future changes.

Copy link
Author

This pull request was created by AI Agent. Please review the changes and provide feedback. Context used:

                    ```json
                    {

"docsToCreate": [
{
"filePath": "opensearch/api/file-cache.md",
"branch": "main"
}
],
"docsToUpdate": [],
"relevantCodeFiles": [
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/store/remote/filecache/FileCache.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/store/remote/utils/cache/LRUCache.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/store/remote/utils/cache/RefCountedCache.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/store/remote/utils/cache/SegmentedCache.java"
},
{
"branch": "main",
"filePath": "server/src/test/java/org/opensearch/index/store/remote/filecache/FileCacheTests.java"
},
{
"branch": "main",
"filePath": "server/src/test/java/org/opensearch/index/store/remote/utils/cache/RefCountedCacheTestCase.java"
},
{
"branch": "main",
"filePath": "server/src/internalClusterTest/java/org/opensearch/index/shard/IndexShardIT.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/action/admin/indices/stats/CommonStats.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/IndexService.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/IndexSettings.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/engine/Engine.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/engine/InternalEngine.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/engine/NRTReplicationEngine.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/index/shard/IndexShard.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/rest/action/cat/RestNodesAction.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/action/bulk/BulkRequest.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/action/bulk/TransportBulkAction.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/action/bulk/TransportSingleItemBulkWriteAction.java"
},
{
"branch": "main",
"filePath": "server/src/main/java/org/opensearch/indices/NodeIndicesStats.java"
}
],
"relevantCodeRepo": "opensearch-project/OpenSearch",
"relevantDocsFiles": [
{
"filePath": "DEVELOPER_GUIDE.md",
"branch": "main"
},
{
"filePath": "API_STYLE_GUIDE.md",
"branch": "main"
}
]
}
```

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants