Skip to content

Commit

Permalink
address comments
Browse files Browse the repository at this point in the history
Signed-off-by: Ruirui Zhang <[email protected]>
  • Loading branch information
ruai0511 committed Oct 30, 2024
1 parent 37729e4 commit a67219b
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 128 deletions.
127 changes: 0 additions & 127 deletions spec/namespaces/query_group.yaml

This file was deleted.

127 changes: 127 additions & 0 deletions spec/namespaces/wlm.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
openapi: 3.1.0
info:
title: OpenSearch Workload Management Query Group API
description: Query group lifecycle APIs for the workload management plugin.
version: 1.0.0
paths:
/_wlm/query_group:
get:
operationId: wlm.get_query_group.0
x-operation-group: wlm.get_query_group
x-version-added: '2.17'
description: Gets the specified QueryGroup or get all if no name is provided.
responses:
'200':
$ref: '#/components/responses/wlm.get_query_group@200'
put:
operationId: wlm.create_query_group.0
x-operation-group: wlm.create_query_group
x-version-added: '2.17'
description: Creates the specified query group.
requestBody:
$ref: '#/components/requestBodies/wlm.create_query_group'
responses:
'200':
$ref: '#/components/responses/wlm.create_query_group@200'
/_wlm/query_group/{name}:
get:
operationId: wlm.get_query_group.1
x-operation-group: wlm.get_query_group
x-version-added: '2.17'
description: Gets the specified QueryGroup or get all if no name is provided.
parameters:
- $ref: '#/components/parameters/wlm.get_query_group::path.name'
responses:
'200':
$ref: '#/components/responses/wlm.get_query_group@200'
put:
operationId: wlm.update_query_group.0
x-operation-group: wlm.update_query_group
x-version-added: '2.17'
description: Updates the specified query group.
parameters:
- $ref: '#/components/parameters/wlm.update_query_group::path.name'
requestBody:
$ref: '#/components/requestBodies/wlm.update_query_group'
responses:
'200':
$ref: '#/components/responses/wlm.update_query_group@200'
delete:
operationId: wlm.delete_query_group.0
x-operation-group: wlm.delete_query_group
x-version-added: '2.17'
description: Deletes the specified QueryGroup.
parameters:
- $ref: '#/components/parameters/wlm.delete_query_group::path.name'
responses:
'200':
$ref: '#/components/responses/wlm.delete_query_group@200'
components:
requestBodies:
wlm.create_query_group:
content:
application/json:
schema:
$ref: '../schemas/wlm._common.yaml#/components/schemas/QueryGroupCreate'
required: true
wlm.update_query_group:
content:
application/json:
schema:
$ref: '../schemas/wlm._common.yaml#/components/schemas/QueryGroupUpdate'
required: true
responses:
wlm.create_query_group@200:
description: ''
content:
application/json:
schema:
$ref: '../schemas/wlm._common.yaml#/components/schemas/QueryGroupResponse'
wlm.update_query_group@200:
description: ''
content:
application/json:
schema:
$ref: '../schemas/wlm._common.yaml#/components/schemas/QueryGroupResponse'
wlm.delete_query_group@200:
description: ''
content:
application/json:
schema:
type: object
properties:
acknowledged:
type: boolean
wlm.get_query_group@200:
description: ''
content:
application/json:
schema:
type: object
properties:
query_groups:
type: array
items:
$ref: '../schemas/wlm._common.yaml#/components/schemas/QueryGroupResponse'
parameters:
wlm.update_query_group::path.name:
name: name
in: path
description: QueryGroup name.
schema:
type: string
required: true
wlm.delete_query_group::path.name:
name: name
in: path
description: QueryGroup name.
schema:
type: string
required: true
wlm.get_query_group::path.name:
name: name
in: path
description: QueryGroup name.
schema:
type: string
required: true
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
$schema: ../../../../json_schemas/test_story.schema.yaml
$schema: ../../../json_schemas/test_story.schema.yaml

description: This story tests all endpoints relevant to QueryGroups, from creation to deletion.

Expand Down

0 comments on commit a67219b

Please sign in to comment.