Skip to content

Commit 574db87

Browse files
authored
Merge pull request #1361 from HubSpot/0_13_0_docs
Release docs for 0.13.0
2 parents 115bbde + 0107641 commit 574db87

File tree

11 files changed

+473
-632
lines changed

11 files changed

+473
-632
lines changed

Docs/reference/api.md

Lines changed: 229 additions & 95 deletions
Large diffs are not rendered by default.

Docs/reference/apidocs/api-disasters.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@ Do not allow the automated poller to disable actions when a disaster is detected
128128

129129

130130
- - -
131-
#### **POST** `/api/disasters/active/{type}`
131+
#### **DELETE** `/api/disasters/active/{type}`
132132

133-
Create a new active disaster
133+
Remove an active disaster (make it inactive)
134134

135135

136136
###### Parameters
@@ -151,9 +151,9 @@ Create a new active disaster
151151

152152

153153
- - -
154-
#### **DELETE** `/api/disasters/active/{type}`
154+
#### **POST** `/api/disasters/active/{type}`
155155

156-
Remove an active disaster (make it inactive)
156+
Create a new active disaster
157157

158158

159159
###### Parameters

Docs/reference/apidocs/api-logs.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,37 @@ Retrieve the list of logs stored in S3 for a specific task.
2929
| - | - | - |
3030

3131

32+
- - -
33+
#### **GET** `/api/logs/request/{requestId}/read`
34+
35+
Retrieve the list of logs stored in S3 for a specific request.
36+
37+
38+
###### Parameters
39+
**path**
40+
41+
| Parameter | Required | Description | Data Type |
42+
|-----------|----------|-------------|-----------|
43+
| requestId | true | The request ID to search for | string |
44+
**query**
45+
46+
| Parameter | Required | Description | Data Type |
47+
|-----------|----------|-------------|-----------|
48+
| key | false | S3 Key for the log to read | string |
49+
| offset | false | Offset to read in the log file | long |
50+
| length | false | Length in bytes to read | int |
51+
| reverse | false | Read backwards from offset | boolean |
52+
53+
###### Response
54+
[MesosFileChunkObject](models.md#model-MesosFileChunkObject)
55+
56+
57+
###### Errors
58+
| Status Code | Reason | Response Model |
59+
|-------------|-------------|----------------|
60+
| - | - | - |
61+
62+
3263
- - -
3364
#### **GET** `/api/logs/request/{requestId}/deploy/{deployId}`
3465

Docs/reference/apidocs/api-racks.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,29 @@ Freeze a specific rack
2222

2323

2424

25+
###### Errors
26+
| Status Code | Reason | Response Model |
27+
|-------------|-------------|----------------|
28+
| - | - | - |
29+
30+
31+
- - -
32+
#### **DELETE** `/api/racks/rack/{rackId}/expiring`
33+
34+
Delete any expiring machine state changes for this rack
35+
36+
37+
###### Parameters
38+
**path**
39+
40+
| Parameter | Required | Description | Data Type |
41+
|-----------|----------|-------------|-----------|
42+
| rackId | true | Active slaveId | string |
43+
44+
###### Response
45+
46+
47+
2548
###### Errors
2649
| Status Code | Reason | Response Model |
2750
|-------------|-------------|----------------|
@@ -124,6 +147,25 @@ Remove a known rack, erasing history. This operation will cancel decommissioning
124147

125148

126149

150+
###### Errors
151+
| Status Code | Reason | Response Model |
152+
|-------------|-------------|----------------|
153+
| - | - | - |
154+
155+
156+
- - -
157+
#### **GET** `/api/racks/expiring`
158+
159+
Get all expiring state changes for all racks
160+
161+
162+
###### Parameters
163+
- No parameters
164+
165+
###### Response
166+
[List[SingularityExpiringMachineState]](models.md#model-SingularityExpiringMachineState)
167+
168+
127169
###### Errors
128170
| Status Code | Reason | Response Model |
129171
|-------------|-------------|----------------|

0 commit comments

Comments
 (0)