Update Query Group API descriptions (#674)

* Update Query Group API descriptions Will have @natebower review before merging. Signed-off-by: Naarcha-AWS <[email protected]> * Add parameter descriptions Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Nov 14, 2024 · 0f40a0e · 0f40a0e
1 parent 1c46b69
commit 0f40a0e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 9 deletions.
diff --git a/spec/namespaces/wlm.yaml b/spec/namespaces/wlm.yaml
@@ -1,23 +1,23 @@
 openapi: 3.1.0
 info:
-  title: OpenSearch Workload Management Query Group API
-  description: Query group lifecycle APIs for the workload management plugin.
+  title: Workload Management Query Group API
+  description: The Query Group Lifecycle APIs create, update, and delete workload management query groups.
   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.
+      description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved.
       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.
+      description: Creates a new query group and sets the resource limits for the new query group.
       requestBody:
         $ref: '#/components/requestBodies/wlm.create_query_group'
       responses:
@@ -28,7 +28,7 @@ paths:
       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.
+      description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved.
       parameters:
         - $ref: '#/components/parameters/wlm.get_query_group::path.name'
       responses:
@@ -50,7 +50,7 @@ paths:
       operationId: wlm.delete_query_group.0
       x-operation-group: wlm.delete_query_group
       x-version-added: '2.17'
-      description: Deletes the specified QueryGroup.
+      description: Deletes the specified query group.
       parameters:
         - $ref: '#/components/parameters/wlm.delete_query_group::path.name'
       responses:
@@ -107,21 +107,21 @@ components:
     wlm.update_query_group::path.name:
       name: name
       in: path
-      description: QueryGroup name.
+      description: The name of the query group.
       schema:
         type: string
       required: true
     wlm.delete_query_group::path.name:
       name: name
       in: path
-      description: QueryGroup name.
+      description: The name of the query group.
       schema:
         type: string
       required: true
     wlm.get_query_group::path.name:
       name: name
       in: path
-      description: QueryGroup name.
+      description: The name of the query group.
       schema:
         type: string
       required: true
diff --git a/spec/schemas/wlm._common.yaml b/spec/schemas/wlm._common.yaml
@@ -10,16 +10,21 @@ components:
       type: object
       properties:
         _id:
+          description: The ID of the query group, which can be used to associate query requests with the group and enforce the group's resource limits.
           type: string
         name:
+          description: The name of the query group.
           type: string
         resiliency_mode:
+          description: The resiliency mode of the query group.
           type: string
           enum: [enforced, monitor,soft]
         updated_at:
+          description: The time at which the query group was last updated.
           type: integer
           format: int64
         resource_limits:
+          description: The resource limits for query requests in the query group.
           anyOf:
             - type: object
               properties: