Skip to content

Commit

Permalink
add changelog
Browse files Browse the repository at this point in the history
Signed-off-by: Chenyang Ji <cyji@amazon.com>
  • Loading branch information
ansjcy committed Oct 22, 2024
1 parent 61d1f1e commit 459f89c
Show file tree
Hide file tree
Showing 3 changed files with 221 additions and 209 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added ability to pass `InlineScript` as a simple string ([#605](https://github.com/opensearch-project/opensearch-api-specification/pull/605))
- Added `config_id` and `config_id_list` to `/_plugins/_notifications/configs` query parameters ([#594](https://github.com/opensearch-project/opensearch-api-specification/pull/594))
- Added a release workflow triggered on a tag ([#635](https://github.com/opensearch-project/opensearch-api-specification/pull/635))
- Added API spec for query insights plugin ([#625](https://github.com/opensearch-project/opensearch-api-specification/pull/625))

### Changed

Expand Down
21 changes: 13 additions & 8 deletions spec/namespaces/insights.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,29 @@ info:
paths:
/_insights/top_queries:
get:
operationId: insights.getTopQueries
x-operation-group: insights
operationId: insights.top_queries.0
x-operation-group: insights.top_queries
x-version-added: '1.0'
description: Retrieves the top queries based on the given metric type (latency, CPU, or memory).
parameters:
- $ref: '#/components/parameters/type'
- $ref: '#/components/parameters/insights.top_queries::query.type'
responses:
'200':
content:
application/json:
schema:
$ref: '../schemas/query_insights._common.yaml#/components/schemas/TopQueriesResponse'
$ref: '#/components/responses/insights.top_queries@200'

components:
parameters:
type:
insights.top_queries::query.type:
name: type
in: query
required: true
description: Get top n queries by a specific metric.
schema:
type: string
enum: [cpu, latency, memory]
responses:
insights.top_queries@200:
content:
application/json:
schema:
$ref: '../schemas/insights._common.yaml#/components/schemas/TopQueriesResponse'
Loading

0 comments on commit 459f89c

Please sign in to comment.