Document the job name criteria

mesos · Sep 3, 2015 · 0eab5d8 · 0eab5d8 · robsonpeixoto · Jul 20, 2016
1 parent 9de3529
commit 0eab5d8
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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