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

+
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
namestring + The name of the queue. +
messagesInQueueinteger + 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
Producesarray<QueueInfo>
Tags
Responses + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
+
+
+
+ +
+
GET   /rest/queues/{name}
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets information about a single ActiveMQ queue. +
Description +
Operation Id
ProducesQueueInfo
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathQueue NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no queue with the given name. +
+
+
+
diff --git a/docs/site/html/REST-API.html b/docs/site/html/REST-API.html index 9a3985d145f1..955623999892 100644 --- a/docs/site/html/REST-API.html +++ b/docs/site/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

+
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
namestring + The name of the queue. +
messagesInQueueinteger + 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
Producesarray<QueueInfo>
Tags
Responses + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
+
+
+
+ +
+
GET   /rest/queues/{name}
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary + Gets information about a single ActiveMQ queue. +
Description +
Operation Id
ProducesQueueInfo
Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameInDescriptionRequiredTypeFormatCollection FormatDefaultMinMax
namepathQueue NameYesstring
+
Tags
Responses + + + + + + + + + + + + + + + + + +
codedescription
200 + Success +
401 + Bad credentials. +
404 + There was no queue with the given name. +
+
+
+
diff --git a/docs/site/index.html b/docs/site/index.html index 045833672853..d7279d91fec8 100644 --- a/docs/site/index.html +++ b/docs/site/index.html @@ -396,5 +396,5 @@

Overview

diff --git a/docs/site/sitemap.xml b/docs/site/sitemap.xml index 14971e45ee9f..440043f913f1 100644 --- a/docs/site/sitemap.xml +++ b/docs/site/sitemap.xml @@ -2,147 +2,147 @@ /index.html - 2024-02-05 + 2024-03-19 daily /Release-Notes/index.html - 2024-02-05 + 2024-03-19 daily /License-And-Distribution/index.html - 2024-02-05 + 2024-03-19 daily /Acknowledgements/index.html - 2024-02-05 + 2024-03-19 daily /Install-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Admin-Guide/index.html - 2024-02-05 + 2024-03-19 daily /User-Guide/index.html - 2024-02-05 + 2024-03-19 daily /OpenID-Connect-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Media-Segmentation-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Feed-Forward-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Derivative-Media-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Object-Storage-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Markup-Guide/index.html - 2024-02-05 + 2024-03-19 daily /TiesDb-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Trigger-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Roll-Up-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Health-Check-Guide/index.html - 2024-02-05 + 2024-03-19 daily /REST-API/index.html - 2024-02-05 + 2024-03-19 daily /Component-API-Overview/index.html - 2024-02-05 + 2024-03-19 daily /Component-Descriptor-Reference/index.html - 2024-02-05 + 2024-03-19 daily /CPP-Batch-Component-API/index.html - 2024-02-05 + 2024-03-19 daily /Python-Batch-Component-API/index.html - 2024-02-05 + 2024-03-19 daily /Java-Batch-Component-API/index.html - 2024-02-05 + 2024-03-19 daily /GPU-Support-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Contributor-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Development-Environment-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Node-Guide/index.html - 2024-02-05 + 2024-03-19 daily /Workflow-Manager-Architecture/index.html - 2024-02-05 + 2024-03-19 daily /CPP-Streaming-Component-API/index.html - 2024-02-05 + 2024-03-19 daily \ No newline at end of file