Fix API documentation for Campaign deliver/schedule

pentacent · Jan 5, 2023 · ce2a365 · ce2a365
1 parent 896134c
commit ce2a365
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/lib/keila_web/api/controllers/api_campaign_controller.ex b/lib/keila_web/api/controllers/api_campaign_controller.ex
@@ -108,10 +108,10 @@ defmodule KeilaWeb.ApiCampaignController do
   end
 
   operation(:deliver,
-    summary: "Delete Campaign",
+    summary: "Deliver Campaign",
     parameters: [id: [in: :path, type: :string, description: "Campaign ID"]],
     responses: %{
-      204 => "Campaign was deleted successfully or didn’t exist."
+      ok: {"Campaign response", "application/json", Schemas.MailingsCampaign.Response}
     }
   )
 
@@ -129,12 +129,12 @@ defmodule KeilaWeb.ApiCampaignController do
   end
 
   operation(:schedule,
-    summary: "Delete Campaign",
+    summary: "Schedule Campaign",
     parameters: [id: [in: :path, type: :string, description: "Campaign ID"]],
     request_body:
       {"Campaign params", "application/json", Schemas.MailingsCampaign.ScheduleParams},
     responses: %{
-      204 => "Campaign was deleted successfully or didn’t exist."
+      ok: {"Campaign response", "application/json", Schemas.MailingsCampaign.Response}
     }
   )
 

diff --git a/lib/keila_web/router.ex b/lib/keila_web/router.ex
@@ -187,6 +187,8 @@ defmodule KeilaWeb.Router do
     post "/campaigns/:id/actions/schedule", ApiCampaignController, :schedule
 
     resources "/segments", ApiSegmentController, only: [:index, :show, :create, :update, :delete]
+
+    resources "/senders", ApiSenderController, only: [:index]
   end
 
   # Webhooks