Skip to content

Commit c9ecff8

Browse files
committed
Refresh the API autogenerated documentation file:
- include 'dst_file_report' flag - 'overwrite_flag' is now string type - notes on "GET /jobs" controller
1 parent 240890d commit c9ecff8

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/api.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1119,6 +1119,9 @@ Get a list of active jobs, or those that match the filter requirements
11191119
##### Returns
11201120
Array of [Job](#job)
11211121

1122+
##### Notes
1123+
To prevent heavy queries, only non-terminal (e.g.: ACTIVE) jobs are listed.<br/>If 'state_in' argument is requested, make sure to also provide either 'limit' or 'time_window' to get completed jobs
1124+
11221125
##### Query arguments
11231126

11241127
|Name |Type |Required|Description |
@@ -1146,6 +1149,9 @@ Get a list of active jobs, or those that match the filter requirements
11461149
##### Returns
11471150
Array of [Job](#job)
11481151

1152+
##### Notes
1153+
To prevent heavy queries, only non-terminal (e.g.: ACTIVE) jobs are listed.<br/>If 'state_in' argument is requested, make sure to also provide either 'limit' or 'time_window' to get completed jobs
1154+
11491155
##### Query arguments
11501156

11511157
|Name |Type |Required|Description |
@@ -1561,6 +1567,7 @@ Models
15611567
|-------------------|--------|
15621568
|cred_id |string |
15631569
|user_dn |string |
1570+
|dst_file_report |boolean |
15641571
|retry |integer |
15651572
|job_id |string |
15661573
|cancel_job |boolean |
@@ -1586,7 +1593,7 @@ Models
15861593
|target_qos |string |
15871594
|verify_checksum |string |
15881595
|job_finished |dateTime|
1589-
|overwrite_flag |boolean |
1596+
|overwrite_flag |string |
15901597

15911598
### Job
15921599

@@ -1595,6 +1602,7 @@ Models
15951602
|cred_id |string |
15961603
|user_dn |string |
15971604
|job_type |string |
1605+
|dst_file_report |boolean |
15981606
|retry |integer |
15991607
|job_id |string |
16001608
|cancel_job |boolean |
@@ -1620,7 +1628,7 @@ Models
16201628
|target_qos |string |
16211629
|verify_checksum |string |
16221630
|job_finished |dateTime|
1623-
|overwrite_flag |boolean |
1631+
|overwrite_flag |string |
16241632

16251633
### File
16261634

0 commit comments

Comments
 (0)