Skip to content

Commit

Permalink
Fixes #540 - Document Search Endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcus Wasner committed Sep 15, 2015
1 parent ce44ce1 commit ba1b317
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ All examples in this section assume that you've found a running leader at `chron

- [Leaders](#leaders)
- [Listing Jobs](#listing-jobs)
- [Searching for a Job](#searching-for-a-job)
- [Deleting a Job](#deleting-a-job)
- [Deleting All Tasks for a Job](#deleting-all-tasks-for-a-job)
- [Manually Starting a Job](#manually-starting-a-job)
Expand Down Expand Up @@ -49,6 +50,16 @@ Interesting fields in the hashes are:

If there is a `parents` field there will be no `schedule` field, and vice-versa.

## Searching for a Job

Searching for a job with known attributes can be helpful when a large amount of jobs are being deployed. The list of possible attributes is described in the [Job Configuration](#job-configuration) section.

* Endpoint: __/scheduler/jobs/search__
* Method: __GET__
* Example: `curl -L -X GET chronos-node:8080/scheduler/jobs/search?name=request_event_counter_hourly`
* Example: `curl -L -X GET chronos-node:8080/scheduler/jobs/search?owner=foo@bar.io`
* Response: HTTP 204

## Deleting a Job

Get a job name from the job listing above.
Expand Down

0 comments on commit ba1b317

Please sign in to comment.