docs: align swagger spec and README with Ombi features and blocklist eligibility (closes #37)
Build and Push Docker Image / build (push) Successful in 38s
Docs Check / Markdown lint (push) Successful in 1m18s
Licence Check / Licence compatibility and copyright header verification (push) Failing after 2m11s
CI / Security audit (push) Successful in 2m27s
Docs Check / Mermaid diagram parse check (push) Successful in 3m5s
CI / Swagger Validation & Coverage (push) Successful in 3m19s
CI / Tests & coverage (push) Successful in 3m34s

This commit is contained in:
2026-05-22 22:42:44 +01:00
parent 2e9fe8e049
commit 4cd9faaf25
5 changed files with 328 additions and 32 deletions
@@ -142,6 +142,10 @@ describe('Swagger Coverage', () => {
expect(paths['/api/webhook/sonarr'].post).toBeDefined();
expect(paths['/api/webhook/radarr']).toBeDefined();
expect(paths['/api/webhook/radarr'].post).toBeDefined();
expect(paths['/api/webhook/ombi']).toBeDefined();
expect(paths['/api/webhook/ombi'].post).toBeDefined();
expect(paths['/api/webhook/config']).toBeDefined();
expect(paths['/api/webhook/config'].get).toBeDefined();
});
it('should have Sonarr proxy endpoints documented', () => {
@@ -179,6 +183,19 @@ describe('Swagger Coverage', () => {
expect(paths['/api/emby/session/{sessionId}/user']).toBeDefined();
});
it('should have Ombi endpoints documented', () => {
const paths = openapiSpec.paths;
expect(paths['/api/ombi/requests']).toBeDefined();
expect(paths['/api/ombi/requests'].get).toBeDefined();
expect(paths['/api/ombi/webhook/enable']).toBeDefined();
expect(paths['/api/ombi/webhook/enable'].post).toBeDefined();
expect(paths['/api/ombi/webhook/status']).toBeDefined();
expect(paths['/api/ombi/webhook/status'].get).toBeDefined();
expect(paths['/api/ombi/webhook/test']).toBeDefined();
expect(paths['/api/ombi/webhook/test'].post).toBeDefined();
});
it('should return 200 for Swagger UI endpoint', async () => {
const response = await request(app).get('/api/swagger').redirects(1);
expect(response.status).toBe(200);