diff --git a/idn/sailpoint-api.v3.yaml b/idn/sailpoint-api.v3.yaml index c4aafff3..5846def0 100644 --- a/idn/sailpoint-api.v3.yaml +++ b/idn/sailpoint-api.v3.yaml @@ -874,8 +874,6 @@ paths: $ref: './v3/paths/campaign-templates.yaml' /campaign-templates/{id}: $ref: './v3/paths/campaign-template.yaml' - /campaign-templates/{id}/schedule: - $ref: './v3/paths/campaign-template-schedule.yaml' /certifications: $ref: "./v3/paths/identity-certifications.yaml" /certifications/{id}: diff --git a/idn/v3/paths/campaign-template-schedule.yaml b/idn/v3/paths/campaign-template-schedule.yaml deleted file mode 100644 index cf1bd7e4..00000000 --- a/idn/v3/paths/campaign-template-schedule.yaml +++ /dev/null @@ -1,105 +0,0 @@ -put: - operationId: setCampaignTemplateSchedule - tags: - - Certification Campaigns - summary: Sets a Campaign Template's Schedule - 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 ] - parameters: - - in: path - name: id - schema: - type: string - required: true - description: The ID of the campaign template being scheduled. - example: "04bedce387bd47b2ae1f86eb0bb36dee" - requestBody: - content: - application/json: - schema: - $ref: '../schemas/Schedule.yaml' - examples: - 'Monthly': - description: Runs on the 15th and last day of the month, at 5PM. - value: - type: MONTHLY - hours: - type: LIST - values: - - "17" - days: - type: LIST - values: - - "15" - 'Once a year': - description: Runs every January 1st at midnight. - value: - type: ANNUALLY - hours: - type: LIST - values: - - "0" - days: - type: LIST - values: - - "--01-01" - 'Quarterly': - description: Runs once a quarter (every 3 months) on the first of the month at 1AM. - value: - type: ANNUALLY - hours: - type: LIST - values: - - "1" - days: - type: LIST - values: - - "1" - months: - type: LIST - values: - - "1" - interval: 3 - 'Yearly on Specific Days': - description: Runs on March 12 and December 5 at 1AM, every year. - value: - type: ANNUALLY - hours: - type: LIST - values: - - "1" - days: - type: LIST - values: - - "--03-12" - - "--12-05" - 'On a Specific Date': - description: Runs at 1AM on February 18th, 2020 - value: - type: CALENDAR - hours: - type: LIST - values: - - "1" - days: - type: LIST - values: - - "2020-02-18" - responses: - '204': - $ref: '../responses/204.yaml' - '401': - $ref: '../responses/401.yaml' - '403': - $ref: '../responses/403.yaml' - '400': - $ref: '../responses/400.yaml' - '404': - $ref: '../responses/404.yaml' - '429': - $ref: '../responses/429.yaml' - '500': - $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/idn/v3/schemas/Schedule.yaml b/idn/v3/schemas/Schedule.yaml deleted file mode 100644 index de0dbc55..00000000 --- a/idn/v3/schemas/Schedule.yaml +++ /dev/null @@ -1,173 +0,0 @@ -type : object -properties: - type: - type: string - description: >- - Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type - can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule - can have both 'hours' and 'days' set. - enum: - - WEEKLY - - MONTHLY - - ANNUALLY - - CALENDAR - example: - WEEKLY - months: - type: object - description: | - Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: - - On February and March: - * type LIST - * values "2", "3" - - Every 3 months, starting in January (quarterly): - * type LIST - * values "1" - * interval 3 - - Every two months between July and December: - * type RANGE - * values "7", "12" - * interval 2 - properties: - type: - type: string - description: Enum type to specify months value - enum: - - LIST - - RANGE - example: - LIST - values: - type: array - description: - Values of the months based on the enum type mentioned above - items: - type: string - example: - - "1" - interval: - type: integer - example: 2 - format: int64 - description: Interval between the cert generations - required: - - type - - values - days: - type: object - description: | - Specifies which day(s) a schedule is active for. This is required for all schedule types. - The "values" field holds different data depending on the type of schedule: - * WEEKLY: days of the week (1-7) - * MONTHLY: days of the month (1-31, L, L-1...) - * ANNUALLY: if the "months" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year ("--12-31") - * CALENDAR: ISO-8601 dates ("2020-12-31") - - Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided - with ISO-8601 dates without year. - - Examples: - - On Sundays: - * type LIST - * values "1" - - The second to last day of the month: - * type LIST - * values "L-1" - - From the 20th to the last day of the month: - * type RANGE - * values "20", "L" - - Every March 2nd: - * type LIST - * values "--03-02" - - On March 2nd, 2021: - * type: LIST - * values "2021-03-02" - properties: - type: - type: string - description: Enum type to specify days value - enum: - - LIST - - RANGE - example: LIST - values: - type: array - description: - Values of the days based on the enum type mentioned above - items: - type: string - example: - - "1" - interval: - type: integer - example: 2 - format: int64 - description: Interval between the cert generations - required: - - type - - values - hours: - type: object - description: | - Specifies which hour(s) a schedule is active for. Examples: - - Every three hours starting from 8AM, inclusive: - * type LIST - * values "8" - * interval 3 - - During business hours: - * type RANGE - * values "9", "5" - - At 5AM, noon, and 5PM: - * type LIST - * values "5", "12", "17" - properties: - type: - type: string - description: Enum type to specify hours value - enum: - - LIST - - RANGE - example: - LIST - values: - type: array - description: - Values of the days based on the enum type mentioned above - items: - type: string - example: - - "1" - interval: - type: integer - format: int64 - example: 2 - description: Interval between the cert generations - required: - - type - - values - expiration: - type: string - format: date-time - description: >- - Specifies the time after which this schedule will no longer occur. - example: "2022-09-19 13:55:26" - timeZoneId: - type: string - description: >- - The time zone to use when running the schedule. For instance, if the schedule is scheduled - to run at 1AM, and this field is set to "CST", the schedule will run at 1AM CST. - example: "CST" -required: - - type - - hours \ No newline at end of file