Add time field to getStats schema in _common.yml (#803)

* Add time field to getStats schema in _common.yml Signed-off-by: hye-on <[email protected]> * Update CHANGELOG for GetStats schema changes Signed-off-by: hye-on <[email protected]> * Mark getTime as deprecated Signed-off-by: hye-on <[email protected]> * Add x-version-deprecated and x-version-added 2.19 to schema Signed-off-by: hye-on <[email protected]> --------- Signed-off-by: hye-on <[email protected]> Signed-off-by: Daniel (dB.) Doubrovkine <[email protected]> Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
opensearch-project · Jan 22, 2025 · 7c6e3b7 · 7c6e3b7
1 parent 799d046
commit 7c6e3b7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -54,6 +54,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `GET`, `POST /_plugins/_ml/tasks/_search`, `GET /_plugins/_ml/tools`, `tools/{tool_name}` ([#797](https://github.com/opensearch-project/opensearch-api-specification/pull/797))
 - Added `POST /_plugins/_ml/agents/{agent_id}/_execute`, `GET /_plugins/_ml/agents/{agent_id}`, `GET`, `POST /_plugins/_ml/agents/_search` ([#798](https://github.com/opensearch-project/opensearch-api-specification/pull/798))
 - Added a warning for test file names that don't match the API being tested ([#793](https://github.com/opensearch-project/opensearch-api-specification/pull/793))
+- Added `time` field to the `GetStats` schema in `_common.yml` ([#803](https://github.com/opensearch-project/opensearch-api-specification/pull/803))
 - Added version for `POST /_plugins/_ml/_train/{algorithm_name}`, `_predict/{algorithm_name}/{model_id}`, and `_train_predict/{algorithm_name}` ([#763](https://github.com/opensearch-project/opensearch-api-specification/pull/763))
 
 ### Removed

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -1724,6 +1724,11 @@ components:
           format: int64
         getTime:
           $ref: '#/components/schemas/Duration'
+          deprecated: true
+          x-version-deprecated: '2.19'
+        time:
+          $ref: '#/components/schemas/Duration'
+          x-version-added: '2.19'
         time_in_millis:
           $ref: '#/components/schemas/DurationValueUnitMillis'
         exists_total: