Skip to content

Commit

Permalink
admin: document query params for /v1/cloud_storage/cache/trim
Browse files Browse the repository at this point in the history
  • Loading branch information
nvartolomei committed Dec 23, 2024
1 parent 38fdff4 commit 80b8bcd
Showing 1 changed file with 17 additions and 1 deletion.
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": [
{
"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

0 comments on commit 80b8bcd

Please sign in to comment.