Skip to content

Add queue endpoint to REST API doc #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 19, 2024
Merged

Add queue endpoint to REST API doc #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 182 additions & 2 deletions docs/docs/html/REST-API.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,11 @@ <h2>Version 8.0</h2>
52.227-14, Alt. IV (DEC 2007).
</font></i></p>
<p><i><font size="3">
Copyright 2023 The MITRE Corporation. All Rights Reserved.
Copyright 2024 The MITRE Corporation. All Rights Reserved.
</font></i></p>
<br/>
</div>
<div class='footer'>Last updated on: December 22, 2023</div>
<div class='footer'>Last updated on: March 19, 2024</div>
<div class="coverHeadings">
<h1>Introduction</h1>
</div>
Expand Down Expand Up @@ -230,6 +230,7 @@ <h2 class="toc-section">1. Definitions</h2>
<div class="toc-entry">Algorithm.Requires</div>
<div class="toc-entry">TiesDbRepostResponse</div>
<div class="toc-entry">TiesDbRepostResponse.Failure</div>
<div class="toc-entry">QueueInfo</div>


<div style='page-break-after:always'></div>
Expand Down Expand Up @@ -274,6 +275,8 @@ <h2 class="toc-section">2. Paths</h2>
<div class="toc-entry">GET &nbsp;&nbsp;/rest/algorithms</div>
<div class="toc-entry">GET &nbsp;&nbsp;/rest/algorithms/{name}</div>
<div class="toc-entry">POST &nbsp;&nbsp;/rest/jobs/tiesdbrepost</div>
<div class="toc-entry">GET &nbsp;&nbsp;/rest/queues</div>
<div class="toc-entry">GET &nbsp;&nbsp;/rest/queues/{name}</div>
<div style='page-break-after:always'></div>
</div>
<div style='page-break-after:always'></div>
Expand Down Expand Up @@ -1893,6 +1896,36 @@ <h3 class="numbered-content">TiesDbRepostResponse.Failure</h3>
</table>
<br />
</div>
<div class="div-container-margin">
<h3 class="numbered-content">QueueInfo</h3>
<hr />
<table class='table-margin'>
<thead>
<tr>
<th class='th-heading'><b>Name</b></th>
<th class='th-heading-small'><b>Type</b></th>
<th class='th-heading'><b>Description</b></th>
</tr>
</thead>
<tbody>
<tr style=';background-color: #EAEAEA'>
<td style='width:30%;'>name</td>
<td style='width:10%;'>string</td>
<td style='width:30%;'>
The name of the queue.
</td>
</tr>
<tr>
<td style='width:30%;'>messagesInQueue</td>
<td style='width:10%;'>integer</td>
<td style='width:30%;'>
The number of messages currently in the queue.
</td>
</tr>
</tbody>
</table>
<br />
</div>

<div style='page-break-after:always'></div>
<h2 class="content-section">2. Paths</h2>
Expand Down Expand Up @@ -5749,5 +5782,152 @@ <h2 class="content-section">2. Paths</h2>
</table>
</div>
</div>

<div class="div-container-margin">
<pre class="get"><code class="huge"><span class="numbered-content">GET</span>&nbsp;&nbsp;/rest/queues</code></pre>
<div>
<table class='table-margin'>
<tr>
<td class='td-alignment-small'><b>Summary</b></td>
<td class='td-alignment-std'>
Gets information about all ActiveMQ queues.
</td>
</tr>
<tr style=';background-color: #EAEAEA'>
<td class='td-alignment-small'><b>Description</b></td>
<td class='td-alignment-std'>
</td>
</tr>
<tr>
<td class='td-alignment-small'><b>Operation Id</b></td>
<td class='td-alignment-std'></td>
</tr>
<tr style=';background-color: #EAEAEA'>
<td class='td-alignment-small'><b>Produces</b></td>
<td class='td-alignment-std'>array&lt;QueueInfo&gt;</td>
</tr>
<tr>
<td class='td-alignment-small'><b>Tags</b></td>
</tr>
<tr>
<td class='td-alignment-small'><b>Responses</b></td>
<td class='td-alignment-std' style='padding-left:0px!important;margin-left:0px!important'>
<table class='table-margin'>
<tr>
<td class='td-alignment-small'><b>code</b></td>
<td class='td-alignment-std'><b>description</b></td>
</tr>
<tr>
<td class='td-alignment-small'>200</td>
<td class='td-alignment-std'>
Success
</td>
</tr>
<tr>
<td class='td-alignment-small'>401</td>
<td class='td-alignment-std'>
Bad credentials.
</td>
</tr>
</table>
</td>
</tr>
</table>
</div>
</div>

<div class="div-container-margin">
<pre class="get"><code class="huge"><span class="numbered-content">GET</span>&nbsp;&nbsp; /rest/queues/{name}</code></pre>
<div>
<table class='table-margin'>
<tr>
<td class='td-alignment-small'><b>Summary</b></td>
<td class='td-alignment-std'>
Gets information about a single ActiveMQ queue.
</td>
</tr>
<tr style=';background-color: #EAEAEA'>
<td class='td-alignment-small'><b>Description</b></td>
<td class='td-alignment-std'>
</td>
</tr>
<tr>
<td class='td-alignment-small'><b>Operation Id</b></td>
<td class='td-alignment-std'></td>
</tr>
<tr style=';background-color: #EAEAEA'>
<td class='td-alignment-small'><b>Produces</b></td>
<td class='td-alignment-std'>QueueInfo</td>
</tr>
<tr>
<td class='td-alignment-small'><b>Parameters</b></td>
<td class='td-alignment-std' style='padding-left:0px!important;margin-left:0px!important'>
<table class='table-margin'>
<thead>
<tr>
<td class='small-heading'>Name</td>
<td class='small-heading'>In</td>
<td class='small-heading'>Description</td>
<td class='small-heading'>Required</td>
<td class='small-heading'>Type</td>
<td class='small-heading'>Format</td>
<td class='small-heading'>Collection Format</td>
<td class='small-heading'>Default</td>
<td class='small-heading'>Min</td>
<td class='small-heading'>Max</td>
</tr>
</thead>
<tbody>
<tr style=';background-color: #EAEAEA'>
<td class='td-alignment-small-no-width'>name</td>
<td class='td-alignment-small-no-width'>path</td>
<td class='td-alignment-small-no-width'>Queue Name</td>
<td class='td-alignment-small-no-width'>Yes</td>
<td class='td-alignment-small-no-width'>string</td>
<td class='td-alignment-small-no-width'></td>
<td class='td-alignment-small-no-width'></td>
<td class='td-alignment-small-no-width'></td>
<td class='td-alignment-small-no-width'></td>
<td class='td-alignment-small-no-width'></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class='td-alignment-small'><b>Tags</b></td>
</tr>
<tr>
<td class='td-alignment-small'><b>Responses</b></td>
<td class='td-alignment-std' style='padding-left:0px!important;margin-left:0px!important'>
<table class='table-margin'>
<tr>
<td class='td-alignment-small'><b>code</b></td>
<td class='td-alignment-std'><b>description</b></td>
</tr>
<tr>
<td class='td-alignment-small'>200</td>
<td class='td-alignment-std'>
Success
</td>
</tr>
<tr>
<td class='td-alignment-small'>401</td>
<td class='td-alignment-std'>
Bad credentials.
</td>
</tr>
<tr>
<td class='td-alignment-small'>404</td>
<td class='td-alignment-std'>
There was no queue with the given name.
</td>
</tr>
</table>
</td>
</tr>
</table>
</div>
</div>
</body>
</html>
Loading