Skip to content

Commit

Permalink
link to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnrushefsky committed Apr 22, 2024
1 parent f972de8 commit 3745cd7
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Kelpie shepherds long-running jobs through to completion on interruptible hardwa
- [API Authorization](#api-authorization)
- [Base URL](#base-url)
- [Queueing a job](#queueing-a-job)
- [`POST /job`](#post-job)
- [`POST /jobs`](#post-jobs)
- [Canceling a job](#canceling-a-job)
- [`DELETE /jobs/:id`](#delete-jobsid)
- [Checking on a job](#checking-on-a-job)
Expand Down Expand Up @@ -68,6 +68,7 @@ Additionally, your script must support the following things:
4. kelpie does not create, start, stop, or scale your container groups. It merely hands work out to your container group, and reallocates nodes that have exceeded their maximum failure threshold (5 failures). This reallocation behavior is dependent on adding the kelpie user to your Salad organization.

## API Authorization
There are live swagger docs that should be considered more accurate and up to date than this readme: https://kelpie.saladexamples.com/docs

Your kelpie api key is used by you to submit work, and also by kelpie workers to pull and process work.

Expand Down

0 comments on commit 3745cd7

Please sign in to comment.