From 3da00f75dcf04ce2c6acf1e56c406d1b20b7b009 Mon Sep 17 00:00:00 2001 From: Bogdan Date: Wed, 21 Jun 2023 07:09:01 +0300 Subject: [PATCH] Remove not implemented endpoints from API docs Closes #2613 --- src/Readarr.Api.V1/Health/HealthController.cs | 1 + src/Readarr.Api.V1/Indexers/ReleaseModuleBase.cs | 2 ++ src/Readarr.Api.V1/ProviderControllerBase.cs | 10 ++++++++++ src/Readarr.Api.V1/Queue/QueueController.cs | 1 + src/Readarr.Api.V1/Queue/QueueDetailsController.cs | 1 + src/Readarr.Api.V1/Queue/QueueStatusController.cs | 1 + 6 files changed, 16 insertions(+) diff --git a/src/Readarr.Api.V1/Health/HealthController.cs b/src/Readarr.Api.V1/Health/HealthController.cs index f9dfa503e..f8b7bb31f 100644 --- a/src/Readarr.Api.V1/Health/HealthController.cs +++ b/src/Readarr.Api.V1/Health/HealthController.cs @@ -22,6 +22,7 @@ public HealthController(IBroadcastSignalRMessage signalRBroadcaster, IHealthChec _healthCheckService = healthCheckService; } + [NonAction] protected override HealthResource GetResourceById(int id) { throw new NotImplementedException(); diff --git a/src/Readarr.Api.V1/Indexers/ReleaseModuleBase.cs b/src/Readarr.Api.V1/Indexers/ReleaseModuleBase.cs index b7341e8d6..0d0586c9c 100644 --- a/src/Readarr.Api.V1/Indexers/ReleaseModuleBase.cs +++ b/src/Readarr.Api.V1/Indexers/ReleaseModuleBase.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Generic; +using Microsoft.AspNetCore.Mvc; using NzbDrone.Core.DecisionEngine; using Readarr.Http.REST; @@ -7,6 +8,7 @@ namespace Readarr.Api.V1.Indexers { public abstract class ReleaseControllerBase : RestController { + [NonAction] protected override ReleaseResource GetResourceById(int id) { throw new NotImplementedException(); diff --git a/src/Readarr.Api.V1/ProviderControllerBase.cs b/src/Readarr.Api.V1/ProviderControllerBase.cs index ebfad038b..8f23aa69e 100644 --- a/src/Readarr.Api.V1/ProviderControllerBase.cs +++ b/src/Readarr.Api.V1/ProviderControllerBase.cs @@ -41,6 +41,7 @@ protected override TProviderResource GetResourceById(int id) } [HttpGet] + [Produces("application/json")] public List GetAll() { var providerDefinitions = _providerFactory.All().OrderBy(p => p.ImplementationName); @@ -58,6 +59,8 @@ public List GetAll() } [RestPostById] + [Consumes("application/json")] + [Produces("application/json")] public ActionResult CreateProvider([FromBody] TProviderResource providerResource, [FromQuery] bool forceSave = false) { var providerDefinition = GetDefinition(providerResource, true, !forceSave, false); @@ -73,6 +76,8 @@ public ActionResult CreateProvider([FromBody] TProviderResour } [RestPutById] + [Consumes("application/json")] + [Produces("application/json")] public ActionResult UpdateProvider([FromBody] TProviderResource providerResource, [FromQuery] bool forceSave = false) { var providerDefinition = GetDefinition(providerResource, true, !forceSave, false); @@ -108,6 +113,7 @@ public object DeleteProvider(int id) } [HttpGet("schema")] + [Produces("application/json")] public List GetTemplates() { var defaultDefinitions = _providerFactory.GetDefaultDefinitions().OrderBy(p => p.ImplementationName).ToList(); @@ -131,6 +137,7 @@ public List GetTemplates() [SkipValidation(true, false)] [HttpPost("test")] + [Consumes("application/json")] public object Test([FromBody] TProviderResource providerResource) { var providerDefinition = GetDefinition(providerResource, true, true, true); @@ -141,6 +148,7 @@ public object Test([FromBody] TProviderResource providerResource) } [HttpPost("testall")] + [Produces("application/json")] public IActionResult TestAll() { var providerDefinitions = _providerFactory.All() @@ -164,6 +172,8 @@ public IActionResult TestAll() [SkipValidation] [HttpPost("action/{name}")] + [Consumes("application/json")] + [Produces("application/json")] public IActionResult RequestAction(string name, [FromBody] TProviderResource resource) { var providerDefinition = GetDefinition(resource, false, false, false); diff --git a/src/Readarr.Api.V1/Queue/QueueController.cs b/src/Readarr.Api.V1/Queue/QueueController.cs index 6cab6c143..d1378f310 100644 --- a/src/Readarr.Api.V1/Queue/QueueController.cs +++ b/src/Readarr.Api.V1/Queue/QueueController.cs @@ -57,6 +57,7 @@ public QueueController(IBroadcastSignalRMessage broadcastSignalRMessage, _qualityComparer = new QualityModelComparer(qualityProfileService.GetDefaultProfile(string.Empty)); } + [NonAction] protected override QueueResource GetResourceById(int id) { throw new NotImplementedException(); diff --git a/src/Readarr.Api.V1/Queue/QueueDetailsController.cs b/src/Readarr.Api.V1/Queue/QueueDetailsController.cs index 258bc065c..d4205a5cc 100644 --- a/src/Readarr.Api.V1/Queue/QueueDetailsController.cs +++ b/src/Readarr.Api.V1/Queue/QueueDetailsController.cs @@ -26,6 +26,7 @@ public QueueDetailsController(IBroadcastSignalRMessage broadcastSignalRMessage, _pendingReleaseService = pendingReleaseService; } + [NonAction] protected override QueueResource GetResourceById(int id) { throw new NotImplementedException(); diff --git a/src/Readarr.Api.V1/Queue/QueueStatusController.cs b/src/Readarr.Api.V1/Queue/QueueStatusController.cs index 10ff444b1..b06da380f 100644 --- a/src/Readarr.Api.V1/Queue/QueueStatusController.cs +++ b/src/Readarr.Api.V1/Queue/QueueStatusController.cs @@ -30,6 +30,7 @@ public QueueStatusController(IBroadcastSignalRMessage broadcastSignalRMessage, I _broadcastDebounce = new Debouncer(BroadcastChange, TimeSpan.FromSeconds(5)); } + [NonAction] protected override QueueStatusResource GetResourceById(int id) { throw new NotImplementedException();