doc-detective-common 3.6.0-dev.1 → 3.6.0-dev.2

package/src/schemas/src_schemas/config_v3.schema.json

@@ -258,6 +258,55 @@
                 "type": "string",
                 "description": "Local path where Heretto content was downloaded. Set automatically during processing.",
                 "readOnly": true
+              },
+              "fileMapping": {
+                "type": "object",
+                "description": "Mapping of local file paths to Heretto file metadata. Set automatically during content loading.",
+                "readOnly": true,
+                "additionalProperties": {
+                  "type": "object",
+                  "properties": {
+                    "fileId": {
+                      "type": "string",
+                      "description": "The UUID of the file in Heretto."
+                    },
+                    "filePath": {
+                      "type": "string",
+                      "description": "The path of the file in Heretto."
+                    }
+                  }
+                }
+              },
+              "uploadOnChange": {
+                "type": "boolean",
+                "description": "If `true`, uploads changed screenshots and other media files back to Heretto CMS after test execution.",
+                "default": false
+              },
+              "resourceDependencies": {
+                "type": "object",
+                "description": "Mapping of Heretto file paths to their UUIDs and metadata. Set automatically during content loading by fetching ditamap resource dependencies.",
+                "readOnly": true,
+                "additionalProperties": {
+                  "type": "object",
+                  "properties": {
+                    "uuid": {
+                      "type": "string",
+                      "description": "The UUID of the file in Heretto."
+                    },
+                    "fullPath": {
+                      "type": "string",
+                      "description": "The full xmldb path of the file in Heretto."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "The file name."
+                    },
+                    "parentFolderId": {
+                      "type": "string",
+                      "description": "The UUID of the parent folder in Heretto."
+                    }
+                  }
+                }
               }
             },
             "title": "Heretto CMS integration"

package/src/schemas/src_schemas/screenshot_v3.schema.json

@@ -68,6 +68,10 @@
                 "$ref": "#/components/schemas/crop_element"
               }
             ]
+          },
+          "sourceIntegration": {
+            "description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
+            "$ref": "sourceIntegration_v3.schema.json#"
           }
         },
         "title": "Capture screenshot (detailed)"

package/src/schemas/src_schemas/sourceIntegration_v3.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "sourceIntegration",
+  "description": "Information about the source integration for a file, enabling upload of changed files back to the source CMS.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["type", "integrationName"],
+  "properties": {
+    "type": {
+      "type": "string",
+      "description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
+      "enum": ["heretto"]
+    },
+    "integrationName": {
+      "type": "string",
+      "description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
+    },
+    "fileId": {
+      "type": "string",
+      "description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
+    },
+    "filePath": {
+      "type": "string",
+      "description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
+    },
+    "contentPath": {
+      "type": "string",
+      "description": "The local path to the file that references this source. Used for resolving relative paths."
+    }
+  },
+  "examples": [
+    {
+      "type": "heretto",
+      "integrationName": "my-heretto",
+      "fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
+      "filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
+    },
+    {
+      "type": "heretto",
+      "integrationName": "my-heretto",
+      "filePath": "images/screenshot.png",
+      "contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
+    }
+  ]
+}