Automated commit 'ISCCOMPLI-304 : Generate Campaign from template API…

… doc Beta to V3 Migration (#1431)

* Generate Campaign from template API doc Beta to V3 Migration

* resolved openAPI lint errors

* removed deprecated for v3' by github action: 6394738176

idn/beta/paths/campaign-template-generate.yaml

@@ -1,10 +1,11 @@
 post:
-  operationId: generateCampaignTemplate
+  operationId: startGenerateCampaignTemplate
   tags:
     - Certification Campaigns
   summary: Generate a Campaign from Template
-  # security:
-  #   - oauth2: [ORG_ADMIN]
+  deprecated: true
+  security:
+     - UserContextAuth: [idn:campaign-template:run]
   description: >-
     Generates a new campaign from a campaign template.
 
@@ -26,6 +27,7 @@ post:
         type: string
       required: true
       description: The ID of the campaign template to use for generation.
+      example: 2c9180835d191a86015d28455b4a2329
   responses:
     '200':
       description: >-

idn/sailpoint-api.v3.yaml

@@ -874,6 +874,8 @@ paths:
     $ref: './v3/paths/campaign-templates.yaml'
   /campaign-templates/{id}:
     $ref: './v3/paths/campaign-template.yaml'
+  /campaign-templates/{id}/generate:
+    $ref: './v3/paths/campaign-template-generate.yaml'
   /certifications:
     $ref: "./v3/paths/identity-certifications.yaml"
   /certifications/{id}:

idn/v3/paths/campaign-template-generate.yaml

@@ -0,0 +1,48 @@
+post:
+  operationId: startGenerateCampaignTemplate
+  tags:
+    - Certification Campaigns
+  summary: Generate a Campaign from Template
+  security:
+     - UserContextAuth: [idn:campaign-template:run]
+  description: >-
+    Generates a new campaign from a campaign template.
+
+    The campaign object contained in the template has special formatting applied to its name and description
+    fields in order to determine the generated campaign's name/description. Placeholders in those fields are
+    formatted with the current date and time upon generation.
+
+    Placeholders consist of a percent sign followed by a letter indicating what should be inserted; for
+    example, "%Y" will insert the current year; a campaign template named "Campaign for %y" would generate a
+    campaign called "Campaign for 2020" (assuming the year at generation time is 2020).
+
+    Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html).
+
+    Requires roles ORG_ADMIN.
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: string
+      required: true
+      description: The ID of the campaign template to use for generation.
+      example: 2c9180835d191a86015d28455b4a2329
+  responses:
+    '200':
+      description: >-
+        Indicates a campaign was successfully generated from this template, and returns a reference to the
+        new campaign.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/CampaignReference.yaml'
+    '400':
+      $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
+    '403':
+      $ref: '../responses/403.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'