mirror of
https://github.com/resf/distro-tools.git
synced 2024-11-21 20:51:27 +00:00
Add endpoint to apollo docs and remove non-api
This commit is contained in:
Mustafa Gezen
parent
caab3e3360
commit
5b8935e387
GPG Key ID:
DCDF010D946438C1
@ -8,880 +8,9 @@ Most likely, it is not desirable to edit this file by hand!
|
|||||||
# Peridot Apollo <span class="api-version">0.1.0</span>
|
# Peridot Apollo <span class="api-version">0.1.0</span>
|
||||||
|
|
||||||
Apollo Errata Management
|
Apollo Errata Management
|
||||||
|
|
||||||
|
Endpoint: https://apollo.build.resf.org
|
||||||
<hr />
|
<hr />
|
||||||
## <span class="api-tag">non-api</span>
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /
|
|
||||||
List Advisories
|
|
||||||
|
|
||||||
**Input parameters**
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Parameter</th>
|
|
||||||
<th>In</th>
|
|
||||||
<th>Type</th>
|
|
||||||
<th>Default</th>
|
|
||||||
<th>Nullable</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>page</code></td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>integer</td>
|
|
||||||
<td>1</td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>search</code></td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>string</td>
|
|
||||||
<td></td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>size</code></td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>integer</td>
|
|
||||||
<td>50</td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-422">422</span> <span class="status-phrase">Unprocessable Entity</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"detail": [
|
|
||||||
{
|
|
||||||
"loc": [
|
|
||||||
null
|
|
||||||
],
|
|
||||||
"msg": "string",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "HTTPValidationError",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"detail": {
|
|
||||||
"title": "Detail",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/ValidationError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /<span class="route-param">{advisory_name}</span>
|
|
||||||
Get Advisory
|
|
||||||
|
|
||||||
**Input parameters**
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Parameter</th>
|
|
||||||
<th>In</th>
|
|
||||||
<th>Type</th>
|
|
||||||
<th>Default</th>
|
|
||||||
<th>Nullable</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>advisory_name</code></td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string</td>
|
|
||||||
<td></td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-422">422</span> <span class="status-phrase">Unprocessable Entity</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"detail": [
|
|
||||||
{
|
|
||||||
"loc": [
|
|
||||||
null
|
|
||||||
],
|
|
||||||
"msg": "string",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "HTTPValidationError",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"detail": {
|
|
||||||
"title": "Detail",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/ValidationError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /statistics/
|
|
||||||
Statistics
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /login/
|
|
||||||
Login Page
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-post">POST</span> /login/
|
|
||||||
Do Login
|
|
||||||
<p class="request-body-title"><strong>Request body</strong></p>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
=== "application/x-www-form-urlencoded"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"email": "string",
|
|
||||||
"password": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the request body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "Body_do_login_login__post",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"email": {
|
|
||||||
"title": "Email",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"title": "Password",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-422">422</span> <span class="status-phrase">Unprocessable Entity</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"detail": [
|
|
||||||
{
|
|
||||||
"loc": [
|
|
||||||
null
|
|
||||||
],
|
|
||||||
"msg": "string",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "HTTPValidationError",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"detail": {
|
|
||||||
"title": "Detail",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/ValidationError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-post">POST</span> /login/setup
|
|
||||||
Setup Page
|
|
||||||
<p class="request-body-title"><strong>Request body</strong></p>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
=== "application/x-www-form-urlencoded"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"name": "string",
|
|
||||||
"email": "string",
|
|
||||||
"password": "string",
|
|
||||||
"confirm_password": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the request body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "Body_setup_page_login_setup_post",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"name": {
|
|
||||||
"title": "Name",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"email": {
|
|
||||||
"title": "Email",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"title": "Password",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"confirm_password": {
|
|
||||||
"title": "Confirm Password",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-422">422</span> <span class="status-phrase">Unprocessable Entity</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"detail": [
|
|
||||||
{
|
|
||||||
"loc": [
|
|
||||||
null
|
|
||||||
],
|
|
||||||
"msg": "string",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "HTTPValidationError",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"detail": {
|
|
||||||
"title": "Detail",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/ValidationError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /logout/
|
|
||||||
Logout
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /admin/
|
|
||||||
Admin General
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /red_hat/advisories
|
|
||||||
List Red Hat Advisories
|
|
||||||
|
|
||||||
**Input parameters**
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Parameter</th>
|
|
||||||
<th>In</th>
|
|
||||||
<th>Type</th>
|
|
||||||
<th>Default</th>
|
|
||||||
<th>Nullable</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>page</code></td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>integer</td>
|
|
||||||
<td>1</td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>size</code></td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>integer</td>
|
|
||||||
<td>50</td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-422">422</span> <span class="status-phrase">Unprocessable Entity</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"detail": [
|
|
||||||
{
|
|
||||||
"loc": [
|
|
||||||
null
|
|
||||||
],
|
|
||||||
"msg": "string",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "HTTPValidationError",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"detail": {
|
|
||||||
"title": "Detail",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/ValidationError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-get">GET</span> /red_hat/advisories/<span class="route-param">{advisory_name}</span>
|
|
||||||
Get Red Hat Advisory
|
|
||||||
|
|
||||||
**Input parameters**
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Parameter</th>
|
|
||||||
<th>In</th>
|
|
||||||
<th>Type</th>
|
|
||||||
<th>Default</th>
|
|
||||||
<th>Nullable</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>advisory_name</code></td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string</td>
|
|
||||||
<td></td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-422">422</span> <span class="status-phrase">Unprocessable Entity</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"detail": [
|
|
||||||
{
|
|
||||||
"loc": [
|
|
||||||
null
|
|
||||||
],
|
|
||||||
"msg": "string",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "HTTPValidationError",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"detail": {
|
|
||||||
"title": "Detail",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/ValidationError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
<hr class="operation-separator" />
|
|
||||||
|
|
||||||
### <span class="http-post">POST</span> /red_hat/advisories/<span class="route-param">{advisory_name}</span>
|
|
||||||
Execute Red Hat Advisory Action
|
|
||||||
|
|
||||||
**Input parameters**
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Parameter</th>
|
|
||||||
<th>In</th>
|
|
||||||
<th>Type</th>
|
|
||||||
<th>Default</th>
|
|
||||||
<th>Nullable</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td class="parameter-name"><code>advisory_name</code></td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string</td>
|
|
||||||
<td></td>
|
|
||||||
<td>No</td>
|
|
||||||
<td></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<p class="request-body-title"><strong>Request body</strong></p>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
=== "application/x-www-form-urlencoded"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"action": "string",
|
|
||||||
"data": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the request body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "Body_execute_red_hat_advisory_action_red_hat_advisories__advisory_name__post",
|
|
||||||
"required": [
|
|
||||||
"action",
|
|
||||||
"data"
|
|
||||||
],
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"action": {
|
|
||||||
"title": "Action",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"data": {
|
|
||||||
"title": "Data",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-200">200</span> <span class="status-phrase">OK</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "text/html"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
"string"
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p class="response-title">
|
|
||||||
<strong>Response <span class="response-code code-422">422</span> <span class="status-phrase">Unprocessable Entity</span></strong>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
=== "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"detail": [
|
|
||||||
{
|
|
||||||
"loc": [
|
|
||||||
null
|
|
||||||
],
|
|
||||||
"msg": "string",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
<span class="small-note">⚠️</span> <em class="small-note warning">This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</em>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
??? hint "Schema of the response body"
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"title": "HTTPValidationError",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"detail": {
|
|
||||||
"title": "Detail",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/ValidationError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## <span class="api-tag">advisories</span>
|
## <span class="api-tag">advisories</span>
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user