{"files":{"SKILL.md":"---\nname: swagger-api-rest-for-patrowl-engines\ndescription: \"Swagger API-REST for Patrowl Engines API skill. Use when working with Swagger API-REST for Patrowl Engines for root, liveness, readiness. Covers 14 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Swagger API-REST for Patrowl Engines\nAPI version: 1.0.0\n\n## Auth\nNo authentication required.\n\n## Base URL\nhttp://localhost:5001/engines/nmap/\n\n## Setup\n1. No auth setup needed\n2. GET / -- index page\n3. POST /startscan -- create first startscan\n\n## Endpoints\n14 endpoints across 12 groups. See references/api-spec.lap for full details.\n\n### Root\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | / | Index page |\n\n### Liveness\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /liveness | Liveness page |\n\n### Readiness\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /readiness | Readiness page |\n\n### Test\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /test | Test page |\n\n### Reloadconfig\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /reloadconfig | Configuration reloading page |\n\n### Info\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /info | Engine info page |\n\n### Clean\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /clean | Clean all scans |\n| GET | /clean/{scanId} | Clean scan |\n\n### Status\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /status | Status on all scans |\n| GET | /status/{scanId} | Status of a scan |\n\n### Stopscans\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /stopscans | Stop all scans |\n\n### Stop\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /stop/{scanId} | Stop a scan |\n\n### Getfindings\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /getfindings/{scanId} | Get findings on finished scans |\n\n### Startscan\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /startscan | Start a new scan |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all resource?\" -> GET /\n- \"List all liveness?\" -> GET /liveness\n- \"List all readiness?\" -> GET /readiness\n- \"List all test?\" -> GET /test\n- \"List all reloadconfig?\" -> GET /reloadconfig\n- \"List all info?\" -> GET /info\n- \"List all clean?\" -> GET /clean\n- \"Get clean details?\" -> GET /clean/{scanId}\n- \"List all status?\" -> GET /status\n- \"Get status details?\" -> GET /status/{scanId}\n- \"List all stopscans?\" -> GET /stopscans\n- \"Get stop details?\" -> GET /stop/{scanId}\n- \"Get getfinding details?\" -> GET /getfindings/{scanId}\n- \"Create a startscan?\" -> POST /startscan\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Swagger API-REST for Patrowl Engines\n@base http://localhost:5001/engines/nmap/\n@version 1.0.0\n@endpoints 14\n@toc root(1), liveness(1), readiness(1), test(1), reloadconfig(1), info(1), clean(2), status(2), stopscans(1), stop(1), getfindings(1), startscan(1)\n\n@group root\n@endpoint GET /\n@desc Index page\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group liveness\n@endpoint GET /liveness\n@desc Liveness page\n@returns(200) successful operation\n\n@endgroup\n\n@group readiness\n@endpoint GET /readiness\n@desc Readiness page\n@returns(200) successful operation\n\n@endgroup\n\n@group test\n@endpoint GET /test\n@desc Test page\n@returns(200) successful operation\n\n@endgroup\n\n@group reloadconfig\n@endpoint GET /reloadconfig\n@desc Configuration reloading page\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group info\n@endpoint GET /info\n@desc Engine info page\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group clean\n@endpoint GET /clean\n@desc Clean all scans\n@returns(200) {status: str, page: str} # successful operation\n\n@endpoint GET /clean/{scanId}\n@desc Clean scan\n@required {scanId: int # Numeric ID of the scan to clean}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group status\n@endpoint GET /status\n@desc Status on all scans\n@returns(200) {status: str, page: str} # successful operation\n\n@endpoint GET /status/{scanId}\n@desc Status of a scan\n@required {scanId: int # Numeric ID of the scan to get status}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group stopscans\n@endpoint GET /stopscans\n@desc Stop all scans\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group stop\n@endpoint GET /stop/{scanId}\n@desc Stop a scan\n@required {scanId: int # Numeric ID of the scan to stop}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group getfindings\n@endpoint GET /getfindings/{scanId}\n@desc Get findings on finished scans\n@required {scanId: int # Numeric ID of the scan to get findings}\n@returns(200) successful operation\n\n@endgroup\n\n@group startscan\n@endpoint POST /startscan\n@desc Start a new scan\n@optional {scan_id: int, options: map, assets: [map{id: str, value: str, criticity: str, datatype: str}]}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@end\n"}}