Merge branch 'master' into history-preview-ignore-text-highlighting

docs/api-spec.yaml

@@ -28,7 +28,7 @@ info:
     
     For example: `x-api-key: YOUR_API_KEY`
     
-  version: 0.1.2
+  version: 0.1.3
   contact:
     name: ChangeDetection.io
     url: https://github.com/dgtlmoon/changedetection.io
@@ -65,14 +65,17 @@ tags:
       
   - name: Watch History
     description: |
-      Access historical snapshots and change data for your watches. View the complete timeline of detected changes 
-      and retrieve specific versions of monitored content for comparison and analysis.
-      View differences between snapshot versions (timestamps).
+      Get a list of timestamps of all changes detected for a watch.
       
   - name: Snapshots
     description: |
-      Retrieve individual snapshots of monitored content. Access both the processed change detection data and 
-      the raw HTML content that was captured during monitoring checks.
+      Retrieve individual text snapshot of monitored content according to the `timestamp`. The text snapshot is the HTML
+      to Text at page check time. 
+      
+      Set the query argument `html` to any value to retrieve the last HTML fetched, the system only keeps the last two 
+      (2) HTML files fetched.
+      
+      Use the Watch History API endpoint to get a list of timestamps to pass to this query.
       
   - name: Favicon
     description: |
@@ -229,6 +232,11 @@ components:
                 maxLength: 5000
             required: [operation, selector, optional_value]
           description: Browser automation steps
+        processor:
+          type: string
+          enum: [restock_diff, text_json_diff]
+          default: text_json_diff
+          description: Optional processor mode to use for change detection. Defaults to `text_json_diff` if not specified.
 
     Watch:
       allOf:
@@ -429,7 +437,15 @@ paths:
       operationId: createWatch
       tags: [Watch Management]
       summary: Create a new watch
-      description: Create a single web page change monitor (watch). Requires at least 'url' to be set.
+      description: |
+        Create a single web page change monitor (watch). Requires at least `url` to be set.
+
+        Every watch can be configured with:
+        - **Processor mode**: `processor` field (`restock_diff` or `text_json_diff` - default)
+        - **Notification settings**: `notification_urls` (array), `notification_title`, `notification_body`, `notification_format`, `notification_muted`
+        - **Tags/Groups**: `tag` (UUID string) or `tags` (array of UUIDs)
+        - **Check settings**: `time_between_check`, `paused`, `method`, `fetch_backend`
+        - **Advanced options**: `headers`, `body`, `proxy`, `browser_steps`, and more
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -447,7 +463,7 @@ paths:
           source: |
             import requests
             import json
-            
+
             headers = {
                 'x-api-key': 'YOUR_API_KEY',
                 'Content-Type': 'application/json'
@@ -459,7 +475,7 @@ paths:
                     'hours': 1
                 }
             }
-            response = requests.post('http://localhost:5000/api/v1/watch', 
+            response = requests.post('http://localhost:5000/api/v1/watch',
                                    headers=headers, json=data)
             print(response.text)
       requestBody:
@@ -649,7 +665,9 @@ paths:
       operationId: getWatchHistory
       tags: [Watch History]
       summary: Get watch history
-      description: Get a list of all historical snapshots available for a web page change monitor (watch)
+      description: | 
+        Get a list of all historical snapshots available for a web page change monitor (watch), use the key `timestamp`
+        as the query argument for fetching a single watch history snapshot.
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -689,7 +707,9 @@ paths:
       operationId: getWatchSnapshot
       tags: [Snapshots]
       summary: Get single snapshot
-      description: Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot.
+      description: | 
+        Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot.
+        Use the Watch History API to get a list of timestamps to pass.
       x-code-samples:
         - lang: 'curl'
           source: |