From 1d5dbcc7f27dfa376597a163ee7ed490b27ffbf6 Mon Sep 17 00:00:00 2001
From: GitHub Action Bot <tyler.mairose@sailpoint.com>
Date: Fri, 29 Sep 2023 10:35:41 +0000
Subject: [PATCH] Automated commit 'ISCCOMPLI-302 : Update Campaign Template
 API doc beta to v3 Migration (#1424)

* ISCCOMPLI-300: beta to v3 api doc of Create campaign template

* ISCCOMPLI-300: fixed lint issue

* ISCCOMPLI-300: fixed lint issue

* ISCCOMPLI-300: trying readOnly property

* ISCCOMPLI-300: reverted readOnly property of name

* ISCCOMPLI-300: fixed review comment

* ISCCOMPLI-300: fixed review comment about campaign description

* ISCCOMPLI-300: fixed review comment about campaign description

* API doc beta to v3 Migration

* Update Campaign Template API doc beta to v3 Migration

* security oauthContext added

* replaced array type object to ref of JsonPatchOperation because on API, earlier it was getting displayed as empty Array

---------

Co-authored-by: sumant-narote-sp <sumant.narote@sailpoint.com>' by github action: 6350391955
---
 idn/beta/paths/campaign-template.yaml |  9 +++-
 idn/sailpoint-api.v3.yaml             |  2 +
 idn/v3/paths/campaign-template.yaml   | 68 +++++++++++++++++++++++++++
 3 files changed, 78 insertions(+), 1 deletion(-)
 create mode 100644 idn/v3/paths/campaign-template.yaml

diff --git a/idn/beta/paths/campaign-template.yaml b/idn/beta/paths/campaign-template.yaml
index 78dc872..3f589b3 100644
--- a/idn/beta/paths/campaign-template.yaml
+++ b/idn/beta/paths/campaign-template.yaml
@@ -4,6 +4,8 @@ get:
     - Certification Campaigns
   summary: Get a Campaign Template
   description: Fetches a campaign template by ID.
+  security:
+    - UserContextAuth: [ idn:campaign-template:read ]
   parameters:
     - in: path
       name: id
@@ -46,6 +48,9 @@ patch:
     - Certification Campaigns
   summary: Update a Campaign Template
   description: Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
+  deprecated: true
+  security:
+    - UserContextAuth: [ idn:campaign-template:update ]
   parameters:
     - in: path
       name: id
@@ -69,7 +74,7 @@ patch:
         schema:
           type: array
           items:
-            type: object
+            $ref: "../schemas/JsonPatchOperation.yaml"
         example:
             - op: "replace"
               path: "/description"
@@ -112,6 +117,8 @@ delete:
     - Certification Campaigns
   summary: Delete a Campaign Template
   description: Deletes a campaign template by ID.
+  security:
+    - UserContextAuth: [ idn:campaign-template:delete ]
   parameters:
     - in: path
       name: id
diff --git a/idn/sailpoint-api.v3.yaml b/idn/sailpoint-api.v3.yaml
index 321f88a..5846def 100644
--- a/idn/sailpoint-api.v3.yaml
+++ b/idn/sailpoint-api.v3.yaml
@@ -872,6 +872,8 @@ paths:
     $ref: './v3/paths/campaign-reports-configuration.yaml'
   /campaign-templates:
     $ref: './v3/paths/campaign-templates.yaml'
+  /campaign-templates/{id}:
+    $ref: './v3/paths/campaign-template.yaml'
   /certifications:
     $ref: "./v3/paths/identity-certifications.yaml"
   /certifications/{id}:
diff --git a/idn/v3/paths/campaign-template.yaml b/idn/v3/paths/campaign-template.yaml
new file mode 100644
index 0000000..4853ccc
--- /dev/null
+++ b/idn/v3/paths/campaign-template.yaml
@@ -0,0 +1,68 @@
+patch:
+  operationId: patchCampaignTemplate
+  tags:
+    - Certification Campaigns
+  summary: Update a Campaign Template
+  description: Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
+  security:
+    - UserContextAuth: [ idn:campaign-template:update ]
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: string
+      required: true
+      description: The ID of the campaign template being modified.
+      example: 2c9180835d191a86015d28455b4a2329
+  requestBody:
+    required: true
+    description: |
+      A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
+
+      The following fields are patchable:
+      * name
+      * description
+      * deadlineDuration
+      * campaign (all fields that are allowed during create)
+    content:
+      application/json-patch+json:
+        schema:
+          type: array
+          items:
+            $ref: "../schemas/JsonPatchOperation.yaml"
+        example:
+            - op: "replace"
+              path: "/description"
+              value: "Updated description!"
+            - op: "replace"
+              path: "/campaign/filter/id"
+              value: "ff80818155fe8c080155fe8d925b0316"
+  responses:
+    '200':
+      description: >-
+        Indicates the PATCH operation succeeded, and returns the template's new representation.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/CampaignTemplate.yaml'
+          examples:
+            Manager:
+              $ref: '../schemas/campaign/examples/CampaignTemplateManager.yaml'
+            Search:
+              $ref: '../schemas/campaign/examples/CampaignTemplateSearch.yaml'
+            Source Owner:
+              $ref: '../schemas/campaign/examples/CampaignTemplateSourceOwner.yaml'
+            RoleComposition:
+              $ref: '../schemas/campaign/examples/CampaignTemplateRoleComposition.yaml'
+    '400':
+      $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
+    '403':
+      $ref: '../responses/403.yaml'
+    '404':
+      $ref: '../responses/404.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'
\ No newline at end of file