Skip to content

Commit 43c74b6

Browse files
committed
DOC-5034 Added missing enabled field to job_scheduler REST API references
1 parent 2f2632d commit 43c74b6

File tree

8 files changed

+67
-37
lines changed

8 files changed

+67
-37
lines changed

content/operate/rs/references/rest-api/objects/job_scheduler/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ An API object that represents the job scheduler settings in the cluster.
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| backup_job_settings | [backup_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/backup_job_settings" >}}) object | Backup job settings |
19-
| <span class="break-all">bdb_usage_report_job_settings</span> | <span class="break-all">[bdb_usage_report_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/bdb_usage_report_job_settings" >}})</span> object | Job settings for database usage report |
19+
| <span class="break-all">bdb_usage_report_job_settings</span> | <span class="break-all">[bdb_usage_report_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/bdb_usage_report_job_settings" >}})</span> object | Job settings for database usage reports |
2020
| <span class="break-all">cert_rotation_job_settings</span> | <span class="break-all">[cert_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/cert_rotation_job_settings" >}})</span> object | Job settings for internal certificate rotation |
2121
| <span class="break-all">log_rotation_job_settings</span> | <span class="break-all">[log_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/log_rotation_job_settings" >}})</span> object | Log rotation job settings |
2222
| <span class="break-all">node_checks_job_settings</span> | <span class="break-all">[node_checks_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/node_checks_job_settings" >}})</span> object | Node checks job settings |

content/operate/rs/references/rest-api/objects/job_scheduler/backup_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the backup schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |

content/operate/rs/references/rest-api/objects/job_scheduler/bdb_usage_report_job_settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ weight: $weight
1212

1313
| Name | Type/Value | Description |
1414
|------|------------|-------------|
15+
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the database usage report schedule |
1516
| enabled | boolean (default: true) | Indicates whether this job is enabled |
16-
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the certificate rotation schedule |
1717
| file_retention_days | integer, 1-1000 (default: 365) | Number of days after a file is closed before it is deleted |

content/operate/rs/references/rest-api/objects/job_scheduler/cert_rotation_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the certificate rotation schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |
1718
| expiry_days_before_rotation | integer, (range:&nbsp;1-90) (default:&nbsp;60) | Number of days before a certificate expires before rotation |

content/operate/rs/references/rest-api/objects/job_scheduler/log_rotation_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the log rotation schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |

content/operate/rs/references/rest-api/objects/job_scheduler/node_checks_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the node checks schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |

content/operate/rs/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the CCS rotation schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |
1718
| file_suffix | string (default:&nbsp;5min) | String added to the end of the rotated RDB files |
1819
| rotate_max_num | integer, (range:&nbsp;1-100) (default:&nbsp;24) | The maximum number of saved RDB files |

content/operate/rs/references/rest-api/requests/job_scheduler/_index.md

Lines changed: 60 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -54,24 +54,37 @@ Returns a [job_scheduler object]({{<relref "/operate/rs/references/rest-api/obje
5454

5555
```json
5656
{
57-
"backup_job_settings": {
58-
"cron_expression": "0 * * * *",
59-
"enabled": true
60-
},
61-
"redis_cleanup_job_settings": {
62-
"cron_expression": "0 * * * *",
63-
"enabled": true
64-
},
65-
"rotate_ccs_job_settings": {
66-
"cron_expression": "*/5 * * * *",
67-
"file_suffix": "5min",
68-
"rotate_max_num": 24,
69-
"enabled": true
70-
},
71-
"node_checks_job_settings": {
72-
"cron_expression": "*/5 * * * *",
73-
"enabled": false
74-
}
57+
"backup_job_settings": {
58+
"cron_expression": "*/5 * * * *",
59+
"enabled": true
60+
},
61+
"bdb_usage_report_job_settings": {
62+
"cron_expression": "0 */1 * * *",
63+
"enabled": false,
64+
"file_retention_days": 365
65+
},
66+
"cert_rotation_job_settings": {
67+
"cron_expression": "0 * * * *",
68+
"enabled": true,
69+
"expiry_days_before_rotation": 60
70+
},
71+
"log_rotation_job_settings": {
72+
"cron_expression": "*/5 * * * *",
73+
"enabled": true
74+
},
75+
"node_checks_job_settings": {
76+
"cron_expression": "0 * * * *",
77+
"enabled": true
78+
},
79+
"redis_cleanup_job_settings": {
80+
"cron_expression": "0 * * * *"
81+
},
82+
"rotate_ccs_job_settings": {
83+
"cron_expression": "*/5 * * * *",
84+
"enabled": true,
85+
"file_suffix": "5min",
86+
"rotate_max_num": 24
87+
}
7588
}
7689
```
7790

@@ -108,7 +121,7 @@ PUT /v1/job_scheduler
108121
```json
109122
{
110123
"backup_job_settings": {
111-
"cron_expression": "5 * * * *"
124+
"cron_expression": "*/10 * * * *"
112125
}
113126
}
114127
```
@@ -133,22 +146,34 @@ Returns a [job_scheduler object]({{<relref "/operate/rs/references/rest-api/obje
133146

134147
```json
135148
{
136-
"backup_job_settings": {
137-
"cron_expression": "5 * * * *",
138-
"enabled": false,
139-
},
140-
"redis_cleanup_job_settings": {
141-
"cron_expression": "0 * * * *"
142-
},
143-
"rotate_ccs_job_settings": {
144-
"cron_expression": "*/5 * * * *",
145-
"file_suffix": "5min",
146-
"rotate_max_num": 24
147-
},
148-
"node_checks_job_settings": {
149-
"cron_expression": "*/5 * * * *",
150-
"enabled": true,
151-
}
149+
"backup_job_settings": {
150+
"cron_expression": "*/10 * * * *",
151+
"enabled": true
152+
},
153+
"bdb_usage_report_job_settings": {
154+
"cron_expression": "0 */1 * * *",
155+
"enabled": false,
156+
"file_retention_days": 365
157+
},
158+
"cert_rotation_job_settings": {
159+
"cron_expression": "0 * * * *",
160+
"enabled": true,
161+
"expiry_days_before_rotation": 60
162+
},
163+
"log_rotation_job_settings": {
164+
"cron_expression": "*/5 * * * *",
165+
"enabled": true
166+
},
167+
"node_checks_job_settings": {
168+
"cron_expression": "0 * * * *",
169+
"enabled": true
170+
},
171+
"rotate_ccs_job_settings": {
172+
"cron_expression": "*/5 * * * *",
173+
"enabled": true,
174+
"file_suffix": "5min",
175+
"rotate_max_num": 24
176+
}
152177
}
153178
```
154179

0 commit comments

Comments
 (0)