Skip to content

Commit

Permalink
Added more to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Digant C Kasundra committed May 20, 2015
1 parent 908a079 commit f454e4e
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,5 +188,75 @@ Events can also be expanded in other queries, like host queries. Never
expand both host and event in a query or you will trigger infinite
expansion.

### Fates ###

To get fates, use `/api/v1/fates`

{
limit: int,
page: int,
totalFates: int,
fates: [
{
id: int,
creationEventType: {
id: int,
category: string,
state: string,
description: string,
},
completionEventType: {
id: int,
category: string,
state: string,
description: string,
},
intermediate: true|false,
description: string,
},
...
],
}

### Labors ###

To get laboes, use `/api/v1/labors/`

{
limit: int,
page: int,
totalFates: int,
labors: [
{
id: int,
quest: {
id: int,
embarkTime: timestamp,
completionTime: timestamp,
creator: string,
description: string,
},
host: {
id: int,
hostname: string,
},
creationTime: timestamp,
ackTime: timestamp,
ackUser: string,
completionTime: timestamp,
creationEvent: {
id: int,
timestamp: timestamp,
user: string,
note: string,
},
completionEvent: {
id: int,
timestamp: timestamp,
user: string,
note: string,
},
},
...
],
}

0 comments on commit f454e4e

Please sign in to comment.