From faaa3616aebfbb709652c387999f956cc35563e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Go=CC=88ran=20Sander?= Date: Tue, 28 Dec 2021 22:26:39 +0100 Subject: [PATCH] fix: Use correct return body format in scheduler API docs Fixes #331. --- src/api/scheduler.js | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/api/scheduler.js b/src/api/scheduler.js index 154361f6..6cafcb86 100644 --- a/src/api/scheduler.js +++ b/src/api/scheduler.js @@ -241,7 +241,8 @@ const apiDELETESchedules = { response: { 204: { description: 'Schedule successfully deleted.', - type: 'object', + type: 'string', + example: '', }, 400: { description: 'Schedule not found.', @@ -287,7 +288,7 @@ const apiPUTSchedulesStart = { response: { 200: { description: - 'Schedule successfully started.\n\nAn object with all inforomation about the started schedule is returned.', + 'Schedule successfully started.\n\nAn object with all information about the started schedule is returned.', type: 'object', properties: { id: { @@ -382,7 +383,7 @@ const apiPUTSchedulesStop = { response: { 200: { description: - 'Schedule successfully stopped.\n\nAn object with all inforomation about the stopped schedule is returned.', + 'Schedule successfully stopped.\n\nAn object with all information about the stopped schedule is returned.', type: 'object', properties: { id: { @@ -467,7 +468,7 @@ const apiPUTSchedulesStartAll = { response: { 200: { description: - 'Schedules successfully started.\n\nAn array with all inforomation about the started schedules is returned.', + 'Schedules successfully started.\n\nAn array with all information about the started schedules is returned.', type: 'array', items: { type: 'object', @@ -544,7 +545,7 @@ const apiPUTSchedulesStopAll = { response: { 200: { description: - 'Schedules successfully stopped.\n\nAn array with all inforomation about the stopped schedules is returned.', + 'Schedules successfully stopped.\n\nAn array with all information about the stopped schedules is returned.', type: 'array', items: { type: 'object',