From 691a7d3dc1525b33f180db21b0ecd93242993ec4 Mon Sep 17 00:00:00 2001
From: Brian Rosenberg
Date: Tue, 19 Mar 2024 08:33:38 -0400
Subject: [PATCH] Add queue endpoint to REST API doc
---
docs/docs/html/REST-API.html | 184 ++++++++++++++++++++++++++++++++++-
docs/site/html/REST-API.html | 184 ++++++++++++++++++++++++++++++++++-
docs/site/index.html | 2 +-
docs/site/sitemap.xml | 58 +++++------
4 files changed, 394 insertions(+), 34 deletions(-)
diff --git a/docs/docs/html/REST-API.html b/docs/docs/html/REST-API.html
index 9a3985d145f1..955623999892 100644
--- a/docs/docs/html/REST-API.html
+++ b/docs/docs/html/REST-API.html
@@ -179,11 +179,11 @@ Version 8.0
52.227-14, Alt. IV (DEC 2007).
- Copyright 2023 The MITRE Corporation. All Rights Reserved.
+ Copyright 2024 The MITRE Corporation. All Rights Reserved.
-
+
Introduction
@@ -230,6 +230,7 @@ 1. Definitions
Algorithm.Requires
TiesDbRepostResponse
TiesDbRepostResponse.Failure
+ QueueInfo
@@ -274,6 +275,8 @@ 2. Paths
GET /rest/algorithms
GET /rest/algorithms/{name}
POST /rest/jobs/tiesdbrepost
+ GET /rest/queues
+ GET /rest/queues/{name}
@@ -1893,6 +1896,36 @@ TiesDbRepostResponse.Failure
+
+
QueueInfo
+
+
+
+
+ Name |
+ Type |
+ Description |
+
+
+
+
+ name |
+ string |
+
+ The name of the queue.
+ |
+
+
+ messagesInQueue |
+ integer |
+
+ The number of messages currently in the queue.
+ |
+
+
+
+
+
2. Paths
@@ -5749,5 +5782,152 @@ 2. Paths
+
+
+
GET /rest/queues
+
+
+
+ Summary |
+
+ Gets information about all ActiveMQ queues.
+ |
+
+
+ Description |
+
+ |
+
+
+ Operation Id |
+ |
+
+
+ Produces |
+ array<QueueInfo> |
+
+
+ Tags |
+
+
+ Responses |
+
+
+
+ code |
+ description |
+
+
+ 200 |
+
+ Success
+ |
+
+
+ 401 |
+
+ Bad credentials.
+ |
+
+
+ |
+
+
+
+
+
+
+
GET /rest/queues/{name}
+
+
+
+ Summary |
+
+ Gets information about a single ActiveMQ queue.
+ |
+
+
+ Description |
+
+ |
+
+
+ Operation Id |
+ |
+
+
+ Produces |
+ QueueInfo |
+
+
+ Parameters |
+
+
+
+
+ Name |
+ In |
+ Description |
+ Required |
+ Type |
+ Format |
+ Collection Format |
+ Default |
+ Min |
+ Max |
+
+
+
+
+ name |
+ path |
+ Queue Name |
+ Yes |
+ string |
+ |
+ |
+ |
+ |
+ |
+
+
+
+ |
+
+
+ Tags |
+
+
+ Responses |
+
+
+
+ code |
+ description |
+
+
+ 200 |
+
+ Success
+ |
+
+
+ 401 |
+
+ Bad credentials.
+ |
+
+
+ 404 |
+
+ There was no queue with the given name.
+ |
+
+
+ |
+
+
+
+