Skip to content

Commit 20d2aff

Browse files
brosenberg42brosenberg42
authored
Add queue endpoint to REST API doc (#179)
1 parent ea81e81 commit 20d2aff

4 files changed

Lines changed: 394 additions & 34 deletions

File tree

‎docs/docs/html/REST-API.html‎

Lines changed: 182 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,11 @@ <h2>Version 8.0</h2>
179179
52.227-14, Alt. IV (DEC 2007).
180180
</font></i></p>
181181
<p><i><font size="3">
182-
Copyright 2023 The MITRE Corporation. All Rights Reserved.
182+
Copyright 2024 The MITRE Corporation. All Rights Reserved.
183183
</font></i></p>
184184
<br/>
185185
</div>
186-
<div class='footer'>Last updated on: December 22, 2023</div>
186+
<div class='footer'>Last updated on: March 19, 2024</div>
187187
<div class="coverHeadings">
188188
<h1>Introduction</h1>
189189
</div>
@@ -230,6 +230,7 @@ <h2 class="toc-section">1. Definitions</h2>
230230
<div class="toc-entry">Algorithm.Requires</div>
231231
<div class="toc-entry">TiesDbRepostResponse</div>
232232
<div class="toc-entry">TiesDbRepostResponse.Failure</div>
233+
<div class="toc-entry">QueueInfo</div>
233234

234235

235236
<div style='page-break-after:always'></div>
@@ -274,6 +275,8 @@ <h2 class="toc-section">2. Paths</h2>
274275
<div class="toc-entry">GET &nbsp;&nbsp;/rest/algorithms</div>
275276
<div class="toc-entry">GET &nbsp;&nbsp;/rest/algorithms/{name}</div>
276277
<div class="toc-entry">POST &nbsp;&nbsp;/rest/jobs/tiesdbrepost</div>
278+
<div class="toc-entry">GET &nbsp;&nbsp;/rest/queues</div>
279+
<div class="toc-entry">GET &nbsp;&nbsp;/rest/queues/{name}</div>
277280
<div style='page-break-after:always'></div>
278281
</div>
279282
<div style='page-break-after:always'></div>
@@ -1893,6 +1896,36 @@ <h3 class="numbered-content">TiesDbRepostResponse.Failure</h3>
18931896
</table>
18941897
<br />
18951898
</div>
1899+
<div class="div-container-margin">
1900+
<h3 class="numbered-content">QueueInfo</h3>
1901+
<hr />
1902+
<table class='table-margin'>
1903+
<thead>
1904+
<tr>
1905+
<th class='th-heading'><b>Name</b></th>
1906+
<th class='th-heading-small'><b>Type</b></th>
1907+
<th class='th-heading'><b>Description</b></th>
1908+
</tr>
1909+
</thead>
1910+
<tbody>
1911+
<tr style=';background-color: #EAEAEA'>
1912+
<td style='width:30%;'>name</td>
1913+
<td style='width:10%;'>string</td>
1914+
<td style='width:30%;'>
1915+
The name of the queue.
1916+
</td>
1917+
</tr>
1918+
<tr>
1919+
<td style='width:30%;'>messagesInQueue</td>
1920+
<td style='width:10%;'>integer</td>
1921+
<td style='width:30%;'>
1922+
The number of messages currently in the queue.
1923+
</td>
1924+
</tr>
1925+
</tbody>
1926+
</table>
1927+
<br />
1928+
</div>
18961929

18971930
<div style='page-break-after:always'></div>
18981931
<h2 class="content-section">2. Paths</h2>
@@ -5749,5 +5782,152 @@ <h2 class="content-section">2. Paths</h2>
57495782
</table>
57505783
</div>
57515784
</div>
5785+
5786+
<div class="div-container-margin">
5787+
<pre class="get"><code class="huge"><span class="numbered-content">GET</span>&nbsp;&nbsp;/rest/queues</code></pre>
5788+
<div>
5789+
<table class='table-margin'>
5790+
<tr>
5791+
<td class='td-alignment-small'><b>Summary</b></td>
5792+
<td class='td-alignment-std'>
5793+
Gets information about all ActiveMQ queues.
5794+
</td>
5795+
</tr>
5796+
<tr style=';background-color: #EAEAEA'>
5797+
<td class='td-alignment-small'><b>Description</b></td>
5798+
<td class='td-alignment-std'>
5799+
</td>
5800+
</tr>
5801+
<tr>
5802+
<td class='td-alignment-small'><b>Operation Id</b></td>
5803+
<td class='td-alignment-std'></td>
5804+
</tr>
5805+
<tr style=';background-color: #EAEAEA'>
5806+
<td class='td-alignment-small'><b>Produces</b></td>
5807+
<td class='td-alignment-std'>array&lt;QueueInfo&gt;</td>
5808+
</tr>
5809+
<tr>
5810+
<td class='td-alignment-small'><b>Tags</b></td>
5811+
</tr>
5812+
<tr>
5813+
<td class='td-alignment-small'><b>Responses</b></td>
5814+
<td class='td-alignment-std' style='padding-left:0px!important;margin-left:0px!important'>
5815+
<table class='table-margin'>
5816+
<tr>
5817+
<td class='td-alignment-small'><b>code</b></td>
5818+
<td class='td-alignment-std'><b>description</b></td>
5819+
</tr>
5820+
<tr>
5821+
<td class='td-alignment-small'>200</td>
5822+
<td class='td-alignment-std'>
5823+
Success
5824+
</td>
5825+
</tr>
5826+
<tr>
5827+
<td class='td-alignment-small'>401</td>
5828+
<td class='td-alignment-std'>
5829+
Bad credentials.
5830+
</td>
5831+
</tr>
5832+
</table>
5833+
</td>
5834+
</tr>
5835+
</table>
5836+
</div>
5837+
</div>
5838+
5839+
<div class="div-container-margin">
5840+
<pre class="get"><code class="huge"><span class="numbered-content">GET</span>&nbsp;&nbsp; /rest/queues/{name}</code></pre>
5841+
<div>
5842+
<table class='table-margin'>
5843+
<tr>
5844+
<td class='td-alignment-small'><b>Summary</b></td>
5845+
<td class='td-alignment-std'>
5846+
Gets information about a single ActiveMQ queue.
5847+
</td>
5848+
</tr>
5849+
<tr style=';background-color: #EAEAEA'>
5850+
<td class='td-alignment-small'><b>Description</b></td>
5851+
<td class='td-alignment-std'>
5852+
</td>
5853+
</tr>
5854+
<tr>
5855+
<td class='td-alignment-small'><b>Operation Id</b></td>
5856+
<td class='td-alignment-std'></td>
5857+
</tr>
5858+
<tr style=';background-color: #EAEAEA'>
5859+
<td class='td-alignment-small'><b>Produces</b></td>
5860+
<td class='td-alignment-std'>QueueInfo</td>
5861+
</tr>
5862+
<tr>
5863+
<td class='td-alignment-small'><b>Parameters</b></td>
5864+
<td class='td-alignment-std' style='padding-left:0px!important;margin-left:0px!important'>
5865+
<table class='table-margin'>
5866+
<thead>
5867+
<tr>
5868+
<td class='small-heading'>Name</td>
5869+
<td class='small-heading'>In</td>
5870+
<td class='small-heading'>Description</td>
5871+
<td class='small-heading'>Required</td>
5872+
<td class='small-heading'>Type</td>
5873+
<td class='small-heading'>Format</td>
5874+
<td class='small-heading'>Collection Format</td>
5875+
<td class='small-heading'>Default</td>
5876+
<td class='small-heading'>Min</td>
5877+
<td class='small-heading'>Max</td>
5878+
</tr>
5879+
</thead>
5880+
<tbody>
5881+
<tr style=';background-color: #EAEAEA'>
5882+
<td class='td-alignment-small-no-width'>name</td>
5883+
<td class='td-alignment-small-no-width'>path</td>
5884+
<td class='td-alignment-small-no-width'>Queue Name</td>
5885+
<td class='td-alignment-small-no-width'>Yes</td>
5886+
<td class='td-alignment-small-no-width'>string</td>
5887+
<td class='td-alignment-small-no-width'></td>
5888+
<td class='td-alignment-small-no-width'></td>
5889+
<td class='td-alignment-small-no-width'></td>
5890+
<td class='td-alignment-small-no-width'></td>
5891+
<td class='td-alignment-small-no-width'></td>
5892+
</tr>
5893+
</tbody>
5894+
</table>
5895+
</td>
5896+
</tr>
5897+
<tr>
5898+
<td class='td-alignment-small'><b>Tags</b></td>
5899+
</tr>
5900+
<tr>
5901+
<td class='td-alignment-small'><b>Responses</b></td>
5902+
<td class='td-alignment-std' style='padding-left:0px!important;margin-left:0px!important'>
5903+
<table class='table-margin'>
5904+
<tr>
5905+
<td class='td-alignment-small'><b>code</b></td>
5906+
<td class='td-alignment-std'><b>description</b></td>
5907+
</tr>
5908+
<tr>
5909+
<td class='td-alignment-small'>200</td>
5910+
<td class='td-alignment-std'>
5911+
Success
5912+
</td>
5913+
</tr>
5914+
<tr>
5915+
<td class='td-alignment-small'>401</td>
5916+
<td class='td-alignment-std'>
5917+
Bad credentials.
5918+
</td>
5919+
</tr>
5920+
<tr>
5921+
<td class='td-alignment-small'>404</td>
5922+
<td class='td-alignment-std'>
5923+
There was no queue with the given name.
5924+
</td>
5925+
</tr>
5926+
</table>
5927+
</td>
5928+
</tr>
5929+
</table>
5930+
</div>
5931+
</div>
57525932
</body>
57535933
</html>

0 commit comments

Comments
 (0)