diff --git a/x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts b/x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts index c08f807d4926b..f70d521692779 100644 --- a/x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts +++ b/x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts @@ -511,7 +511,9 @@ after 30 days. It also deletes other artifacts specific to the migration impleme .catch(catchAxiosErrorFormatAndThrow); } /** - * Retrieves a clean draft timeline. If a draft timeline does not exist, it is created and returned. + * Create a clean draft Timeline or Timeline template for the current user. +> info +> If the user already has a draft Timeline, the existing draft Timeline is cleared and returned. */ async cleanDraftTimelines(props: CleanDraftTimelinesProps) { @@ -589,6 +591,9 @@ Migrations are initiated per index. While the process is neither destructive nor }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Create a new Timeline or Timeline template. + */ async createTimelines(props: CreateTimelinesProps) { this.log.info(`${new Date().toISOString()} Calling API CreateTimelines`); return this.kbnClient @@ -661,6 +666,9 @@ Migrations are initiated per index. While the process is neither destructive nor }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Delete a note from a Timeline using the note ID. + */ async deleteNote(props: DeleteNoteProps) { this.log.info(`${new Date().toISOString()} Calling API DeleteNote`); return this.kbnClient @@ -691,6 +699,9 @@ Migrations are initiated per index. While the process is neither destructive nor }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Delete one or more Timelines or Timeline templates. + */ async deleteTimelines(props: DeleteTimelinesProps) { this.log.info(`${new Date().toISOString()} Calling API DeleteTimelines`); return this.kbnClient @@ -1045,6 +1056,9 @@ Migrations are initiated per index. While the process is neither destructive nor }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Export Timelines as an NDJSON file. + */ async exportTimelines(props: ExportTimelinesProps) { this.log.info(`${new Date().toISOString()} Calling API ExportTimelines`); return this.kbnClient @@ -1155,6 +1169,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned. + */ async getDraftTimelines(props: GetDraftTimelinesProps) { this.log.info(`${new Date().toISOString()} Calling API GetDraftTimelines`); return this.kbnClient @@ -1221,7 +1238,7 @@ finalize it. .catch(catchAxiosErrorFormatAndThrow); } /** - * Gets notes + * Get all notes for a given document. */ async getNotes(props: GetNotesProps) { this.log.info(`${new Date().toISOString()} Calling API GetNotes`); @@ -1315,6 +1332,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Get the details of an existing saved Timeline or Timeline template. + */ async getTimeline(props: GetTimelineProps) { this.log.info(`${new Date().toISOString()} Calling API GetTimeline`); return this.kbnClient @@ -1329,6 +1349,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Get a list of all saved Timelines or Timeline templates. + */ async getTimelines(props: GetTimelinesProps) { this.log.info(`${new Date().toISOString()} Calling API GetTimelines`); return this.kbnClient @@ -1363,6 +1386,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Import Timelines. + */ async importTimelines(props: ImportTimelinesProps) { this.log.info(`${new Date().toISOString()} Calling API ImportTimelines`); return this.kbnClient @@ -1419,6 +1445,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Install or update prepackaged Timelines. + */ async installPrepackedTimelines(props: InstallPrepackedTimelinesProps) { this.log.info(`${new Date().toISOString()} Calling API InstallPrepackedTimelines`); return this.kbnClient @@ -1474,7 +1503,7 @@ finalize it. .catch(catchAxiosErrorFormatAndThrow); } /** - * Updates an existing timeline. This API is used to update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing timeline. + * Update an existing Timeline. You can update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing Timeline. */ async patchTimeline(props: PatchTimelineProps) { this.log.info(`${new Date().toISOString()} Calling API PatchTimeline`); @@ -1506,6 +1535,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Favorite a Timeline or Timeline template for the current user. + */ async persistFavoriteRoute(props: PersistFavoriteRouteProps) { this.log.info(`${new Date().toISOString()} Calling API PersistFavoriteRoute`); return this.kbnClient @@ -1519,6 +1551,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Add a note to a Timeline or update an existing note. + */ async persistNoteRoute(props: PersistNoteRouteProps) { this.log.info(`${new Date().toISOString()} Calling API PersistNoteRoute`); return this.kbnClient @@ -1532,6 +1567,9 @@ finalize it. }) .catch(catchAxiosErrorFormatAndThrow); } + /** + * Pin an event to an existing Timeline. + */ async persistPinnedEventRoute(props: PersistPinnedEventRouteProps) { this.log.info(`${new Date().toISOString()} Calling API PersistPinnedEventRoute`); return this.kbnClient diff --git a/x-pack/plugins/security_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.schema.yaml index e5e9f3ed4cfc6..5e1fbff1f296d 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.schema.yaml @@ -15,13 +15,15 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: CleanDraftTimelines - summary: Retrieves a draft timeline or timeline template. + summary: Create a clean draft Timeline or Timeline template description: | - Retrieves a clean draft timeline. If a draft timeline does not exist, it is created and returned. + Create a clean draft Timeline or Timeline template for the current user. + > info + > If the user already has a draft Timeline, the existing draft Timeline is cleared and returned. tags: - access:securitySolution requestBody: - description: The type of timeline to create. Valid values are `default` and `template`. + description: The type of Timeline to create. Valid values are `default` and `template`. required: true content: application/json: @@ -33,7 +35,7 @@ paths: $ref: '../model/components.schema.yaml#/components/schemas/TimelineType' responses: '200': - description: Indicates that the draft timeline was successfully created. In the event the user already has a draft timeline, the existing draft timeline is cleared and returned. + description: Indicates that the draft Timeline was successfully created. In the event the user already has a draft Timeline, the existing draft Timeline is cleared and returned. content: application/json: schema: @@ -51,7 +53,7 @@ paths: timeline: $ref: '../model/components.schema.yaml#/components/schemas/TimelineResponse' '403': - description: Indicates that the user does not have the required permissions to create a draft timeline. + description: Indicates that the user does not have the required permissions to create a draft Timeline. content: application:json: schema: @@ -62,7 +64,7 @@ paths: status_code: type: number '409': - description: Indicates that there is already a draft timeline with the given timelineId. + description: Indicates that there is already a draft Timeline with the given `timelineId`. content: application:json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.schema.yaml index 561ce75c84fe2..9dce2658694ab 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.schema.yaml @@ -18,11 +18,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: CreateTimelines - summary: Creates a new timeline. + summary: Create a Timeline or Timeline template + description: Create a new Timeline or Timeline template. tags: - access:securitySolution requestBody: - description: The required timeline fields used to create a new timeline along with optional fields that will be created if not provided. + description: The required Timeline fields used to create a new Timeline, along with optional fields that will be created if not provided. required: true content: application/json: @@ -53,7 +54,7 @@ paths: $ref: '../model/components.schema.yaml#/components/schemas/SavedTimeline' responses: '200': - description: Indicates the timeline was successfully created. + description: Indicates the Timeline was successfully created. content: application/json: schema: @@ -70,7 +71,7 @@ paths: timeline: $ref: '../model/components.schema.yaml#/components/schemas/TimelineResponse' '405': - description: Indicates that there was an error in the timeline creation. + description: Indicates that there was an error in the Timeline creation. content: application/json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.schema.yaml index b330cc82d2fdc..02a75d4e0ac77 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.schema.yaml @@ -15,11 +15,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: DeleteNote - summary: Deletes a note from a timeline. + summary: Delete a note + description: Delete a note from a Timeline using the note ID. tags: - access:securitySolution requestBody: - description: The id of the note to delete. + description: The ID of the note to delete. required: true content: application/json: diff --git a/x-pack/plugins/security_solution/common/api/timeline/delete_timelines/delete_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/delete_timelines/delete_timelines_route.schema.yaml index 85c1b7c9a6736..7a0a168747d47 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/delete_timelines/delete_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/delete_timelines/delete_timelines_route.schema.yaml @@ -18,11 +18,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: DeleteTimelines - summary: Deletes one or more timelines or timeline templates. + summary: Delete Timelines or Timeline templates + description: Delete one or more Timelines or Timeline templates. tags: - access:securitySolution requestBody: - description: The ids of the timelines or timeline templates to delete. + description: The IDs of the Timelines or Timeline templates to delete. required: true content: application/json: @@ -41,7 +42,7 @@ paths: type: string responses: '200': - description: Indicates the timeline was successfully deleted. + description: Indicates the Timeline was successfully deleted. content: application/json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/export_timelines/export_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/export_timelines/export_timelines_route.schema.yaml index 2c0a367dc5d28..44ef7d0f3abe0 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/export_timelines/export_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/export_timelines/export_timelines_route.schema.yaml @@ -18,7 +18,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: ExportTimelines - summary: Exports timelines as an NDJSON file + summary: Export Timelines + description: Export Timelines as an NDJSON file. tags: - access:securitySolution parameters: @@ -29,7 +30,7 @@ paths: type: string description: The name of the file to export requestBody: - description: The ids of the timelines to export + description: The IDs of the Timelines to export. required: true content: application/json: @@ -43,14 +44,14 @@ paths: type: string responses: '200': - description: Indicates the timelines were successfully exported + description: Indicates the Timelines were successfully exported. content: application/ndjson: schema: type: string - description: NDJSON of the exported timelines + description: NDJSON of the exported Timelines '400': - description: Indicates that the export size limit was exceeded + description: Indicates that the export size limit was exceeded. content: application/ndjson: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.schema.yaml index c7a77af98a7f3..21cabb87cd335 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.schema.yaml @@ -15,7 +15,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: GetDraftTimelines - summary: Retrieves the draft timeline for the current user. If the user does not have a draft timeline, an empty timeline is returned. + summary: Get draft Timeline or Timeline template details + description: Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned. tags: - access:securitySolution parameters: @@ -26,7 +27,7 @@ paths: $ref: '../model/components.schema.yaml#/components/schemas/TimelineType' responses: '200': - description: Indicates that the draft timeline was successfully retrieved. + description: Indicates that the draft Timeline was successfully retrieved. content: application/json: schema: @@ -44,7 +45,7 @@ paths: timeline: $ref: '../model/components.schema.yaml#/components/schemas/TimelineResponse' '403': - description: If a draft timeline was not found and we attempted to create one, it indicates that the user does not have the required permissions to create a draft timeline. + description: If a draft Timeline was not found and we attempted to create one, it indicates that the user does not have the required permissions to create a draft Timeline. content: application:json: schema: @@ -55,7 +56,7 @@ paths: status_code: type: number '409': - description: This should never happen, but if a draft timeline was not found and we attempted to create one, it indicates that there is already a draft timeline with the given timelineId. + description: This should never happen, but if a draft Timeline was not found and we attempted to create one, it indicates that there is already a draft Timeline with the given `timelineId`. content: application:json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/get_notes/get_notes_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/get_notes/get_notes_route.schema.yaml index f2e58e2b4e729..19b5d2074d18e 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/get_notes/get_notes_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/get_notes/get_notes_route.schema.yaml @@ -15,8 +15,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: GetNotes - description: Gets notes - summary: Get all notes for a given document. + description: Get all notes for a given document. + summary: Get notes tags: - access:securitySolution parameters: diff --git a/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.gen.ts b/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.gen.ts index 77c8edb5c69b0..622545e22b37a 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.gen.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.gen.ts @@ -25,7 +25,7 @@ export const GetTimelineRequestQuery = z.object({ */ template_timeline_id: z.string().optional(), /** - * The ID of the timeline to retrieve + * The ID of the Timeline to retrieve. */ id: z.string().optional(), }); diff --git a/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.schema.yaml index 9a94bafb63a76..d0944bc0fcb10 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.schema.yaml @@ -18,7 +18,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: GetTimeline - summary: Get an existing saved timeline or timeline template. This API is used to retrieve an existing saved timeline or timeline template. + summary: Get Timeline or Timeline template details + description: Get the details of an existing saved Timeline or Timeline template. tags: - access:securitySolution parameters: @@ -31,10 +32,10 @@ paths: name: id schema: type: string - description: The ID of the timeline to retrieve + description: The ID of the Timeline to retrieve. responses: '200': - description: Indicates that the (template) timeline was found and returned. + description: Indicates that the (template) Timeline was found and returned. content: application/json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/get_timelines/get_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/get_timelines/get_timelines_route.schema.yaml index 189865a9344d4..f889af73e10d7 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/get_timelines/get_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/get_timelines/get_timelines_route.schema.yaml @@ -18,7 +18,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: GetTimelines - summary: This API is used to retrieve a list of existing saved timelines or timeline templates. + summary: Get Timelines or Timeline templates + description: Get a list of all saved Timelines or Timeline templates. tags: - access:securitySolution parameters: @@ -69,7 +70,7 @@ paths: nullable: true responses: '200': - description: Indicates that the (template) timelines were found and returned. + description: Indicates that the (template) Timelines were found and returned. content: application/json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/import_timelines/import_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/import_timelines/import_timelines_route.schema.yaml index 9925ae10322e6..34a35aa59db0e 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/import_timelines/import_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/import_timelines/import_timelines_route.schema.yaml @@ -18,11 +18,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: ImportTimelines - summary: Imports timelines. + summary: Import Timelines + description: Import Timelines. tags: - access:securitySolution requestBody: - description: The timelines to import as a readable stream. + description: The Timelines to import as a readable stream. required: true content: application/json: @@ -50,7 +51,7 @@ paths: - 'false' responses: '200': - description: Indicates the import of timelines was successful. + description: Indicates the import of Timelines was successful. content: application/json: schema: @@ -61,7 +62,7 @@ paths: $ref: '../model/components.schema.yaml#/components/schemas/ImportTimelineResult' '400': - description: Indicates the import of timelines was unsuccessful because of an invalid file extension. + description: Indicates the import of Timelines was unsuccessful because of an invalid file extension. content: application/json: schema: @@ -86,7 +87,7 @@ paths: statusCode: type: number '409': - description: Indicates the import of timelines was unsuccessful. + description: Indicates the import of Timelines was unsuccessful. content: application/json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/install_prepackaged_timelines/install_prepackaged_timelines_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/install_prepackaged_timelines/install_prepackaged_timelines_route.schema.yaml index af96bbeb9c6d2..7dfa5afbbe5ed 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/install_prepackaged_timelines/install_prepackaged_timelines_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/install_prepackaged_timelines/install_prepackaged_timelines_route.schema.yaml @@ -15,11 +15,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: InstallPrepackedTimelines - summary: Installs prepackaged timelines. + summary: Install prepackaged Timelines + description: Install or update prepackaged Timelines. tags: - access:securitySolution requestBody: - description: The timelines to install or update. + description: The Timelines to install or update. required: true content: application/json: @@ -43,7 +44,7 @@ paths: $ref: '../model/components.schema.yaml#/components/schemas/SavedTimeline' responses: '200': - description: Indicates the installation of prepackaged timelines was successful. + description: Indicates the installation of prepackaged Timelines was successful. content: application/json: schema: @@ -53,7 +54,7 @@ paths: data: $ref: '../model/components.schema.yaml#/components/schemas/ImportTimelineResult' '500': - description: Indicates the installation of prepackaged timelines was unsuccessful. + description: Indicates the installation of prepackaged Timelines was unsuccessful. content: application:json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/patch_timelines/patch_timeline_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/patch_timelines/patch_timeline_route.schema.yaml index 04d6de3cc3f87..31ff7d8312673 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/patch_timelines/patch_timeline_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/patch_timelines/patch_timeline_route.schema.yaml @@ -15,12 +15,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: PatchTimeline - summary: Updates an existing timeline. - description: Updates an existing timeline. This API is used to update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing timeline. + summary: Update a Timeline + description: Update an existing Timeline. You can update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing Timeline. tags: - access:securitySolution requestBody: - description: The timeline updates along with the timeline ID and version. + description: The Timeline updates, along with the Timeline ID and version. required: true content: application/json: @@ -38,7 +38,7 @@ paths: $ref: '../model/components.schema.yaml#/components/schemas/SavedTimeline' responses: '200': - description: Indicates that the draft timeline was successfully created. In the event the user already has a draft timeline, the existing draft timeline is cleared and returned. + description: Indicates that the draft Timeline was successfully created. In the event the user already has a draft Timeline, the existing draft Timeline is cleared and returned. content: application/json: schema: @@ -56,7 +56,7 @@ paths: timeline: $ref: '../model/components.schema.yaml#/components/schemas/TimelineResponse' '405': - description: Indicates that the user does not have the required access to create a draft timeline. + description: Indicates that the user does not have the required access to create a draft Timeline. content: application/json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/persist_favorite/persist_favorite_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/persist_favorite/persist_favorite_route.schema.yaml index 87a9e4d21ac68..9ad4d03901d70 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/persist_favorite/persist_favorite_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/persist_favorite/persist_favorite_route.schema.yaml @@ -15,11 +15,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: PersistFavoriteRoute - summary: Persists a given users favorite status of a timeline. + summary: Favorite a Timeline or Timeline template + description: Favorite a Timeline or Timeline template for the current user. tags: - access:securitySolution requestBody: - description: The required fields used to favorite a (template) timeline. + description: The required fields used to favorite a (template) Timeline. required: true content: application/json: diff --git a/x-pack/plugins/security_solution/common/api/timeline/persist_note/persist_note_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/persist_note/persist_note_route.schema.yaml index e5de10d97e013..41ae12c974d6f 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/persist_note/persist_note_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/persist_note/persist_note_route.schema.yaml @@ -18,11 +18,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: PersistNoteRoute - summary: Persists a note to a timeline. + summary: Add or update a note + description: Add a note to a Timeline or update an existing note. tags: - access:securitySolution requestBody: - description: The note to persist or update along with additional metadata. + description: The note to add or update, along with additional metadata. required: true content: application/json: diff --git a/x-pack/plugins/security_solution/common/api/timeline/pinned_events/pinned_events_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/pinned_events/pinned_events_route.schema.yaml index dd16dda4f273c..de6ff200257c4 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/pinned_events/pinned_events_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/pinned_events/pinned_events_route.schema.yaml @@ -18,11 +18,12 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: PersistPinnedEventRoute - summary: Persists a pinned event to a timeline. + summary: Pin an event + description: Pin an event to an existing Timeline. tags: - access:securitySolution requestBody: - description: The pinned event to persist or update along with additional metadata. + description: The pinned event to add or update, along with additional metadata. required: true content: application/json: @@ -39,7 +40,7 @@ paths: type: string responses: '200': - description: Indicate the event was successfully pinned in the timeline. + description: Indicates the event was successfully pinned to the Timeline. content: application/json: schema: diff --git a/x-pack/plugins/security_solution/common/api/timeline/resolve_timeline/resolve_timeline_route.schema.yaml b/x-pack/plugins/security_solution/common/api/timeline/resolve_timeline/resolve_timeline_route.schema.yaml index 6c2b0d309f01f..ee26ac4a97896 100644 --- a/x-pack/plugins/security_solution/common/api/timeline/resolve_timeline/resolve_timeline_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/timeline/resolve_timeline/resolve_timeline_route.schema.yaml @@ -15,7 +15,7 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: ResolveTimeline - summary: Get an existing saved timeline or timeline template. + summary: Get an existing saved Timeline or Timeline template tags: - access:securitySolution parameters: @@ -31,7 +31,7 @@ paths: description: The ID of the timeline to resolve responses: '200': - description: The (template) timeline has been found + description: The (template) Timeline has been found content: application/json: schema: @@ -48,4 +48,4 @@ paths: '400': description: The request is missing parameters '404': - description: The (template) timeline was not found + description: The (template) Timeline was not found diff --git a/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_timeline_api_2023_10_31.bundled.schema.yaml b/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_timeline_api_2023_10_31.bundled.schema.yaml index e658a2df0284c..c5aa5c5385521 100644 --- a/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_timeline_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_timeline_api_2023_10_31.bundled.schema.yaml @@ -15,6 +15,7 @@ servers: paths: /api/note: delete: + description: Delete a note from a Timeline using the note ID. operationId: DeleteNote requestBody: content: @@ -37,7 +38,7 @@ paths: type: array required: - noteIds - description: The id of the note to delete. + description: The ID of the note to delete. required: true responses: '200': @@ -49,12 +50,12 @@ paths: data: type: object description: Indicates the note was successfully deleted. - summary: Deletes a note from a timeline. + summary: Delete a note tags: - Security Solution Timeline API - 'access:securitySolution' get: - description: Gets notes + description: Get all notes for a given document. operationId: GetNotes parameters: - in: query @@ -95,11 +96,12 @@ paths: responses: '200': description: Indicates the requested notes were returned. - summary: Get all notes for a given document. + summary: Get notes tags: - Security Solution Timeline API - 'access:securitySolution' patch: + description: Add a note to a Timeline or update an existing note. operationId: PersistNoteRoute requestBody: content: @@ -129,7 +131,7 @@ paths: type: string required: - note - description: The note to persist or update along with additional metadata. + description: 'The note to add or update, along with additional metadata.' required: true responses: '200': @@ -159,12 +161,13 @@ paths: required: - data description: Indicates the note was successfully created. - summary: Persists a note to a timeline. + summary: Add or update a note tags: - Security Solution Timeline API - 'access:securitySolution' /api/pinned_event: patch: + description: Pin an event to an existing Timeline. operationId: PersistPinnedEventRoute requestBody: content: @@ -182,7 +185,7 @@ paths: required: - eventId - timelineId - description: The pinned event to persist or update along with additional metadata. + description: 'The pinned event to add or update, along with additional metadata.' required: true responses: '200': @@ -207,13 +210,14 @@ paths: - persistPinnedEventOnTimeline required: - data - description: Indicate the event was successfully pinned in the timeline. - summary: Persists a pinned event to a timeline. + description: Indicates the event was successfully pinned to the Timeline. + summary: Pin an event tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline: delete: + description: Delete one or more Timelines or Timeline templates. operationId: DeleteTimelines requestBody: content: @@ -234,7 +238,7 @@ paths: type: array required: - savedObjectIds - description: The ids of the timelines or timeline templates to delete. + description: The IDs of the Timelines or Timeline templates to delete. required: true responses: '200': @@ -252,12 +256,13 @@ paths: - deleteTimeline required: - data - description: Indicates the timeline was successfully deleted. - summary: Deletes one or more timelines or timeline templates. + description: Indicates the Timeline was successfully deleted. + summary: Delete Timelines or Timeline templates tags: - Security Solution Timeline API - 'access:securitySolution' get: + description: Get the details of an existing saved Timeline or Timeline template. operationId: GetTimeline parameters: - description: The ID of the template timeline to retrieve @@ -265,7 +270,7 @@ paths: name: template_timeline_id schema: type: string - - description: The ID of the timeline to retrieve + - description: The ID of the Timeline to retrieve. in: query name: id schema: @@ -287,18 +292,16 @@ paths: - getOneTimeline required: - data - description: Indicates that the (template) timeline was found and returned. - summary: >- - Get an existing saved timeline or timeline template. This API is used to - retrieve an existing saved timeline or timeline template. + description: Indicates that the (template) Timeline was found and returned. + summary: Get Timeline or Timeline template details tags: - Security Solution Timeline API - 'access:securitySolution' patch: description: >- - Updates an existing timeline. This API is used to update the title, - description, date range, pinned events, pinned queries, and/or pinned - saved queries of an existing timeline. + Update an existing Timeline. You can update the title, description, date + range, pinned events, pinned queries, and/or pinned saved queries of an + existing Timeline. operationId: PatchTimeline requestBody: content: @@ -318,7 +321,7 @@ paths: - timelineId - version - timeline - description: The timeline updates along with the timeline ID and version. + description: 'The Timeline updates, along with the Timeline ID and version.' required: true responses: '200': @@ -342,9 +345,9 @@ paths: required: - data description: >- - Indicates that the draft timeline was successfully created. In the - event the user already has a draft timeline, the existing draft - timeline is cleared and returned. + Indicates that the draft Timeline was successfully created. In the + event the user already has a draft Timeline, the existing draft + Timeline is cleared and returned. '405': content: application/json: @@ -357,12 +360,13 @@ paths: type: number description: >- Indicates that the user does not have the required access to create - a draft timeline. - summary: Updates an existing timeline. + a draft Timeline. + summary: Update a Timeline tags: - Security Solution Timeline API - 'access:securitySolution' post: + description: Create a new Timeline or Timeline template. operationId: CreateTimelines requestBody: content: @@ -393,7 +397,7 @@ paths: required: - timeline description: >- - The required timeline fields used to create a new timeline along with + The required Timeline fields used to create a new Timeline, along with optional fields that will be created if not provided. required: true responses: @@ -415,7 +419,7 @@ paths: - persistTimeline required: - data - description: Indicates the timeline was successfully created. + description: Indicates the Timeline was successfully created. '405': content: application/json: @@ -426,13 +430,17 @@ paths: type: string statusCode: type: number - description: Indicates that there was an error in the timeline creation. - summary: Creates a new timeline. + description: Indicates that there was an error in the Timeline creation. + summary: Create a Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_draft: get: + description: >- + Get the details of the draft Timeline or Timeline template for the + current user. If the user doesn't have a draft Timeline, an empty + Timeline is returned. operationId: GetDraftTimelines parameters: - in: query @@ -461,7 +469,7 @@ paths: - persistTimeline required: - data - description: Indicates that the draft timeline was successfully retrieved. + description: Indicates that the draft Timeline was successfully retrieved. '403': content: 'application:json': @@ -473,9 +481,9 @@ paths: status_code: type: number description: >- - If a draft timeline was not found and we attempted to create one, it + If a draft Timeline was not found and we attempted to create one, it indicates that the user does not have the required permissions to - create a draft timeline. + create a draft Timeline. '409': content: 'application:json': @@ -487,19 +495,21 @@ paths: status_code: type: number description: >- - This should never happen, but if a draft timeline was not found and + This should never happen, but if a draft Timeline was not found and we attempted to create one, it indicates that there is already a - draft timeline with the given timelineId. - summary: >- - Retrieves the draft timeline for the current user. If the user does not - have a draft timeline, an empty timeline is returned. + draft Timeline with the given `timelineId`. + summary: Get draft Timeline or Timeline template details tags: - Security Solution Timeline API - 'access:securitySolution' post: description: > - Retrieves a clean draft timeline. If a draft timeline does not exist, it - is created and returned. + Create a clean draft Timeline or Timeline template for the current user. + + > info + + > If the user already has a draft Timeline, the existing draft Timeline + is cleared and returned. operationId: CleanDraftTimelines requestBody: content: @@ -512,7 +522,7 @@ paths: required: - timelineType description: >- - The type of timeline to create. Valid values are `default` and + The type of Timeline to create. Valid values are `default` and `template`. required: true responses: @@ -537,9 +547,9 @@ paths: required: - data description: >- - Indicates that the draft timeline was successfully created. In the - event the user already has a draft timeline, the existing draft - timeline is cleared and returned. + Indicates that the draft Timeline was successfully created. In the + event the user already has a draft Timeline, the existing draft + Timeline is cleared and returned. '403': content: 'application:json': @@ -552,7 +562,7 @@ paths: type: number description: >- Indicates that the user does not have the required permissions to - create a draft timeline. + create a draft Timeline. '409': content: 'application:json': @@ -564,14 +574,15 @@ paths: status_code: type: number description: >- - Indicates that there is already a draft timeline with the given - timelineId. - summary: Retrieves a draft timeline or timeline template. + Indicates that there is already a draft Timeline with the given + `timelineId`. + summary: Create a clean draft Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_export: post: + description: Export Timelines as an NDJSON file. operationId: ExportTimelines parameters: - description: The name of the file to export @@ -591,16 +602,16 @@ paths: type: string nullable: true type: array - description: The ids of the timelines to export + description: The IDs of the Timelines to export. required: true responses: '200': content: application/ndjson: schema: - description: NDJSON of the exported timelines + description: NDJSON of the exported Timelines type: string - description: Indicates the timelines were successfully exported + description: Indicates the Timelines were successfully exported. '400': content: application/ndjson: @@ -611,13 +622,14 @@ paths: type: string statusCode: type: number - description: Indicates that the export size limit was exceeded - summary: Exports timelines as an NDJSON file + description: Indicates that the export size limit was exceeded. + summary: Export Timelines tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_favorite: patch: + description: Favorite a Timeline or Timeline template for the current user. operationId: PersistFavoriteRoute requestBody: content: @@ -642,7 +654,7 @@ paths: - templateTimelineId - templateTimelineVersion - timelineType - description: The required fields used to favorite a (template) timeline. + description: The required fields used to favorite a (template) Timeline. required: true responses: '200': @@ -674,12 +686,13 @@ paths: description: >- Indicates the user does not have the required permissions to persist the favorite status. - summary: Persists a given users favorite status of a timeline. + summary: Favorite a Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_import: post: + description: Import Timelines. operationId: ImportTimelines requestBody: content: @@ -709,7 +722,7 @@ paths: - headers required: - hapi - description: The timelines to import as a readable stream. + description: The Timelines to import as a readable stream. required: true responses: '200': @@ -722,7 +735,7 @@ paths: $ref: '#/components/schemas/ImportTimelineResult' required: - data - description: Indicates the import of timelines was successful. + description: Indicates the import of Timelines was successful. '400': content: application/json: @@ -736,7 +749,7 @@ paths: statusCode: type: number description: >- - Indicates the import of timelines was unsuccessful because of an + Indicates the import of Timelines was unsuccessful because of an invalid file extension. '404': content: @@ -763,13 +776,14 @@ paths: type: string statusCode: type: number - description: Indicates the import of timelines was unsuccessful. - summary: Imports timelines. + description: Indicates the import of Timelines was unsuccessful. + summary: Import Timelines tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_prepackaged: post: + description: Install or update prepackaged Timelines. operationId: InstallPrepackedTimelines requestBody: content: @@ -795,7 +809,7 @@ paths: - timelinesToInstall - timelinesToUpdate - prepackagedTimelines - description: The timelines to install or update. + description: The Timelines to install or update. required: true responses: '200': @@ -808,7 +822,7 @@ paths: $ref: '#/components/schemas/ImportTimelineResult' required: - data - description: Indicates the installation of prepackaged timelines was successful. + description: Indicates the installation of prepackaged Timelines was successful. '500': content: 'application:json': @@ -820,9 +834,9 @@ paths: statusCode: type: number description: >- - Indicates the installation of prepackaged timelines was + Indicates the installation of prepackaged Timelines was unsuccessful. - summary: Installs prepackaged timelines. + summary: Install prepackaged Timelines tags: - Security Solution Timeline API - 'access:securitySolution' @@ -857,17 +871,18 @@ paths: - getOneTimeline required: - data - description: The (template) timeline has been found + description: The (template) Timeline has been found '400': description: The request is missing parameters '404': - description: The (template) timeline was not found - summary: Get an existing saved timeline or timeline template. + description: The (template) Timeline was not found + summary: Get an existing saved Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timelines: get: + description: Get a list of all saved Timelines or Timeline templates. operationId: GetTimelines parameters: - description: >- @@ -953,7 +968,7 @@ paths: - customTemplateTimelineCount required: - data - description: Indicates that the (template) timelines were found and returned. + description: Indicates that the (template) Timelines were found and returned. '400': content: 'application:json': @@ -965,9 +980,7 @@ paths: statusCode: type: number description: Bad request. The user supplied invalid data. - summary: >- - This API is used to retrieve a list of existing saved timelines or - timeline templates. + summary: Get Timelines or Timeline templates tags: - Security Solution Timeline API - 'access:securitySolution' diff --git a/x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_timeline_api_2023_10_31.bundled.schema.yaml b/x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_timeline_api_2023_10_31.bundled.schema.yaml index d3b079e0551ab..144ea915b9a2f 100644 --- a/x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_timeline_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_timeline_api_2023_10_31.bundled.schema.yaml @@ -15,6 +15,7 @@ servers: paths: /api/note: delete: + description: Delete a note from a Timeline using the note ID. operationId: DeleteNote requestBody: content: @@ -37,7 +38,7 @@ paths: type: array required: - noteIds - description: The id of the note to delete. + description: The ID of the note to delete. required: true responses: '200': @@ -49,12 +50,12 @@ paths: data: type: object description: Indicates the note was successfully deleted. - summary: Deletes a note from a timeline. + summary: Delete a note tags: - Security Solution Timeline API - 'access:securitySolution' get: - description: Gets notes + description: Get all notes for a given document. operationId: GetNotes parameters: - in: query @@ -95,11 +96,12 @@ paths: responses: '200': description: Indicates the requested notes were returned. - summary: Get all notes for a given document. + summary: Get notes tags: - Security Solution Timeline API - 'access:securitySolution' patch: + description: Add a note to a Timeline or update an existing note. operationId: PersistNoteRoute requestBody: content: @@ -129,7 +131,7 @@ paths: type: string required: - note - description: The note to persist or update along with additional metadata. + description: 'The note to add or update, along with additional metadata.' required: true responses: '200': @@ -159,12 +161,13 @@ paths: required: - data description: Indicates the note was successfully created. - summary: Persists a note to a timeline. + summary: Add or update a note tags: - Security Solution Timeline API - 'access:securitySolution' /api/pinned_event: patch: + description: Pin an event to an existing Timeline. operationId: PersistPinnedEventRoute requestBody: content: @@ -182,7 +185,7 @@ paths: required: - eventId - timelineId - description: The pinned event to persist or update along with additional metadata. + description: 'The pinned event to add or update, along with additional metadata.' required: true responses: '200': @@ -207,13 +210,14 @@ paths: - persistPinnedEventOnTimeline required: - data - description: Indicate the event was successfully pinned in the timeline. - summary: Persists a pinned event to a timeline. + description: Indicates the event was successfully pinned to the Timeline. + summary: Pin an event tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline: delete: + description: Delete one or more Timelines or Timeline templates. operationId: DeleteTimelines requestBody: content: @@ -234,7 +238,7 @@ paths: type: array required: - savedObjectIds - description: The ids of the timelines or timeline templates to delete. + description: The IDs of the Timelines or Timeline templates to delete. required: true responses: '200': @@ -252,12 +256,13 @@ paths: - deleteTimeline required: - data - description: Indicates the timeline was successfully deleted. - summary: Deletes one or more timelines or timeline templates. + description: Indicates the Timeline was successfully deleted. + summary: Delete Timelines or Timeline templates tags: - Security Solution Timeline API - 'access:securitySolution' get: + description: Get the details of an existing saved Timeline or Timeline template. operationId: GetTimeline parameters: - description: The ID of the template timeline to retrieve @@ -265,7 +270,7 @@ paths: name: template_timeline_id schema: type: string - - description: The ID of the timeline to retrieve + - description: The ID of the Timeline to retrieve. in: query name: id schema: @@ -287,18 +292,16 @@ paths: - getOneTimeline required: - data - description: Indicates that the (template) timeline was found and returned. - summary: >- - Get an existing saved timeline or timeline template. This API is used to - retrieve an existing saved timeline or timeline template. + description: Indicates that the (template) Timeline was found and returned. + summary: Get Timeline or Timeline template details tags: - Security Solution Timeline API - 'access:securitySolution' patch: description: >- - Updates an existing timeline. This API is used to update the title, - description, date range, pinned events, pinned queries, and/or pinned - saved queries of an existing timeline. + Update an existing Timeline. You can update the title, description, date + range, pinned events, pinned queries, and/or pinned saved queries of an + existing Timeline. operationId: PatchTimeline requestBody: content: @@ -318,7 +321,7 @@ paths: - timelineId - version - timeline - description: The timeline updates along with the timeline ID and version. + description: 'The Timeline updates, along with the Timeline ID and version.' required: true responses: '200': @@ -342,9 +345,9 @@ paths: required: - data description: >- - Indicates that the draft timeline was successfully created. In the - event the user already has a draft timeline, the existing draft - timeline is cleared and returned. + Indicates that the draft Timeline was successfully created. In the + event the user already has a draft Timeline, the existing draft + Timeline is cleared and returned. '405': content: application/json: @@ -357,12 +360,13 @@ paths: type: number description: >- Indicates that the user does not have the required access to create - a draft timeline. - summary: Updates an existing timeline. + a draft Timeline. + summary: Update a Timeline tags: - Security Solution Timeline API - 'access:securitySolution' post: + description: Create a new Timeline or Timeline template. operationId: CreateTimelines requestBody: content: @@ -393,7 +397,7 @@ paths: required: - timeline description: >- - The required timeline fields used to create a new timeline along with + The required Timeline fields used to create a new Timeline, along with optional fields that will be created if not provided. required: true responses: @@ -415,7 +419,7 @@ paths: - persistTimeline required: - data - description: Indicates the timeline was successfully created. + description: Indicates the Timeline was successfully created. '405': content: application/json: @@ -426,13 +430,17 @@ paths: type: string statusCode: type: number - description: Indicates that there was an error in the timeline creation. - summary: Creates a new timeline. + description: Indicates that there was an error in the Timeline creation. + summary: Create a Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_draft: get: + description: >- + Get the details of the draft Timeline or Timeline template for the + current user. If the user doesn't have a draft Timeline, an empty + Timeline is returned. operationId: GetDraftTimelines parameters: - in: query @@ -461,7 +469,7 @@ paths: - persistTimeline required: - data - description: Indicates that the draft timeline was successfully retrieved. + description: Indicates that the draft Timeline was successfully retrieved. '403': content: 'application:json': @@ -473,9 +481,9 @@ paths: status_code: type: number description: >- - If a draft timeline was not found and we attempted to create one, it + If a draft Timeline was not found and we attempted to create one, it indicates that the user does not have the required permissions to - create a draft timeline. + create a draft Timeline. '409': content: 'application:json': @@ -487,19 +495,21 @@ paths: status_code: type: number description: >- - This should never happen, but if a draft timeline was not found and + This should never happen, but if a draft Timeline was not found and we attempted to create one, it indicates that there is already a - draft timeline with the given timelineId. - summary: >- - Retrieves the draft timeline for the current user. If the user does not - have a draft timeline, an empty timeline is returned. + draft Timeline with the given `timelineId`. + summary: Get draft Timeline or Timeline template details tags: - Security Solution Timeline API - 'access:securitySolution' post: description: > - Retrieves a clean draft timeline. If a draft timeline does not exist, it - is created and returned. + Create a clean draft Timeline or Timeline template for the current user. + + > info + + > If the user already has a draft Timeline, the existing draft Timeline + is cleared and returned. operationId: CleanDraftTimelines requestBody: content: @@ -512,7 +522,7 @@ paths: required: - timelineType description: >- - The type of timeline to create. Valid values are `default` and + The type of Timeline to create. Valid values are `default` and `template`. required: true responses: @@ -537,9 +547,9 @@ paths: required: - data description: >- - Indicates that the draft timeline was successfully created. In the - event the user already has a draft timeline, the existing draft - timeline is cleared and returned. + Indicates that the draft Timeline was successfully created. In the + event the user already has a draft Timeline, the existing draft + Timeline is cleared and returned. '403': content: 'application:json': @@ -552,7 +562,7 @@ paths: type: number description: >- Indicates that the user does not have the required permissions to - create a draft timeline. + create a draft Timeline. '409': content: 'application:json': @@ -564,14 +574,15 @@ paths: status_code: type: number description: >- - Indicates that there is already a draft timeline with the given - timelineId. - summary: Retrieves a draft timeline or timeline template. + Indicates that there is already a draft Timeline with the given + `timelineId`. + summary: Create a clean draft Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_export: post: + description: Export Timelines as an NDJSON file. operationId: ExportTimelines parameters: - description: The name of the file to export @@ -591,16 +602,16 @@ paths: type: string nullable: true type: array - description: The ids of the timelines to export + description: The IDs of the Timelines to export. required: true responses: '200': content: application/ndjson: schema: - description: NDJSON of the exported timelines + description: NDJSON of the exported Timelines type: string - description: Indicates the timelines were successfully exported + description: Indicates the Timelines were successfully exported. '400': content: application/ndjson: @@ -611,13 +622,14 @@ paths: type: string statusCode: type: number - description: Indicates that the export size limit was exceeded - summary: Exports timelines as an NDJSON file + description: Indicates that the export size limit was exceeded. + summary: Export Timelines tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_favorite: patch: + description: Favorite a Timeline or Timeline template for the current user. operationId: PersistFavoriteRoute requestBody: content: @@ -642,7 +654,7 @@ paths: - templateTimelineId - templateTimelineVersion - timelineType - description: The required fields used to favorite a (template) timeline. + description: The required fields used to favorite a (template) Timeline. required: true responses: '200': @@ -674,12 +686,13 @@ paths: description: >- Indicates the user does not have the required permissions to persist the favorite status. - summary: Persists a given users favorite status of a timeline. + summary: Favorite a Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_import: post: + description: Import Timelines. operationId: ImportTimelines requestBody: content: @@ -709,7 +722,7 @@ paths: - headers required: - hapi - description: The timelines to import as a readable stream. + description: The Timelines to import as a readable stream. required: true responses: '200': @@ -722,7 +735,7 @@ paths: $ref: '#/components/schemas/ImportTimelineResult' required: - data - description: Indicates the import of timelines was successful. + description: Indicates the import of Timelines was successful. '400': content: application/json: @@ -736,7 +749,7 @@ paths: statusCode: type: number description: >- - Indicates the import of timelines was unsuccessful because of an + Indicates the import of Timelines was unsuccessful because of an invalid file extension. '404': content: @@ -763,13 +776,14 @@ paths: type: string statusCode: type: number - description: Indicates the import of timelines was unsuccessful. - summary: Imports timelines. + description: Indicates the import of Timelines was unsuccessful. + summary: Import Timelines tags: - Security Solution Timeline API - 'access:securitySolution' /api/timeline/_prepackaged: post: + description: Install or update prepackaged Timelines. operationId: InstallPrepackedTimelines requestBody: content: @@ -795,7 +809,7 @@ paths: - timelinesToInstall - timelinesToUpdate - prepackagedTimelines - description: The timelines to install or update. + description: The Timelines to install or update. required: true responses: '200': @@ -808,7 +822,7 @@ paths: $ref: '#/components/schemas/ImportTimelineResult' required: - data - description: Indicates the installation of prepackaged timelines was successful. + description: Indicates the installation of prepackaged Timelines was successful. '500': content: 'application:json': @@ -820,9 +834,9 @@ paths: statusCode: type: number description: >- - Indicates the installation of prepackaged timelines was + Indicates the installation of prepackaged Timelines was unsuccessful. - summary: Installs prepackaged timelines. + summary: Install prepackaged Timelines tags: - Security Solution Timeline API - 'access:securitySolution' @@ -857,17 +871,18 @@ paths: - getOneTimeline required: - data - description: The (template) timeline has been found + description: The (template) Timeline has been found '400': description: The request is missing parameters '404': - description: The (template) timeline was not found - summary: Get an existing saved timeline or timeline template. + description: The (template) Timeline was not found + summary: Get an existing saved Timeline or Timeline template tags: - Security Solution Timeline API - 'access:securitySolution' /api/timelines: get: + description: Get a list of all saved Timelines or Timeline templates. operationId: GetTimelines parameters: - description: >- @@ -953,7 +968,7 @@ paths: - customTemplateTimelineCount required: - data - description: Indicates that the (template) timelines were found and returned. + description: Indicates that the (template) Timelines were found and returned. '400': content: 'application:json': @@ -965,9 +980,7 @@ paths: statusCode: type: number description: Bad request. The user supplied invalid data. - summary: >- - This API is used to retrieve a list of existing saved timelines or - timeline templates. + summary: Get Timelines or Timeline templates tags: - Security Solution Timeline API - 'access:securitySolution' diff --git a/x-pack/test/api_integration/services/security_solution_api.gen.ts b/x-pack/test/api_integration/services/security_solution_api.gen.ts index 6a3d0cf8f3dce..56be72871ea1c 100644 --- a/x-pack/test/api_integration/services/security_solution_api.gen.ts +++ b/x-pack/test/api_integration/services/security_solution_api.gen.ts @@ -236,7 +236,9 @@ after 30 days. It also deletes other artifacts specific to the migration impleme .send(props.body as object); }, /** - * Retrieves a clean draft timeline. If a draft timeline does not exist, it is created and returned. + * Create a clean draft Timeline or Timeline template for the current user. +> info +> If the user already has a draft Timeline, the existing draft Timeline is cleared and returned. */ cleanDraftTimelines(props: CleanDraftTimelinesProps) { @@ -289,6 +291,9 @@ Migrations are initiated per index. While the process is neither destructive nor .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .send(props.body as object); }, + /** + * Create a new Timeline or Timeline template. + */ createTimelines(props: CreateTimelinesProps) { return supertest .post('/api/timeline') @@ -333,6 +338,9 @@ Migrations are initiated per index. While the process is neither destructive nor .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .query(props.query); }, + /** + * Delete a note from a Timeline using the note ID. + */ deleteNote(props: DeleteNoteProps) { return supertest .delete('/api/note') @@ -352,6 +360,9 @@ Migrations are initiated per index. While the process is neither destructive nor .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .query(props.query); }, + /** + * Delete one or more Timelines or Timeline templates. + */ deleteTimelines(props: DeleteTimelinesProps) { return supertest .delete('/api/timeline') @@ -593,6 +604,9 @@ Migrations are initiated per index. While the process is neither destructive nor .send(props.body as object) .query(props.query); }, + /** + * Export Timelines as an NDJSON file. + */ exportTimelines(props: ExportTimelinesProps) { return supertest .post('/api/timeline/_export') @@ -664,6 +678,9 @@ finalize it. .set(ELASTIC_HTTP_VERSION_HEADER, '1') .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana'); }, + /** + * Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned. + */ getDraftTimelines(props: GetDraftTimelinesProps) { return supertest .get('/api/timeline/_draft') @@ -703,7 +720,7 @@ finalize it. .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana'); }, /** - * Gets notes + * Get all notes for a given document. */ getNotes(props: GetNotesProps) { return supertest @@ -760,6 +777,9 @@ finalize it. .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .query(props.query); }, + /** + * Get the details of an existing saved Timeline or Timeline template. + */ getTimeline(props: GetTimelineProps) { return supertest .get('/api/timeline') @@ -768,6 +788,9 @@ finalize it. .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .query(props.query); }, + /** + * Get a list of all saved Timelines or Timeline templates. + */ getTimelines(props: GetTimelinesProps) { return supertest .get('/api/timelines') @@ -790,6 +813,9 @@ finalize it. .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .query(props.query); }, + /** + * Import Timelines. + */ importTimelines(props: ImportTimelinesProps) { return supertest .post('/api/timeline/_import') @@ -826,6 +852,9 @@ finalize it. .set(ELASTIC_HTTP_VERSION_HEADER, '2023-10-31') .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana'); }, + /** + * Install or update prepackaged Timelines. + */ installPrepackedTimelines(props: InstallPrepackedTimelinesProps) { return supertest .post('/api/timeline/_prepackaged') @@ -860,7 +889,7 @@ finalize it. .send(props.body as object); }, /** - * Updates an existing timeline. This API is used to update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing timeline. + * Update an existing Timeline. You can update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing Timeline. */ patchTimeline(props: PatchTimelineProps) { return supertest @@ -882,6 +911,9 @@ finalize it. .send(props.body as object) .query(props.query); }, + /** + * Favorite a Timeline or Timeline template for the current user. + */ persistFavoriteRoute(props: PersistFavoriteRouteProps) { return supertest .patch('/api/timeline/_favorite') @@ -890,6 +922,9 @@ finalize it. .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .send(props.body as object); }, + /** + * Add a note to a Timeline or update an existing note. + */ persistNoteRoute(props: PersistNoteRouteProps) { return supertest .patch('/api/note') @@ -898,6 +933,9 @@ finalize it. .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .send(props.body as object); }, + /** + * Pin an event to an existing Timeline. + */ persistPinnedEventRoute(props: PersistPinnedEventRouteProps) { return supertest .patch('/api/pinned_event')