From 0eab5d8e17f277c45070b237069ce4097c9121b6 Mon Sep 17 00:00:00 2001 From: Chris Carroux Date: Wed, 2 Sep 2015 18:25:03 -0700 Subject: [PATCH] Document the job name criteria --- docs/docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/api.md b/docs/docs/api.md index 351c9397c..177194eaa 100644 --- a/docs/docs/api.md +++ b/docs/docs/api.md @@ -84,7 +84,7 @@ You can manually start a job by issuing an HTTP request. The heart of job scheduling is a JSON POST request. The JSON hash you send to Chronos should contain the following fields: -* `name`: The job name +* `name`: The job name. Must contain at least one character and may only contain letters (`[a-zA-Z]`), digits (`[0-9]`), dashes (`-`), underscores (`_`), number signs (`#`), and whitespace (`[ \t\n\x0B\f\r]`). Must match the following regular expression: `([\w\s#_-]+)` * `command`: The actual command that will be executed by Chronos * `schedule`: The scheduling for the job, in [ISO 8601][] format. Consists of 3 parts separated by `/`: * The number of times to repeat the job: `Rn` to repeat `n` times, or `R` to repeat forever