Skip to content

Commit

Permalink
Update changelog, add periods to descriptions
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Keeler <[email protected]>
  • Loading branch information
alex-keeler committed Aug 28, 2024
1 parent b5fd740 commit 9b115b5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Fixed security spec to add support for 400 and 403s ([#439](https://github.com/opensearch-project/opensearch-api-specification/pull/439))
- Fixed required parameters in `NodeInfo` and `NodeOperatingSystemInfo` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
- Fixed query DSL `neural` field `query_image` set `contentEncoding` and `model_id` as optional ([#512](https://github.com/opensearch-project/opensearch-api-specification/pull/512))
- Fixed `knn` query specification ([#538](https://github.com/opensearch-project/opensearch-api-specification/pull/538))

### Security

Expand Down
10 changes: 6 additions & 4 deletions spec/schemas/_common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -597,16 +597,18 @@ components:
vector:
$ref: '#/components/schemas/QueryVector'
k:
description: The final number of nearest neighbors to return as top hits
description: The final number of nearest neighbors to return as top hits.
type: number
min_score:
description: The minimum similarity score for a neighbor to be considered a hit
description: The minimum similarity score for a neighbor to be considered a hit.
type: number
x-version-added: '2.14'
max_distance:
description: The maximum physical distance in vector space for a neighbor to be considered a hit
description: The maximum physical distance in vector space for a neighbor to be considered a hit.
type: number
x-version-added: '2.14'
filter:
description: Filters for the kNN search query
description: Filters for the kNN search query.
oneOf:
- $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
- type: array
Expand Down

0 comments on commit 9b115b5

Please sign in to comment.