From 61525d8da409780ddb16cec83d3c21cf043babff Mon Sep 17 00:00:00 2001 From: Matthew Jones Date: Fri, 6 May 2016 14:45:00 -0400 Subject: [PATCH] Include more details on schedules endpoint --- awx/api/templates/api/_schedule_detail.md | 28 ++++++++++++++++++ .../templates/api/_schedule_list_common.md | 29 ++----------------- awx/api/templates/api/schedule_list.md | 7 +++++ 3 files changed, 37 insertions(+), 27 deletions(-) create mode 100644 awx/api/templates/api/_schedule_detail.md create mode 100644 awx/api/templates/api/schedule_list.md diff --git a/awx/api/templates/api/_schedule_detail.md b/awx/api/templates/api/_schedule_detail.md new file mode 100644 index 0000000000..4acd6a5288 --- /dev/null +++ b/awx/api/templates/api/_schedule_detail.md @@ -0,0 +1,28 @@ +The following lists the expected format and details of our rrules: + +* 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" diff --git a/awx/api/templates/api/_schedule_list_common.md b/awx/api/templates/api/_schedule_list_common.md index c7f9347e16..15632221a5 100644 --- a/awx/api/templates/api/_schedule_list_common.md +++ b/awx/api/templates/api/_schedule_list_common.md @@ -1,30 +1,5 @@ POST requests to this resource must include a proper `rrule` value following -a particular format and conforming to the following rules: +a particular format and conforming to subset of allowed 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" +{% include "api/_schedule_detail.md" %} diff --git a/awx/api/templates/api/schedule_list.md b/awx/api/templates/api/schedule_list.md new file mode 100644 index 0000000000..196169ff10 --- /dev/null +++ b/awx/api/templates/api/schedule_list.md @@ -0,0 +1,7 @@ +{% include "api/list_api_view.md" %} + +Schedule Details +================ +{% include "api/_schedule_detail.md" %} + +