feat: SITES-26526 Import Assistant service phase 1

docs/openapi/schemas.yaml

@@ -42,6 +42,7 @@ ScopeName:
   enum:
     - 'imports.write'
     - 'imports.read'
+    - 'imports.assistant'
 ImsOrganizationId:
   type: string
   example: '1234567890ABCDEF12345678@AdobeOrg'
@@ -1495,25 +1496,23 @@ BrokenBacklink:
 ImportAssistantRequest:
   type: object
   required:
-    - url
     - command
   properties:
-    url:
-      description: The URL to analyze
-      $ref: '#/URL'
     command:
-      description: Assistant command to execute. Examples are 'start', 'cleanup', 'block', 'cells'.
+      description: Assistant command to execute. Examples 'findMainContent', 'findRemovalSelectors', 'findBlockSelectors', 'findBlockCells', 'generatePageTransformation'.
       type: string
     prompt:
       description: Optional prompt to provide context for the analysis.
       type: string
     options:
-      description: Optional configuration options required by the command.
+      description: Optional configuration options required by the command.  Example 'imageUrl'
       type: object
   example:
-    url: 'https://example.com/en/page2'
-    command: 'cleanup'
+    command: 'findRemovalSelectors'
     prompt: 'breadcrumbs'
+    options: {
+      imageUrl: 'data:image/png;base64,iVBORw0KGgoAAAANS...='
+    }
 ImportAssistantResponse:
   type: object
   properties:

docs/openapi/tools-api.yaml

@@ -183,9 +183,7 @@ import-assistant:
       - import
     summary: Send a prompt to the import assistant
     description: |
-      Note: Not implemented yet.
-
-      This endpoint can be used to send prompts to the import assistant. 
+      This endpoint can be used to send prompts to the import assistant.
       Each prompt will make use of AI to analyze a URL and return
       choices in response to the request.
     operationId: processImportAssistant
@@ -202,7 +200,7 @@ import-assistant:
         schema:
           type: string
         description: |
-          Client-specific import API key.
+          Client-specific import API key with the 'imports.assistant' scope.
     responses:
       '200':
         description: Contents of the response from the import AI assistant.
@@ -227,7 +225,7 @@ api-keys:
       Note: Not implemented yet.
 
       This endpoint can be used to create a new API key with a set of scopes. The scoped API key will be
-      returned in the response only once. The scoped API key can be used to authenticate the Spacecat APIs by 
+      returned in the response only once. The scoped API key can be used to authenticate the Spacecat APIs by
       including it in the x-api-key header.
     operationId: createApiKey
     security: