Skip to content

Commit b88fe06

Browse files
hye-onXtansia
andauthored
Fixed swapped schema references in nodes info API buffer fields (#808)
* Fixed swapped schema references in nodes info API buffer fields Signed-off-by: hye-on <[email protected]> * Add version specific schema handling for total_indexing_buffer and total_indexing_buffer_in_bytes fields Signed-off-by: hye-on <[email protected]> * Fix version number format in nodes.info.yaml Signed-off-by: hye-on <[email protected]> * Remove version tags and add notes for schema changes Signed-off-by: hye-on <[email protected]> * Revert "Remove version tags and add notes for schema changes" This reverts commit 1622f24. Signed-off-by: Thomas Farr <[email protected]> --------- Signed-off-by: hye-on <[email protected]> Signed-off-by: Thomas Farr <[email protected]> Co-authored-by: Thomas Farr <[email protected]>
1 parent 439bf38 commit b88fe06

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
123123
- Fixed FilterQueryRequestProcessor to use correct query type ([#821](https://github.com/opensearch-project/opensearch-api-specification/pull/821))
124124
- Fixed `knn.train_model`'s request body `method` field to accept an object rather than a string ([#814](https://github.com/opensearch-project/opensearch-api-specification/pull/814))
125125
- Fixed REST status codes for RBAC and provisioning for Flow Framework plugin ([#842](https://github.com/opensearch-project/opensearch-api-specification/pull/842))
126+
- Fixed swapped schema references in nodes info API buffer fields([#808](https://github.com/opensearch-project/opensearch-api-specification/pull/808))
126127

127128
### Changed
128129
- Changed `tasks._common:TaskInfo` and `tasks._common:TaskGroup` to be composed of a `tasks._common:TaskInfoBase` ([#683](https://github.com/opensearch-project/opensearch-api-specification/pull/683))

spec/schemas/nodes.info.yaml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,19 @@ components:
6464
type: object
6565
additionalProperties:
6666
$ref: '#/components/schemas/NodeThreadPoolInfo'
67-
# NOTE: total_indexing_buffer and total_indexing_buffer_in_bytes inverted according to the standard pattern, this is a bug: https://github.com/opensearch-project/OpenSearch/issues/16910
6867
total_indexing_buffer:
6968
description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.
70-
$ref: '_common.yaml#/components/schemas/ByteCount'
69+
oneOf:
70+
- $ref: '_common.yaml#/components/schemas/ByteCount'
71+
x-version-removed: '3.0'
72+
- $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
73+
x-version-added: '3.0'
7174
total_indexing_buffer_in_bytes:
72-
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
75+
oneOf:
76+
- $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
77+
x-version-removed: '3.0'
78+
- $ref: '_common.yaml#/components/schemas/ByteCount'
79+
x-version-added: '3.0'
7380
transport:
7481
$ref: '#/components/schemas/NodeInfoTransport'
7582
transport_address:

0 commit comments

Comments
 (0)