From e70ccdfb6c47dad0b486ff4d19f41e9416f054ac Mon Sep 17 00:00:00 2001 From: Chuck <33324927+ChuckBuilds@users.noreply.github.com> Date: Thu, 17 Sep 2026 08:53:49 -0400 Subject: [PATCH] docs(store): search via /plugins/store/list?query=; send Content-Type on registry curls /plugins/store/search does not exist (404) and the list endpoint reads query, not q. The registry guide's curl examples omitted the JSON Content-Type, so the handlers saw an empty body and answered 400. Co-Authored-By: Claude Opus 5 --- docs/PLUGIN_REGISTRY_SETUP_GUIDE.md | 3 +++ docs/PLUGIN_STORE_GUIDE.md | 9 ++++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/PLUGIN_REGISTRY_SETUP_GUIDE.md b/docs/PLUGIN_REGISTRY_SETUP_GUIDE.md index d1426979..87457c14 100644 --- a/docs/PLUGIN_REGISTRY_SETUP_GUIDE.md +++ b/docs/PLUGIN_REGISTRY_SETUP_GUIDE.md @@ -103,6 +103,7 @@ All plugins can be installed through the LEDMatrix web interface: Or via API: ```bash curl -X POST http://your-pi-ip:5000/api/v3/plugins/install \ + -H "Content-Type: application/json" \ -d '{"plugin_id": "clock-simple"}' ``` @@ -153,6 +154,7 @@ Before submitting, ensure your plugin: ```bash # Install via URL on your Pi curl -X POST http://your-pi:5000/api/v3/plugins/install-from-url \ + -H "Content-Type: application/json" \ -d '{"repo_url": "https://github.com/you/ledmatrix-your-plugin"}' ``` @@ -312,6 +314,7 @@ git push # 2. Review using VERIFICATION.md checklist # 3. Test installation: curl -X POST http://pi:5000/api/v3/plugins/install-from-url \ + -H "Content-Type: application/json" \ -d '{"repo_url": "https://github.com/contributor/plugin"}' # 4. If approved, merge PR diff --git a/docs/PLUGIN_STORE_GUIDE.md b/docs/PLUGIN_STORE_GUIDE.md index 421c99de..fbec2a36 100644 --- a/docs/PLUGIN_STORE_GUIDE.md +++ b/docs/PLUGIN_STORE_GUIDE.md @@ -131,13 +131,13 @@ else: **Via REST API:** ```bash # Search by query -curl "http://your-pi-ip:5000/api/v3/plugins/store/search?q=hockey" +curl "http://your-pi-ip:5000/api/v3/plugins/store/list?query=hockey" # Filter by category -curl "http://your-pi-ip:5000/api/v3/plugins/store/search?category=sports" +curl "http://your-pi-ip:5000/api/v3/plugins/store/list?category=sports" # Filter by tags -curl "http://your-pi-ip:5000/api/v3/plugins/store/search?tags=nhl&tags=hockey" +curl "http://your-pi-ip:5000/api/v3/plugins/store/list?tags=nhl&tags=hockey" ``` **Via Python:** @@ -351,8 +351,7 @@ All API endpoints return JSON with this structure: | Method | Endpoint | Description | |--------|----------|-------------| -| GET | `/api/v3/plugins/store/list` | List all plugins in store | -| GET | `/api/v3/plugins/store/search` | Search for plugins | +| GET | `/api/v3/plugins/store/list` | List plugins in store; `?query=`, `?category=`, `?tags=` search and filter | | GET | `/api/v3/plugins/installed` | List installed plugins | | POST | `/api/v3/plugins/install` | Install from registry | | POST | `/api/v3/plugins/install-from-url` | Install from GitHub URL |