[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs

x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.gen.ts

@@ -54,7 +54,7 @@ export const ExecuteConnectorRequestBody = z.object({
   langSmithApiKey: z.string().optional(),
   screenContext: ScreenContext.optional(),
   /**
-   * optional system prompt, will be appended to default system prompt. Different from conversation system prompt, which is retrieved on the server
+   * System prompt, will be appended to default system prompt. Different from conversation system prompt, which is retrieved on the server
    */
   promptIds: PromptIds.optional(),
 });

x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.schema.yaml

@@ -73,7 +73,7 @@ paths:
                   $ref: '../common_attributes.schema.yaml#/components/schemas/ScreenContext'
                 promptIds:
                   $ref: '../common_attributes.schema.yaml#/components/schemas/PromptIds'
-                  description: optional system prompt, will be appended to default system prompt. Different from conversation system prompt, which is retrieved on the server
+                  description: System prompt, will be appended to default system prompt. Different from conversation system prompt, which is retrieved on the server
       responses:
         '200':
           description: Successful static response

x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.gen.ts

@@ -16,7 +16,7 @@
 
 import { z } from '@kbn/zod';
 
-import { NonEmptyString, User } from '../common_attributes.gen';
+import { NonEmptyString, NonEmptyTimestamp, User } from '../common_attributes.gen';
 import { Replacements } from '../conversations/common_attributes.gen';
 
 export type AlertSummaryBulkActionSkipReason = z.infer<typeof AlertSummaryBulkActionSkipReason>;
@@ -47,7 +47,7 @@ export type AlertSummaryResponse = z.infer<typeof AlertSummaryResponse>;
 export const AlertSummaryResponse = z.object({
   id: NonEmptyString,
   alertId: NonEmptyString,
-  timestamp: NonEmptyString.optional(),
+  timestamp: NonEmptyTimestamp.optional(),
   summary: z.string(),
   recommendedActions: z.string().optional(),
   replacements: Replacements,

x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.schema.yaml

@@ -110,7 +110,7 @@ components:
         alertId:
           $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
         'timestamp':
-          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyString'
+          $ref: '../common_attributes.schema.yaml#/components/schemas/NonEmptyTimestamp'
         summary:
           type: string
         recommendedActions:

x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/anonymization_fields/bulk_crud_anonymization_fields_route.gen.ts

@@ -16,8 +16,11 @@
 
 import { z } from '@kbn/zod';
 
-import { NonEmptyString } from '../common_attributes.gen';
+import { NonEmptyString, NonEmptyTimestamp } from '../common_attributes.gen';
 
+/**
+ * Reason why the anonymization field was not modified
+ */
 export type AnonymizationFieldsBulkActionSkipReason = z.infer<
   typeof AnonymizationFieldsBulkActionSkipReason
 >;
@@ -29,35 +32,89 @@ export type AnonymizationFieldsBulkActionSkipResult = z.infer<
   typeof AnonymizationFieldsBulkActionSkipResult
 >;
 export const AnonymizationFieldsBulkActionSkipResult = z.object({
+  /**
+   * The id of the anonymization field that was not modified
+   */
   id: z.string(),
+  /**
+   * Name of the anonymization field that was not modified
+   */
   name: z.string().optional(),
+  /**
+   * Reason why the anonymization field was not modified
+   */
   skip_reason: AnonymizationFieldsBulkActionSkipReason,
 });
 
 export type AnonymizationFieldDetailsInError = z.infer<typeof AnonymizationFieldDetailsInError>;
 export const AnonymizationFieldDetailsInError = z.object({
+  /**
+   * The id of the anonymization field
+   */
   id: z.string(),
+  /**
+   * Name of the anonymization field
+   */
   name: z.string().optional(),
 });
 
 export type NormalizedAnonymizationFieldError = z.infer<typeof NormalizedAnonymizationFieldError>;
 export const NormalizedAnonymizationFieldError = z.object({
+  /**
+   * Error message
+   */
   message: z.string(),
+  /**
+   * Status code of the response
+   */
   status_code: z.number().int(),
+  /**
+   * Error code
+   */
   err_code: z.string().optional(),
+  /**
+   * array of anonymization fields that caused the error
+   */
   anonymization_fields: z.array(AnonymizationFieldDetailsInError),
 });
 
 export type AnonymizationFieldResponse = z.infer<typeof AnonymizationFieldResponse>;
 export const AnonymizationFieldResponse = z.object({
+  /**
+   * The id of the anonymization field
+   */
   id: NonEmptyString,
-  timestamp: NonEmptyString.optional(),
+  /**
+   * Timestamp of the field creation
+   */
+  timestamp: NonEmptyTimestamp.optional(),
+  /**
+   * Field name
+   */
   field: z.string(),
+  /**
+   * Whether field is allowed to be sent to the model
+   */
   allowed: z.boolean().optional(),
+  /**
+   * Whether field is anonymized
+   */
   anonymized: z.boolean().optional(),
+  /**
+   * Timestamp of the last update
+   */
   updatedAt: z.string().optional(),
+  /**
+   * User who last updated the field
+   */
   updatedBy: z.string().optional(),
+  /**
+   * Timestamp of the creation
+   */
   createdAt: z.string().optional(),
+  /**
+   * User who created the field
+   */
   createdBy: z.string().optional(),
   /**
    * Kibana space
@@ -100,13 +157,7 @@ export const AnonymizationFieldsBulkCrudActionResponse = z.object({
 
 export type BulkActionBase = z.infer<typeof BulkActionBase>;
 export const BulkActionBase = z.object({
-  /**
-   * Query to filter anonymization fields
-   */
   query: z.string().optional(),
-  /**
-   * Array of anonymization fields IDs
-   */
   ids: z.array(z.string()).min(1).optional(),
 });
 
@@ -128,8 +179,17 @@ export type PerformAnonymizationFieldsBulkActionRequestBody = z.infer<
   typeof PerformAnonymizationFieldsBulkActionRequestBody
 >;
 export const PerformAnonymizationFieldsBulkActionRequestBody = z.object({
+  /**
+   * Object with query to filter anonymization fields and array of anonymization fields IDs
+   */
   delete: BulkActionBase.optional(),
+  /**
+   * Array of objects with anonymization fields to create
+   */
   create: z.array(AnonymizationFieldCreateProps).optional(),
+  /**
+   * Array of objects with anonymization fields to update
+   */
   update: z.array(AnonymizationFieldUpdateProps).optional(),
 });
 export type PerformAnonymizationFieldsBulkActionRequestBodyInput = z.input<