vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2026-03-30 23:03:03 -07:00
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Merge pull request #1485 from adamoutler/patch-14

Browse Source 
Update OpenAPI spec description with detailed info
This commit is contained in:
Jokob @NetAlertX
2026-02-04 06:50:15 +11:00
committed by GitHub
parent 250b5a3f51 50e74076bb
commit 433600d36c
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
server/api_server/openapi/spec_generator.py
View File

@@ -52,7 +52,15 @@ _rebuild_lock = threading.Lock()
def generate_openapi_spec( def generate_openapi_spec(
title: str = "NetAlertX API", title: str = "NetAlertX API",
version: str = "2.0.0", version: str = "2.0.0",
description: str = "NetAlertX Network Monitoring API - Official Documentation - MCP Compatible", description: str = '''
**NetAlertX Network Monitoring API - Official Documentation - MCP Compatible**
* **MCP endpoint**: `/mcp/sse`
* **OpenAPI Spec**: `/openapi.json`
Authorize with your API Key from the NetAlertX WebUI under `Settings > Core > General`
''',
servers: Optional[List[Dict[str, str]]] = None, servers: Optional[List[Dict[str, str]]] = None,
flask_app: Optional[Any] = None flask_app: Optional[Any] = None
) -> Dict[str, Any]: ) -> Dict[str, Any]: