Automated commit 'ISCCOMPLI-299: beta to v3 api migration of campaign…

… template GET operation (#1422) * ISCCOMPLI-299: beta to v3 api migration of campaign template GET operation' by github action: 6432781323
sailpoint-oss · Oct 6, 2023 · 3cef2dc · 3cef2dc
1 parent 6e0b273
commit 3cef2dc
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 6 deletions.
diff --git a/idn/beta/paths/campaign-template.yaml b/idn/beta/paths/campaign-template.yaml
@@ -6,6 +6,7 @@ get:
   description: Fetches a campaign template by ID.
   security:
     - UserContextAuth: [ idn:campaign-template:read ]
+  deprecated: true
   parameters:
     - in: path
       name: id

diff --git a/idn/v3/paths/campaign-template.yaml b/idn/v3/paths/campaign-template.yaml
@@ -31,12 +31,12 @@ patch:
           items:
             $ref: "../schemas/JsonPatchOperation.yaml"
         example:
-            - op: "replace"
-              path: "/description"
-              value: "Updated description!"
-            - op: "replace"
-              path: "/campaign/filter/id"
-              value: "ff80818155fe8c080155fe8d925b0316"
+          - op: "replace"
+            path: "/description"
+            value: "Updated description!"
+          - op: "replace"
+            path: "/campaign/filter/id"
+            value: "ff80818155fe8c080155fe8d925b0316"
   responses:
     '200':
       description: >-
@@ -64,5 +64,49 @@ patch:
       $ref: '../responses/404.yaml'
     '429':
       $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'
+get:
+  operationId: getCampaignTemplate
+  tags:
+    - 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
+      schema:
+        type: string
+      required: true
+      description: The desired campaign template's ID.
+      example: 2c9180835d191a86015d28455b4a2329
+  responses:
+    '200':
+      description: The data for the campaign matching the given ID.
+      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'