Improves Endpoint exceptions API content

elastic · Sep 17, 2024 · 45ab456 · 45ab456
1 parent 77fe423
commit 45ab456
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 7 deletions.
diff --git a/...tion-endpoint-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml b/...tion-endpoint-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml
@@ -8,8 +8,8 @@ paths:
       x-labels: [serverless, ess]
       x-codegen-enabled: true
       operationId: CreateEndpointList
-      summary: Creates an endpoint list
-      description: Creates an endpoint list or does nothing if the list already exists
+      summary: Create an endpoint exception list
+      description: Create an endpoint exception list, which groups endpoint exception list items. If an endpoint exception list already exists, an empty response is returned.
       responses:
         200:
           description: Successful response

diff --git a/...int-exceptions-common/api/create_endpoint_list_item/create_endpoint_list_item.schema.yaml b/...int-exceptions-common/api/create_endpoint_list_item/create_endpoint_list_item.schema.yaml
@@ -8,7 +8,8 @@ paths:
       x-labels: [serverless, ess]
       x-codegen-enabled: true
       operationId: CreateEndpointListItem
-      summary: Creates an endpoint list item
+      summary: Create an endpoint exception list item
+      description: Create an endpoint exception list item, and associate it with the endpoint exception list.
       requestBody:
         description: Exception list item's properties
         required: true

diff --git a/...int-exceptions-common/api/delete_endpoint_list_item/delete_endpoint_list_item.schema.yaml b/...int-exceptions-common/api/delete_endpoint_list_item/delete_endpoint_list_item.schema.yaml
@@ -8,7 +8,8 @@ paths:
       x-labels: [serverless, ess]
       x-codegen-enabled: true
       operationId: DeleteEndpointListItem
-      summary: Deletes an endpoint list item
+      summary: Delete an endpoint exception list item
+      description: Delete an endpoint exception list item using the `id` or `item_id` field.
       parameters:
         - name: id
           in: query

diff --git a/...ndpoint-exceptions-common/api/find_endpoint_list_item/find_endpoint_list_item.schema.yaml b/...ndpoint-exceptions-common/api/find_endpoint_list_item/find_endpoint_list_item.schema.yaml
@@ -8,7 +8,8 @@ paths:
       x-labels: [serverless, ess]
       x-codegen-enabled: true
       operationId: FindEndpointListItems
-      summary: Finds endpoint list items
+      summary: Get endpoint exception list items
+      description: Get a list of all endpoint exception list items.
       parameters:
         - name: filter
           in: query

diff --git a/...ndpoint-exceptions-common/api/read_endpoint_list_item/read_endpoint_list_item.schema.yaml b/...ndpoint-exceptions-common/api/read_endpoint_list_item/read_endpoint_list_item.schema.yaml
@@ -8,7 +8,8 @@ paths:
       x-labels: [serverless, ess]
       x-codegen-enabled: true
       operationId: ReadEndpointListItem
-      summary: Reads an endpoint list item
+      summary: Get an endpoint exception list item
+      description: Get the details of an endpoint exception list item using the `id` or `item_id` field.
       parameters:
         - name: id
           in: query

diff --git a/...int-exceptions-common/api/update_endpoint_list_item/update_endpoint_list_item.schema.yaml b/...int-exceptions-common/api/update_endpoint_list_item/update_endpoint_list_item.schema.yaml
@@ -8,7 +8,8 @@ paths:
       x-labels: [serverless, ess]
       x-codegen-enabled: true
       operationId: UpdateEndpointListItem
-      summary: Updates an endpoint list item
+      summary: Update an endpoint exception list item
+      description: Update an endpoint exception list item using the `id` or `item_id` field.
       requestBody:
         description: Exception list item's properties
         required: true