Gandalf/sofarr
Public Access
0
0
Fork 0
Code Issues 1 Pull Requests Actions 1 Packages Projects Releases 59 Wiki Activity

Update README.md to reflect recent Ombi features and test metrics #37

New Issue
Closed
opened 2026-05-22 22:34:35 +01:00 by Gandalf · 3 comments
Gandalf commented 2026-05-22 22:34:35 +01:00
Owner
Copy Link
Copy Source

Review of recent commits revealed the following documentation inconsistencies in README.md:

  1. Ombi Filtering & SSE: The Ombi Integration section is missing documentation for the newly added request filtering, search capabilities, and real-time SSE updates.
  2. Ombi API & Webhook Endpoints: The API Endpoints section is missing new webhook endpoints (e.g., POST /api/ombi/webhook/enable, POST /api/ombi/webhook/test, and GET /api/webhook/config).
  3. Outdated Test Metrics: The Testing section claims '290 tests across 18 test files', but the test suite currently executes over 830 tests across 39 files.
Review of recent commits revealed the following documentation inconsistencies in README.md: 1. **Ombi Filtering & SSE**: The Ombi Integration section is missing documentation for the newly added request filtering, search capabilities, and real-time SSE updates. 2. **Ombi API & Webhook Endpoints**: The API Endpoints section is missing new webhook endpoints (e.g., POST /api/ombi/webhook/enable, POST /api/ombi/webhook/test, and GET /api/webhook/config). 3. **Outdated Test Metrics**: The Testing section claims '290 tests across 18 test files', but the test suite currently executes over 830 tests across 39 files.
Gandalf added the Kind/Documentation label 2026-05-22 22:34:35 +01:00
Gandalf commented 2026-05-22 22:36:00 +01:00
Author
Owner
Copy Link
Copy Source

Additional Findings: ARCHITECTURE.md is also missing documentation for the new webhook configuration endpoints (e.g., GET /api/webhook/config and the Ombi webhook endpoints under /api/ombi). The implementation plan will be updated to include these ARCHITECTURE.md inconsistencies.

Additional Findings: ARCHITECTURE.md is also missing documentation for the new webhook configuration endpoints (e.g., GET /api/webhook/config and the Ombi webhook endpoints under /api/ombi). The implementation plan will be updated to include these ARCHITECTURE.md inconsistencies.
Gandalf commented 2026-05-22 22:38:01 +01:00
Author
Owner
Copy Link
Copy Source

Additional Findings (Swagger/OpenAPI):

  1. server/routes/dashboard.js: The JSDoc for /api/dashboard/blocklist-search incorrectly claims it is an 'Admin-only endpoint' and lists a 403 error for 'Non-admin user attempts access', which contradicts the recent blocklist update allowing non-admins to blocklist under specific conditions.
  2. server/openapi.yaml: The BlocklistSearchRequest schema and path stub also incorrectly state 'Admin-only'.
  3. server/openapi.yaml: Missing path stubs for the new /api/webhook/config endpoint and all /api/ombi/* endpoints, breaking the architectural pattern of having a central stub for every endpoint.
  4. tests/integration/swagger-coverage.test.js: Missing coverage checks to ensure the new Ombi and webhook config endpoints are documented in Swagger.

These Swagger/OpenAPI documentation issues will be added to the implementation plan.

Additional Findings (Swagger/OpenAPI): 1. `server/routes/dashboard.js`: The JSDoc for `/api/dashboard/blocklist-search` incorrectly claims it is an 'Admin-only endpoint' and lists a 403 error for 'Non-admin user attempts access', which contradicts the recent blocklist update allowing non-admins to blocklist under specific conditions. 2. `server/openapi.yaml`: The `BlocklistSearchRequest` schema and path stub also incorrectly state 'Admin-only'. 3. `server/openapi.yaml`: Missing path stubs for the new `/api/webhook/config` endpoint and all `/api/ombi/*` endpoints, breaking the architectural pattern of having a central stub for every endpoint. 4. `tests/integration/swagger-coverage.test.js`: Missing coverage checks to ensure the new Ombi and webhook config endpoints are documented in Swagger. These Swagger/OpenAPI documentation issues will be added to the implementation plan.
Gandalf commented 2026-05-22 22:43:13 +01:00
Author
Owner
Copy Link
Copy Source

Resolved in commit 4cd9faaf25 by updating README.md, ARCHITECTURE.md, and OpenAPI specifications to align with recent Ombi integrations and test metrics.

Resolved in commit 4cd9faaf25638fd883fb63476c346aba7b005455 by updating README.md, ARCHITECTURE.md, and OpenAPI specifications to align with recent Ombi integrations and test metrics.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Area/Docker
Docker image and container packaging
 Area/Download Clients
Download client integrations
 Area/Frontend
Client-side UI and build tooling
 Area/History
History and completed downloads views
 Area/Logging
Log streaming, file handling, and debug infrastructure
 Area/Matching
Matching and correlation logic
 Area/Proxy
Upstream service proxy routes
 Area/SSE
Server-Sent Events and real-time streaming
 Area/Webhooks
Webhook processing and reliability
 Compat/Breaking
Breaking change that won't be backward compatible
 Compat/Non-Breaking
Non-breaking compatibility change
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No labels Kind/Documentation
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
Gandalf
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Gandalf/sofarr#37