From 654610fb11276cc92743b6348aeaf61d6cf4d2b5 Mon Sep 17 00:00:00 2001 From: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Date: Wed, 18 Dec 2024 11:02:50 +0000 Subject: [PATCH] [CI] Auto-commit changed files from 'make api-docs' --- oas_docs/output/kibana.yaml | 69 ++++++++++++++++++++++++++----------- 1 file changed, 49 insertions(+), 20 deletions(-) diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index a78e7066126df..07824e626fd40 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -15733,6 +15733,10 @@ paths: - Fleet uninstall tokens /api/lists: delete: + description: | + Delete a list using the list ID. + > info + > When you delete a list, all of its list items are also deleted. operationId: DeleteList parameters: - description: List's `id` value @@ -15792,10 +15796,11 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Deletes a list + summary: Delete a list tags: - Security Lists API get: + description: Get the details of a list using the list ID. operationId: ReadList parameters: - description: List's `id` value @@ -15843,10 +15848,11 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Retrieves a list using its id field + summary: Get list details tags: - Security Lists API patch: + description: Update specific fields of an existing list using the list ID. operationId: PatchList requestBody: content: @@ -15910,10 +15916,11 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Patches a list + summary: Patch a list tags: - Security Lists API post: + description: Create a new list. operationId: CreateList requestBody: content: @@ -15984,10 +15991,14 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Creates a list + summary: Create a list tags: - Security Lists API put: + description: | + Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted. + > info + > You cannot modify the `id` value. operationId: UpdateList requestBody: content: @@ -16053,11 +16064,12 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Updates a list + summary: Update a list tags: - Security Lists API /api/lists/_find: get: + description: Get a paginated subset of lists. By default, the first page is returned, with 20 results per page. operationId: FindLists parameters: - description: The page number to return @@ -16159,11 +16171,12 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Finds lists + summary: Get lists tags: - Security Lists API /api/lists/index: delete: + description: Delete the `.lists` and `.items` data streams. operationId: DeleteListIndex responses: '200': @@ -16209,10 +16222,11 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Deletes list data streams + summary: Delete list data streams tags: - Security Lists API get: + description: Verify that `.lists` and `.items` data streams exist. operationId: ReadListIndex responses: '200': @@ -16261,10 +16275,11 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Get list data stream existence status + summary: Get status of list data streams tags: - Security Lists API post: + description: Create `.lists` and `.items` data streams in the relevant space. operationId: CreateListIndex responses: '200': @@ -16310,11 +16325,12 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Creates necessary list data streams + summary: Create list data streams tags: - Security Lists API /api/lists/items: delete: + description: Delete a list item using its `id`, or its `list_id` and `value` fields. operationId: DeleteListItem parameters: - description: Required if `list_id` and `value` are not specified @@ -16389,10 +16405,11 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Deletes a list item + summary: Delete a list item tags: - Security Lists API get: + description: Get the details of a list item. operationId: ReadListItem parameters: - description: Required if `list_id` and `value` are not specified @@ -16456,10 +16473,11 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Gets a list item + summary: Get a list item tags: - Security Lists API patch: + description: Update specific fields of an existing list item using the list item ID. operationId: PatchListItem requestBody: content: @@ -16525,10 +16543,16 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Patches a list item + summary: Patch a list item tags: - Security Lists API post: + description: | + Create a list item and associate it with the specified list. + + All list items in the same list must be the same type. For example, each list item in an `ip` list must define a specific IP address. + > info + > Before creating a list item, you must create a list. operationId: CreateListItem requestBody: content: @@ -16595,10 +16619,14 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Creates a list item + summary: Create a list item tags: - Security Lists API put: + description: | + Update a list item using the list item ID. The original list item is replaced, and all unspecified fields are deleted. + > info + > You cannot modify the `id` value. operationId: UpdateListItem requestBody: content: @@ -16658,12 +16686,12 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Updates a list item + summary: Update a list item tags: - Security Lists API /api/lists/items/_export: post: - description: Exports list item values from the specified list + description: Export list item values from the specified list. operationId: ExportListItems parameters: - description: List's id to export @@ -16713,11 +16741,12 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Exports list items + summary: Export list items tags: - Security Lists API /api/lists/items/_find: get: + description: Get all list items in the specified list. operationId: FindListItems parameters: - description: List's id @@ -16825,13 +16854,13 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Finds list items + summary: Get list items tags: - Security Lists API /api/lists/items/_import: post: description: | - Imports a list of items from a `.txt` or `.csv` file. The maximum file size is 9 million bytes. + Import list items from a TXT or CSV file. The maximum file size is 9 million bytes. You can import items to a new or existing list. operationId: ImportListItems @@ -16924,7 +16953,7 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Imports list items + summary: Import list items tags: - Security Lists API /api/lists/privileges: @@ -16974,7 +17003,7 @@ paths: schema: $ref: '#/components/schemas/Security_Lists_API_SiemErrorResponse' description: Internal server error response - summary: Gets list privileges + summary: Get list privileges tags: - Security Lists API /api/ml/saved_objects/sync: