From 755bc194dcea3481fa41b5884a98a5aa086fe09e Mon Sep 17 00:00:00 2001 From: Israel Madueme Date: Thu, 5 Apr 2018 16:23:43 -0400 Subject: Bug 1449282 - add jobqueue_status api --- docs/en/rst/api/core/v1/bugzilla.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'docs') diff --git a/docs/en/rst/api/core/v1/bugzilla.rst b/docs/en/rst/api/core/v1/bugzilla.rst index 2dd40e0cb..e43472c30 100644 --- a/docs/en/rst/api/core/v1/bugzilla.rst +++ b/docs/en/rst/api/core/v1/bugzilla.rst @@ -300,3 +300,32 @@ name type description =============== ====== ==================================================== last_audit_time string The maximum of the at_time from the audit_log. =============== ====== ==================================================== + +Job Queue Status +---------------- + +Reports the status of the job queue. + +**Request** + +.. code-block:: text + + GET /rest/jobqueue_status + +This method requires an authenticated user. + +**Response** + +.. code-block:: js + + { + "total": 12, + "errors": 0 + } + +=============== ======= ==================================================== +name type description +=============== ======= ==================================================== +total integer The total number of jobs in the job queue. +errors integer The number of errors produced by jobs in the queue. +=============== ======= ==================================================== \ No newline at end of file -- cgit v1.2.3-24-g4f1b