Skip to content
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

admin: document query params for /v1/cloud_storage/cache/trim #24632

Merged
merged 1 commit into from
Jan 3, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/v/redpanda/admin/api-doc/shadow_indexing.json
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,25 @@
{
"method": "POST",
"summary": "Invoke trimming on the local cache of tiered storage objects",
"description": "This operation will trim the local cache of tiered storage objects. If no parameters are included, this endpoint by default trims the cache to the maximum cache size given by the cluster config. Use the 'bytes' and 'objects' parameters to specify the number of bytes and objects to retain in the cache.",
"operationId": "cloud_storage_cache_trim",
"nickname": "post_cloud_storage_cache_trim",
"parameters": []
"parameters": [
nvartolomei marked this conversation as resolved.
Show resolved Hide resolved
{
"name": "objects",
"in": "query",
"required": false,
"type": "integer",
"description": "Target number of objects to retain in the cache"
},
{
"name": "bytes",
"in": "query",
"required": false,
"type": "integer",
"description": "Target number of bytes to retain in the cache"
}
]
}
]
},
Expand Down
Loading