diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c684781..db0506d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,7 +34,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Added a linter for parameter sorting ([#369](https://github.com/opensearch-project/opensearch-api-specification/pull/369)) - Added support for `application/cbor` responses ([#371](https://github.com/opensearch-project/opensearch-api-specification/pull/371)) - Added support for `application/smile` responses ([#386](https://github.com/opensearch-project/opensearch-api-specification/pull/386)) - +- Added `file` to `/_cache/clear` and `/{index}/_cache/clear` ([#396](https://github.com/opensearch-project/opensearch-api-specification/pull/396)) + ### Changed - Replaced Smithy with a native OpenAPI spec ([#189](https://github.com/opensearch-project/opensearch-api-specification/issues/189)) diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index 2bda325d..a4b909b4 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -112,6 +112,7 @@ paths: - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.file' - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache::query.index' - $ref: '#/components/parameters/indices.clear_cache::query.query' @@ -1160,6 +1161,7 @@ paths: - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.file' - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache::query.index' - $ref: '#/components/parameters/indices.clear_cache::query.query' @@ -2763,6 +2765,14 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form + indices.clear_cache::query.file: + in: query + name: file + description: If true, clears the unused entries from the file cache on nodes with the Search role. + schema: + type: boolean + default: false + style: form indices.clear_cache::query.ignore_unavailable: in: query name: ignore_unavailable diff --git a/tests/indices/cache.yaml b/tests/indices/cache.yaml new file mode 100644 index 00000000..ee57d1df --- /dev/null +++ b/tests/indices/cache.yaml @@ -0,0 +1,45 @@ +$schema: ../../json_schemas/test_story.schema.yaml + +description: Test index clear cache. +prologues: + - path: /movies + method: PUT + - path: /games + method: PUT +epilogues: + - path: /movies + method: DELETE + status: [200, 404] + - path: /games + method: DELETE + status: [200, 404] +chapters: + - synopsis: Clear all cache (POST). + path: /_cache/clear + method: POST + parameters: + allow_no_indices: true + expand_wildcards: none + fielddata: true + fields: '*' + file: false + index: + - movies + ignore_unavailable: true + query: true + request: true + response: + status: 200 + payload: + _shards: {} + - synopsis: Clear index cache (POST). + path: /{index}/_cache/clear + method: POST + parameters: + index: + - movies + - games + response: + status: 200 + payload: + _shards: {}