Automated commit 'ISCCOMPLI-306: Beta to v3 API doc migration for set schedule campaign template API (#1427)

* ISCCOMPLI-306: Beta to v3 API doc migration for set schedule campaign template API

* ISCCOMPLI-306: Removed DAILY option from beta schedule

* ISCCOMPLI-306: Fix for linter errors

* ISCCOMPLI-306: Fix for linter errors

* ISCCOMPLI-306: Added more descriptions in beta files

* ISCCOMPLI-306: Fixed more linter errors

* ISCCOMPLI-306: Fixed more linter errors

* ISCCOMPLI-306: Added the main v3 path' by github action: 6381139723
This commit is contained in:
GitHub Action Bot
2023-10-02 14:01:58 +00:00
parent ee5e10160a
commit 00f838f4e1
5 changed files with 331 additions and 15 deletions

View File

@@ -5,6 +5,8 @@ get:
summary: Gets a Campaign Template's Schedule
description: >-
Gets the schedule for a campaign template. Returns a 404 if there is no schedule set.
security:
- UserContextAuth: [ idn:campaign-template:read ]
parameters:
- in: path
name: id
@@ -12,6 +14,7 @@ get:
type: string
required: true
description: The ID of the campaign template whose schedule is being fetched.
example: "04bedce387bd47b2ae1f86eb0bb36dee"
responses:
'200':
description: >-
@@ -21,6 +24,8 @@ get:
application/json:
schema:
$ref: '../schemas/Schedule.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
@@ -39,6 +44,9 @@ put:
description: >-
Sets the schedule for a campaign template. If a schedule already exists, it will be overwritten with
the new one.
security:
- UserContextAuth: [ idn:campaign-template:run ]
deprecated: true
parameters:
- in: path
name: id
@@ -46,6 +54,7 @@ put:
type: string
required: true
description: The ID of the campaign template being scheduled.
example: 04bedce387bd47b2ae1f86eb0bb36dee
requestBody:
content:
application/json:
@@ -140,6 +149,8 @@ delete:
summary: Deletes a Campaign Template's Schedule
description: >-
Deletes the schedule for a campaign template. Returns a 404 if there is no schedule set.
security:
- UserContextAuth: [ idn:campaign-template:run ]
parameters:
- in: path
name: id
@@ -147,9 +158,12 @@ delete:
type: string
required: true
description: The ID of the campaign template whose schedule is being deleted.
example: "04bedce387bd47b2ae1f86eb0bb36dee"
responses:
'204':
$ref: '../../v3/responses/204.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':