diff --git a/awx/api/templates/api/_schedule_list_common.md b/awx/api/templates/api/_schedule_list_common.md new file mode 100644 index 0000000000..f602c1d59c --- /dev/null +++ b/awx/api/templates/api/_schedule_list_common.md @@ -0,0 +1,32 @@ + +POST requests to this resource must include a proper `rrule` value following +a particular format and conforming to the following rules: + +* DTSTART is required and must follow the following format: DTSTART:YYYYMMDDTHHMMSSZ +* DTSTART is expected to be in UTC +* INTERVAL is required +* SECONDLY is not supported +* TZID is not supported +* RRULE must preceed the rule statements +* BYDAY is supported but not BYDAY with a numerical prefix +* BYYEARDAY and BYWEEKNO are not supported +* Only one rrule statement per schedule is supported +* COUNT must be < 1000 + +Here are some example rrules: + +``` +"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5" +"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1" +"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z" +"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR" +"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO" +"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6" +"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU" +"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR" +"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU" +"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1" +"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU" +"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR" +"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z" +``` \ No newline at end of file diff --git a/awx/api/templates/api/inventory_source_schedules_list.md b/awx/api/templates/api/inventory_source_schedules_list.md new file mode 100644 index 0000000000..371fcfa269 --- /dev/null +++ b/awx/api/templates/api/inventory_source_schedules_list.md @@ -0,0 +1,3 @@ +{% extends "api/sub_list_create_api_view.md" %} + +{% extends "api/_schedule_list_common.md" %} diff --git a/awx/api/templates/api/job_template_schedules_list.md b/awx/api/templates/api/job_template_schedules_list.md new file mode 100644 index 0000000000..371fcfa269 --- /dev/null +++ b/awx/api/templates/api/job_template_schedules_list.md @@ -0,0 +1,3 @@ +{% extends "api/sub_list_create_api_view.md" %} + +{% extends "api/_schedule_list_common.md" %} diff --git a/awx/api/templates/api/project_schedules_list.md b/awx/api/templates/api/project_schedules_list.md new file mode 100644 index 0000000000..aca6cdf338 --- /dev/null +++ b/awx/api/templates/api/project_schedules_list.md @@ -0,0 +1,3 @@ +{% extends "api/sub_list_create_api_view.md" %} + +{% extends "api/_schedule_list_common.md" %} \ No newline at end of file