0.50.11

.github/workflows/test-only.yml

@@ -15,6 +15,10 @@ jobs:
           ruff check . --select E9,F63,F7,F82
           # Complete check with errors treated as warnings
           ruff check . --exit-zero
+      - name: Validate OpenAPI spec
+        run: |
+          pip install openapi-spec-validator
+          python3 -c "from openapi_spec_validator import validate_spec; import yaml; validate_spec(yaml.safe_load(open('docs/api-spec.yaml')))"
 
   test-application-3-10:
     needs: lint-code

Dockerfile

@@ -5,7 +5,6 @@ ARG PYTHON_VERSION=3.11
 FROM python:${PYTHON_VERSION}-slim-bookworm AS builder
 
 # See `cryptography` pin comment in requirements.txt
-ARG CRYPTOGRAPHY_DONT_BUILD_RUST=1
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
     g++ \
@@ -17,6 +16,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     libxslt-dev \
     make \
     patch \
+    pkg-config \
     zlib1g-dev
 
 RUN mkdir /install
@@ -26,6 +26,14 @@ COPY requirements.txt /requirements.txt
 
 # Use cache mounts and multiple wheel sources for faster ARM builds
 ENV PIP_CACHE_DIR=/tmp/pip-cache
+# Help Rust find OpenSSL for cryptography package compilation on ARM
+ENV PKG_CONFIG_PATH="/usr/lib/pkgconfig:/usr/lib/arm-linux-gnueabihf/pkgconfig:/usr/lib/aarch64-linux-gnu/pkgconfig"
+ENV PKG_CONFIG_ALLOW_SYSTEM_CFLAGS=1
+ENV OPENSSL_DIR="/usr"
+ENV OPENSSL_LIB_DIR="/usr/lib/arm-linux-gnueabihf"
+ENV OPENSSL_INCLUDE_DIR="/usr/include/openssl"
+# Additional environment variables for cryptography Rust build
+ENV CRYPTOGRAPHY_DONT_BUILD_RUST=1
 RUN --mount=type=cache,target=/tmp/pip-cache \
     pip install \
     --extra-index-url https://www.piwheels.org/simple \

changedetectionio/__init__.py

@@ -2,7 +2,7 @@
 
 # Read more https://github.com/dgtlmoon/changedetection.io/wiki
 
-__version__ = '0.50.10'
+__version__ = '0.50.11'
 
 from changedetectionio.strtobool import strtobool
 from json.decoder import JSONDecodeError

changedetectionio/api/Import.py

@@ -3,7 +3,7 @@ from changedetectionio.strtobool import strtobool
 from flask_restful import abort, Resource
 from flask import request
 import validators
-from . import auth
+from . import auth, validate_openapi_request
 
 
 class Import(Resource):
@@ -12,6 +12,7 @@ class Import(Resource):
         self.datastore = kwargs['datastore']
 
     @auth.check_token
+    @validate_openapi_request('importWatches')
     def post(self):
         """Import a list of watched URLs."""
 

changedetectionio/api/Notifications.py

@@ -1,9 +1,7 @@
 from flask_expects_json import expects_json
-from flask_restful import Resource
+from flask_restful import Resource, abort
-from . import auth
-from flask_restful import abort, Resource
 from flask import request
-from . import auth
+from . import auth, validate_openapi_request
 from . import schema_create_notification_urls, schema_delete_notification_urls
 
 class Notifications(Resource):
@@ -12,6 +10,7 @@ class Notifications(Resource):
         self.datastore = kwargs['datastore']
 
     @auth.check_token
+    @validate_openapi_request('getNotifications')
     def get(self):
         """Return Notification URL List."""
 
@@ -22,6 +21,7 @@ class Notifications(Resource):
                }, 200
     
     @auth.check_token
+    @validate_openapi_request('addNotifications')
     @expects_json(schema_create_notification_urls)
     def post(self):
         """Create Notification URLs."""
@@ -49,6 +49,7 @@ class Notifications(Resource):
         return {'notification_urls': added_urls}, 201
     
     @auth.check_token
+    @validate_openapi_request('replaceNotifications')
     @expects_json(schema_create_notification_urls)
     def put(self):
         """Replace Notification URLs."""
@@ -71,6 +72,7 @@ class Notifications(Resource):
         return {'notification_urls': clean_urls}, 200
         
     @auth.check_token
+    @validate_openapi_request('deleteNotifications')
     @expects_json(schema_delete_notification_urls)
     def delete(self):
         """Delete Notification URLs."""

changedetectionio/api/Search.py

@@ -1,6 +1,6 @@
 from flask_restful import Resource, abort
 from flask import request
-from . import auth
+from . import auth, validate_openapi_request
 
 class Search(Resource):
     def __init__(self, **kwargs):
@@ -8,6 +8,7 @@ class Search(Resource):
         self.datastore = kwargs['datastore']
 
     @auth.check_token
+    @validate_openapi_request('searchWatches')
     def get(self):
         """Search for watches by URL or title text."""
         query = request.args.get('q', '').strip()

changedetectionio/api/SystemInfo.py

@@ -1,5 +1,5 @@
 from flask_restful import Resource
-from . import auth
+from . import auth, validate_openapi_request
 
 
 class SystemInfo(Resource):
@@ -9,6 +9,7 @@ class SystemInfo(Resource):
         self.update_q = kwargs['update_q']
 
     @auth.check_token
+    @validate_openapi_request('getSystemInfo')
     def get(self):
         """Return system info."""
         import time

changedetectionio/api/Tags.py

@@ -7,7 +7,7 @@ from flask import request
 from . import auth
 
 # Import schemas from __init__.py
-from . import schema_tag, schema_create_tag, schema_update_tag
+from . import schema_tag, schema_create_tag, schema_update_tag, validate_openapi_request
 
 
 class Tag(Resource):
@@ -19,6 +19,7 @@ class Tag(Resource):
     # Get information about a single tag
     # curl http://localhost:5000/api/v1/tag/<string:uuid>
     @auth.check_token
+    @validate_openapi_request('getTag')
     def get(self, uuid):
         """Get data for a single tag/group, toggle notification muting, or recheck all."""
         from copy import deepcopy
@@ -50,6 +51,7 @@ class Tag(Resource):
         return tag
 
     @auth.check_token
+    @validate_openapi_request('deleteTag')
     def delete(self, uuid):
         """Delete a tag/group and remove it from all watches."""
         if not self.datastore.data['settings']['application']['tags'].get(uuid):
@@ -66,6 +68,7 @@ class Tag(Resource):
         return 'OK', 204
 
     @auth.check_token
+    @validate_openapi_request('updateTag')
     @expects_json(schema_update_tag)
     def put(self, uuid):
         """Update tag information."""
@@ -80,6 +83,7 @@ class Tag(Resource):
 
 
     @auth.check_token
+    @validate_openapi_request('createTag')
     # Only cares for {'title': 'xxxx'}
     def post(self):
         """Create a single tag/group."""
@@ -100,6 +104,7 @@ class Tags(Resource):
         self.datastore = kwargs['datastore']
 
     @auth.check_token
+    @validate_openapi_request('listTags')
     def get(self):
         """List tags/groups."""
         result = {}

changedetectionio/api/Watch.py

@@ -11,7 +11,7 @@ from . import auth
 import copy
 
 # Import schemas from __init__.py
-from . import schema, schema_create_watch, schema_update_watch
+from . import schema, schema_create_watch, schema_update_watch, validate_openapi_request
 
 
 class Watch(Resource):
@@ -25,6 +25,7 @@ class Watch(Resource):
     # @todo - version2 - ?muted and ?paused should be able to be called together, return the watch struct not "OK"
     # ?recheck=true
     @auth.check_token
+    @validate_openapi_request('getWatch')
     def get(self, uuid):
         """Get information about a single watch, recheck, pause, or mute."""
         from copy import deepcopy
@@ -57,6 +58,7 @@ class Watch(Resource):
         return watch
 
     @auth.check_token
+    @validate_openapi_request('deleteWatch')
     def delete(self, uuid):
         """Delete a watch and related history."""
         if not self.datastore.data['watching'].get(uuid):
@@ -66,6 +68,7 @@ class Watch(Resource):
         return 'OK', 204
 
     @auth.check_token
+    @validate_openapi_request('updateWatch')
     @expects_json(schema_update_watch)
     def put(self, uuid):
         """Update watch information."""
@@ -91,6 +94,7 @@ class WatchHistory(Resource):
     # Get a list of available history for a watch by UUID
     # curl http://localhost:5000/api/v1/watch/<string:uuid>/history
     @auth.check_token
+    @validate_openapi_request('getWatchHistory')
     def get(self, uuid):
         """Get a list of all historical snapshots available for a watch."""
         watch = self.datastore.data['watching'].get(uuid)
@@ -105,6 +109,7 @@ class WatchSingleHistory(Resource):
         self.datastore = kwargs['datastore']
 
     @auth.check_token
+    @validate_openapi_request('getWatchSnapshot')
     def get(self, uuid, timestamp):
         """Get single snapshot from watch."""
         watch = self.datastore.data['watching'].get(uuid)
@@ -138,6 +143,7 @@ class WatchFavicon(Resource):
         self.datastore = kwargs['datastore']
 
     @auth.check_token
+    @validate_openapi_request('getWatchFavicon')
     def get(self, uuid):
         """Get favicon for a watch."""
         watch = self.datastore.data['watching'].get(uuid)
@@ -172,6 +178,7 @@ class CreateWatch(Resource):
         self.update_q = kwargs['update_q']
 
     @auth.check_token
+    @validate_openapi_request('createWatch')
     @expects_json(schema_create_watch)
     def post(self):
         """Create a single watch."""
@@ -207,6 +214,7 @@ class CreateWatch(Resource):
             return "Invalid or unsupported URL", 400
 
     @auth.check_token
+    @validate_openapi_request('listWatches')
     def get(self):
         """List watches."""
         list = {}

changedetectionio/api/__init__.py

@@ -1,4 +1,9 @@
 import copy
+import yaml
+import functools
+from flask import request, abort
+from openapi_core import OpenAPI
+from openapi_core.contrib.flask import FlaskOpenAPIRequest
 from . import api_schema
 from ..model import watch_base
 
@@ -25,6 +30,38 @@ schema_create_notification_urls['required'] = ['notification_urls']
 schema_delete_notification_urls = copy.deepcopy(schema_notification_urls)
 schema_delete_notification_urls['required'] = ['notification_urls']
 
+# Load OpenAPI spec for validation
+_openapi_spec = None
+
+def get_openapi_spec():
+    global _openapi_spec
+    if _openapi_spec is None:
+        import os
+        spec_path = os.path.join(os.path.dirname(__file__), '../../docs/api-spec.yaml')
+        with open(spec_path, 'r') as f:
+            spec_dict = yaml.safe_load(f)
+        _openapi_spec = OpenAPI.from_dict(spec_dict)
+    return _openapi_spec
+
+def validate_openapi_request(operation_id):
+    """Decorator to validate incoming requests against OpenAPI spec."""
+    def decorator(f):
+        @functools.wraps(f)
+        def wrapper(*args, **kwargs):
+            try:
+                spec = get_openapi_spec()
+                openapi_request = FlaskOpenAPIRequest(request)
+                result = spec.unmarshal_request(openapi_request, operation_id)
+                if result.errors:
+                    abort(400, message=f"OpenAPI validation failed: {result.errors}")
+                return f(*args, **kwargs)
+            except Exception as e:
+                # If OpenAPI validation fails, log but don't break existing functionality
+                print(f"OpenAPI validation warning for {operation_id}: {e}")
+                return f(*args, **kwargs)
+        return wrapper
+    return decorator
+
 # Import all API resources
 from .Watch import Watch, WatchHistory, WatchSingleHistory, CreateWatch, WatchFavicon
 from .Tags import Tags, Tag

changedetectionio/blueprint/settings/templates/settings.html

@@ -203,7 +203,7 @@ nav
 
             <div class="tab-pane-inner" id="api">
                 <h4>API Access</h4>
-                <p>Drive your changedetection.io via API, More about <a href="https://github.com/dgtlmoon/changedetection.io/wiki/API-Reference">API access here</a></p>
+                <p>Drive your changedetection.io via API, More about <a href="https://changedetection.io/docs/api_v1/index.html">API access and examples here</a>.</p>
 
                 <div class="pure-control-group">
                     {{ render_checkbox_field(form.application.form.api_access_token_enabled) }}

changedetectionio/static/styles/scss/styles.scss

@@ -1130,11 +1130,12 @@ ul {
 }
 
 #realtime-conn-error {
-  position: absolute;
+  position: fixed;
   bottom: 0;
-  left: 30px;
+  left: 0;
   background: var(--color-warning);
   padding: 10px;
   font-size: 0.8rem;
   color: #fff;
+  opacity: 0.8;
 }

changedetectionio/templates/base.html

@@ -236,7 +236,7 @@
     <script src="{{url_for('static_content', group='js', filename='toggle-theme.js')}}" defer></script>
 
     <div id="checking-now-fixed-tab" style="display: none;"><span class="spinner"></span><span>&nbsp;Checking now</span></div>
-    <div id="realtime-conn-error" style="display:none">Offline</div>
+    <div id="realtime-conn-error" style="display:none">Real-time updates offline</div>
   </body>
 
 </html>

docs/api-spec.yaml

@@ -6,7 +6,7 @@ info:
     
     REST API for managing Page watches, Group tags, and Notifications.
     
-    changedetection.io can be driven by its built in simple API, in the examples below you will also find `curl` command line examples to help you.
+    changedetection.io can be driven by its built in simple API, in the examples below you will also find `curl` command line and `python` examples to help you get started faster.
     
     ## Where to find my API key?
     
@@ -28,7 +28,7 @@ info:
     
     For example: `x-api-key: YOUR_API_KEY`
     
-  version: 1.0.0
+  version: 0.1.0
   contact:
     name: ChangeDetection.io
     url: https://github.com/dgtlmoon/changedetection.io
@@ -89,6 +89,8 @@ tags:
       Configure global notification endpoints that can be used across all your watches. Supports various 
       notification services including email, Discord, Slack, webhooks, and many other popular platforms. 
       These settings serve as defaults that can be overridden at the individual watch or tag level.
+
+      The notification syntax uses [https://github.com/caronc/apprise](https://github.com/caronc/apprise).
       
   - name: Search
     description: |
@@ -123,7 +125,7 @@ components:
         uuid:
           type: string
           format: uuid
-          description: Unique identifier for the watch
+          description: Unique identifier for the web page change monitor (watch)
           readOnly: true
         url:
           type: string
@@ -132,11 +134,11 @@ components:
           maxLength: 5000
         title:
           type: string
-          description: Custom title for the watch
+          description: Custom title for the web page change monitor (watch)
           maxLength: 5000
         tag:
           type: string
-          description: Tag UUID to associate with this watch
+          description: Tag UUID to associate with this web page change monitor (watch)
           maxLength: 5000
         tags:
           type: array
@@ -145,7 +147,7 @@ components:
           description: Array of tag UUIDs
         paused:
           type: boolean
-          description: Whether the watch is paused
+          description: Whether the web page change monitor (watch) is paused
         muted:
           type: boolean
           description: Whether notifications are muted
@@ -195,7 +197,7 @@ components:
           type: array
           items:
             type: string
-          description: Notification URLs for this watch
+          description: Notification URLs for this web page change monitor (watch)
         notification_title:
           type: string
           description: Custom notification title
@@ -265,7 +267,7 @@ components:
           type: array
           items:
             type: string
-          description: Default notification URLs for watches with this tag
+          description: Default notification URLs for web page change monitors (watches) with this tag
         notification_muted:
           type: boolean
           description: Whether notifications are muted for this tag
@@ -289,7 +291,7 @@ components:
       properties:
         watch_count:
           type: integer
-          description: Total number of watches
+          description: Total number of web page change monitors (watches)
         tag_count:
           type: integer
           description: Total number of tags
@@ -307,7 +309,7 @@ components:
           type: object
           additionalProperties:
             $ref: '#/components/schemas/Watch'
-          description: Dictionary of matching watches keyed by UUID
+          description: Dictionary of matching web page change monitors (watches) keyed by UUID
 
     WatchHistory:
       type: object
@@ -326,9 +328,10 @@ components:
 paths:
   /watch:
     get:
+      operationId: listWatches
       tags: [Watch Management]
       summary: List all watches
-      description: Return concise list of available watches and basic info
+      description: Return concise list of available web page change monitors (watches) and basic info
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -388,9 +391,10 @@ paths:
                   last_checked: 1640998800
                   last_changed: 1640995200
     post:
+      operationId: createWatch
       tags: [Watch Management]
       summary: Create a new watch
-      description: Create a single watch. Requires at least 'url' to be set.
+      description: Create a single web page change monitor (watch). Requires at least 'url' to be set.
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -436,7 +440,7 @@ paths:
                 hours: 1
       responses:
         '200':
-          description: Watch created successfully
+          description: Web page change monitor (watch) created successfully
           content:
             text/plain:
               schema:
@@ -451,10 +455,10 @@ paths:
 
   /watch/{uuid}:
     get:
-      operationId: getSingleWatch
+      operationId: getWatch
       tags: [Watch Management]
       summary: Get single watch
-      description: Retrieve watch information and set muted/paused status. Returns the FULL Watch JSON.
+      description: Retrieve web page change monitor (watch) information and set muted/paused status. Returns the FULL Watch JSON.
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -472,13 +476,13 @@ paths:
         - name: uuid
           in: path
           required: true
-          description: Watch unique ID
+          description: Web page change monitor (watch) unique ID
           schema:
             type: string
             format: uuid
         - name: recheck
           in: query
-          description: Recheck this watch
+          description: Recheck this web page change monitor (watch)
           schema:
             type: string
             enum: ["1", "true"]
@@ -506,7 +510,7 @@ paths:
                 type: string
                 example: "OK"
         '404':
-          description: Watch not found
+          description: Web page change monitor (watch) not found
           content:
             application/json:
               schema:
@@ -516,7 +520,7 @@ paths:
       operationId: updateWatch
       tags: [Watch Management]
       summary: Update watch
-      description: Update an existing watch using JSON. Accepts the same structure as returned in [get single watch information](#operation/getSingleWatch).
+      description: Update an existing web page change monitor (watch) using JSON. Accepts the same structure as returned in [get single watch information](#operation/getWatch).
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -549,7 +553,7 @@ paths:
         - name: uuid
           in: path
           required: true
-          description: Watch unique ID
+          description: Web page change monitor (watch) unique ID
           schema:
             type: string
             format: uuid
@@ -561,7 +565,7 @@ paths:
               $ref: '#/components/schemas/Watch'
       responses:
         '200':
-          description: Watch updated successfully
+          description: Web page change monitor (watch) updated successfully
           content:
             text/plain:
               schema:
@@ -571,9 +575,10 @@ paths:
           description: Server error
 
     delete:
+      operationId: deleteWatch
       tags: [Watch Management]  
       summary: Delete watch
-      description: Delete a watch and all related history
+      description: Delete a web page change monitor (watch) and all related history
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -591,13 +596,13 @@ paths:
         - name: uuid
           in: path
           required: true
-          description: Watch unique ID
+          description: Web page change monitor (watch) unique ID
           schema:
             type: string
             format: uuid
       responses:
         '200':
-          description: Watch deleted successfully
+          description: Web page change monitor (watch) deleted successfully
           content:
             text/plain:
               schema:
@@ -606,9 +611,10 @@ paths:
 
   /watch/{uuid}/history:
     get:
+      operationId: getWatchHistory
       tags: [Watch History]
       summary: Get watch history
-      description: Get a list of all historical snapshots available for a watch
+      description: Get a list of all historical snapshots available for a web page change monitor (watch)
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -626,7 +632,7 @@ paths:
         - name: uuid
           in: path
           required: true
-          description: Watch unique ID
+          description: Web page change monitor (watch) unique ID
           schema:
             type: string
             format: uuid
@@ -641,13 +647,14 @@ paths:
                 "1640995200": "/path/to/snapshot1.txt"
                 "1640998800": "/path/to/snapshot2.txt"
         '404':
-          description: Watch not found
+          description: Web page change monitor (watch) not found
 
   /watch/{uuid}/history/{timestamp}:
     get:
+      operationId: getWatchSnapshot
       tags: [Snapshots]
       summary: Get single snapshot
-      description: Get single snapshot from 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.
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -666,7 +673,7 @@ paths:
         - name: uuid
           in: path
           required: true
-          description: Watch unique ID
+          description: Web page change monitor (watch) unique ID
           schema:
             type: string
             format: uuid
@@ -697,9 +704,10 @@ paths:
 
   /watch/{uuid}/favicon:
     get:
+      operationId: getWatchFavicon
       tags: [Favicon]
       summary: Get watch favicon
-      description: Get the favicon for a watch as displayed in the watch overview list.
+      description: Get the favicon for a web page change monitor (watch) as displayed in the watch overview list.
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -719,7 +727,7 @@ paths:
         - name: uuid
           in: path
           required: true
-          description: Watch unique ID
+          description: Web page change monitor (watch) unique ID
           schema:
             type: string
             format: uuid
@@ -736,6 +744,7 @@ paths:
 
   /tags:
     get:
+      operationId: listTags
       tags: [Group / Tag Management]
       summary: List all tags
       description: Return list of available tags/groups
@@ -772,11 +781,62 @@ paths:
                   notification_urls: ["discord://webhook_id/webhook_token"]
                   notification_muted: false
 
+  /tag:
+    post:
+      operationId: createTag
+      tags: [Group / Tag Management]
+      summary: Create tag
+      description: Create a single tag/group
+      x-code-samples:
+        - lang: 'curl'
+          source: |
+            curl -X POST "http://localhost:5000/api/v1/tag" \
+              -H "x-api-key: YOUR_API_KEY" \
+              -H "Content-Type: application/json" \
+              -d '{
+                "title": "Important Sites"
+              }'
+        - lang: 'Python'
+          source: |
+            import requests
+            
+            headers = {
+                'x-api-key': 'YOUR_API_KEY',
+                'Content-Type': 'application/json'
+            }
+            data = {'title': 'Important Sites'}
+            response = requests.post('http://localhost:5000/api/v1/tag', 
+                                   headers=headers, json=data)
+            print(response.json())
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Tag'
+            example:
+              title: "Important Sites"
+      responses:
+        '201':
+          description: Tag created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  uuid:
+                    type: string
+                    format: uuid
+                    description: UUID of the created tag
+        '400':
+          description: Invalid or unsupported tag
+
   /tag/{uuid}:
     get:
+      operationId: getTag
       tags: [Group / Tag Management]
       summary: Get single tag
-      description: Retrieve tag information, set notification_muted status, recheck all in tag.
+      description: Retrieve tag information, set notification_muted status, recheck all web page change monitors (watches) in tag.
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -806,7 +866,7 @@ paths:
             enum: [muted, unmuted]
         - name: recheck
           in: query
-          description: Queue all watches with this tag for recheck
+          description: Queue all web page change monitors (watches) with this tag for recheck
           schema:
             type: string
             enum: ["true"]
@@ -825,6 +885,7 @@ paths:
           description: Tag not found
 
     put:
+      operationId: updateTag
       tags: [Group / Tag Management]
       summary: Update tag
       description: Update an existing tag using JSON
@@ -875,9 +936,10 @@ paths:
           description: Server error
 
     delete:
+      operationId: deleteTag
       tags: [Group / Tag Management]
       summary: Delete tag
-      description: Delete a tag/group and remove it from all watches
+      description: Delete a tag/group and remove it from all web page change monitors (watches)
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -903,48 +965,10 @@ paths:
         '200':
           description: Tag deleted successfully
 
-    post:
-      tags: [Group / Tag Management]
-      summary: Create tag
-      description: Create a single tag/group
-      x-code-samples:
-        - lang: 'curl'
-          source: |
-            curl -X POST "http://localhost:5000/api/v1/tag/550e8400-e29b-41d4-a716-446655440000" \
-              -H "x-api-key: YOUR_API_KEY" \
-              -H "Content-Type: application/json" \
-              -d '{
-                "title": "Important Sites"
-              }'
-        - lang: 'Python'
-          source: |
-            import requests
-            
-            headers = {
-                'x-api-key': 'YOUR_API_KEY',
-                'Content-Type': 'application/json'
-            }
-            tag_uuid = '550e8400-e29b-41d4-a716-446655440000'
-            data = {'title': 'Important Sites'}
-            response = requests.post(f'http://localhost:5000/api/v1/tag/{tag_uuid}', 
-                                   headers=headers, json=data)
-            print(response.text)
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/Tag'
-            example:
-              title: "Important Sites"
-      responses:
-        '200':
-          description: Tag created successfully
-        '500':
-          description: Server error
 
   /notifications:
     get:
+      operationId: getNotifications
       tags: [Notifications]
       summary: Get notification URLs
       description: Return the notification URL list from the configuration
@@ -969,6 +993,7 @@ paths:
                 $ref: '#/components/schemas/NotificationUrls'
 
     post:
+      operationId: addNotifications
       tags: [Notifications]
       summary: Add notification URLs
       description: Add one or more notification URLs to the configuration
@@ -1022,6 +1047,7 @@ paths:
           description: Invalid input
 
     put:
+      operationId: replaceNotifications
       tags: [Notifications]
       summary: Replace notification URLs
       description: Replace all notification URLs with the provided list (can be empty)
@@ -1069,6 +1095,7 @@ paths:
           description: Invalid input
 
     delete:
+      operationId: deleteNotifications
       tags: [Notifications]
       summary: Delete notification URLs
       description: Delete one or more notification URLs from the configuration
@@ -1113,9 +1140,10 @@ paths:
 
   /search:
     get:
+      operationId: searchWatches
       tags: [Search]
       summary: Search watches
-      description: Search watches by URL or title text
+      description: Search web page change monitors (watches) by URL or title text
       x-code-samples:
         - lang: 'curl'
           source: |
@@ -1167,6 +1195,7 @@ paths:
 
   /import:
     post:
+      operationId: importWatches
       tags: [Import]
       summary: Import watch URLs
       description: Import a list of URLs to monitor. Accepts line-separated URLs in request body.
@@ -1192,17 +1221,17 @@ paths:
       parameters:
         - name: tag_uuids
           in: query
-          description: Tag UUID to apply to imported watches
+          description: Tag UUID to apply to imported web page change monitors (watches)
           schema:
             type: string
         - name: tag
           in: query
-          description: Tag name to apply to imported watches
+          description: Tag name to apply to imported web page change monitors (watches)
           schema:
             type: string
         - name: proxy
           in: query
-          description: Proxy key to use for imported watches
+          description: Proxy key to use for imported web page change monitors (watches)
           schema:
             type: string
         - name: dedupe
@@ -1237,6 +1266,7 @@ paths:
 
   /systeminfo:
     get:
+      operationId: getSystemInfo
       tags: [System Information]
       summary: Get system information
       description: Return information about the current system state
@@ -1263,4 +1293,4 @@ paths:
                 watch_count: 42
                 tag_count: 5
                 uptime: "2 days, 3:45:12"
-                version: "0.50.10"
+                version: "0.50.10"

requirements.txt

@@ -41,13 +41,16 @@ jsonpath-ng~=1.5.3
 # Notification library
 apprise==1.9.3
 
+# - Needed for apprise/spush, and maybe others? hopefully doesnt trigger a rust compile.
+# - Requires extra wheel for rPi, adds build time for arm/v8 which is not in piwheels
+# Pinned to 43.0.1 for ARM compatibility (45.x may not have pre-built ARM wheels)
+# Also pinned because dependabot wants specific versions
+cryptography==44.0.1
+
 # apprise mqtt https://github.com/dgtlmoon/changedetection.io/issues/315
 # use any version other than 2.0.x due to https://github.com/eclipse/paho.mqtt.python/issues/814
 paho-mqtt!=2.0.*
 
-# Requires extra wheel for rPi
-#cryptography~=42.0.8
-
 # Used for CSS filtering
 beautifulsoup4>=4.0.0
 
@@ -89,6 +92,9 @@ pytest-flask ~=1.2
 # Anything 4.0 and up but not 5.0
 jsonschema ~= 4.0
 
+# OpenAPI validation support
+openapi-core[flask] >= 0.19.0
+
 
 loguru