Skip to content

Commit

Permalink
Added missing file query parameter to _cache/clear.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <dblock@amazon.com>
  • Loading branch information
dblock committed Jul 10, 2024
1 parent 046b7d1 commit ea715a8
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
10 changes: 10 additions & 0 deletions spec/namespaces/indices.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down
45 changes: 45 additions & 0 deletions tests/indices/cache.yaml
Original file line number Diff line number Diff line change
@@ -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: {}

0 comments on commit ea715a8

Please sign in to comment.