From 71a286d5e561ce9d0a7976abdfa84577374eeab1 Mon Sep 17 00:00:00 2001
From: Zoltan Runyo <zoltan.runyo@ess.eu>
Date: Wed, 15 Feb 2023 11:09:12 +0000
Subject: [PATCH] ICSHWI-11696: Job status handling simplifications
---
src/api/DataTypes.js | 86 +-
src/components/IOC/IOCService.js | 4 +-
src/components/Job/JobDetails.js | 9 +-
src/components/common/notification/Storage.js | 3 +-
.../deployments/DeploymentDetails.js | 9 +-
src/components/deployments/DeploymentIcons.js | 18 +-
.../deployments/DeploymentStepper.js | 21 +-
src/mocks/fixtures/AwxJobDetails.json | 10 +-
src/mocks/fixtures/DeploymentInfoDetails.json | 3 -
src/mocks/fixtures/ccce-api.json | 3374 +++++------------
.../DeploymentDetailsContainer.spec.js | 3 +-
11 files changed, 1052 insertions(+), 2488 deletions(-)
diff --git a/src/api/DataTypes.js b/src/api/DataTypes.js
index a1930675..d2b123b4 100644
--- a/src/api/DataTypes.js
+++ b/src/api/DataTypes.js
@@ -1,12 +1,8 @@
const jobMessages = {
- new: "job has just been created",
- pending: "job dependencies are running",
- waiting: "job is queued on job server",
+ queued: "job is queued on job server",
running: "job is running",
failed: "job failed",
- successful: "job was successful",
- error: "job had an error",
- canceled: "job was canceled"
+ successful: "job was successful"
};
const typeMap = {
@@ -31,7 +27,7 @@ export class AWXJobDetails {
}
wasSuccessful() {
- return this.job?.status === "successful";
+ return this.job?.status.toLowerCase() === "successful";
}
typeLabel() {
@@ -39,30 +35,23 @@ export class AWXJobDetails {
}
status() {
- const status = this.job?.status.toLowerCase();
- if (["error, failed, canceled"].includes(status)) {
- return "failed";
- } else if (["pending", "waiting"].includes(status)) {
- return "queued";
- } else if (["new"].includes(status)) {
- return "created";
- } else {
- return status;
- }
+ return this.job?.status.toLowerCase();
}
message() {
const stem = `The ${this.typeLabel()} `;
- const info = jobMessages[this.job ? this.job.status.toLowerCase() : "new"];
+ const info = this.job
+ ? jobMessages[this.job.status.toLowerCase()]
+ : ": fetching data";
const message = stem + info;
return message;
}
severity() {
- const status = this.job?.status;
- if (["failed", "error", "canceled"].includes(status)) {
+ const status = this.job?.status.toLowerCase();
+ if (status === "failed") {
return "error";
- } else if ("successful".includes(status)) {
+ } else if (status === "successful") {
return "success";
} else {
return "info";
@@ -75,10 +64,6 @@ export class DeploymentInfoDetails {
this.deployment = deployment;
}
- hasError() {
- return this.deployment?.status.toLowerCase() === "error";
- }
-
type() {
if (this.deployment) {
return this.deployment.undeployment ? "undeployment" : "deployment";
@@ -100,7 +85,7 @@ export class DeploymentStatus {
}
isFinished() {
- return this.deploymentHelper.hasError() || this.jobHelper.isFinished();
+ return this.jobHelper.isFinished();
}
wasSuccessful() {
@@ -108,40 +93,23 @@ export class DeploymentStatus {
}
status() {
- const entity = this.deploymentJob ?? this.deployment;
- const status = entity.status.toLowerCase();
- if (["error, failed, canceled"].includes(status)) {
- return "failed";
- } else if (["queued", "waiting"].includes(status)) {
- return "queued";
- } else if (["new", "pending"].includes(status)) {
- return "pending";
- } else {
- return status;
- }
+ return this.deploymentJob.status.toLowerCase();
}
message() {
- const joblessMessages = {
- queued: "is queued for job creation",
- error: "job could not be created",
- job: "has an associated job"
- };
-
const stem = `The ${this.deploymentHelper.type()} `;
const info = this.deploymentJob
? jobMessages[this.deploymentJob.status.toLowerCase()]
- : joblessMessages[this.deployment.status.toLowerCase()];
+ : ": fetching data";
const message = stem + info;
return message;
}
severity() {
- const entity = this.deploymentJob ?? this.deployment;
- const status = entity.status;
- if (["failed", "error", "canceled"].includes(status)) {
+ const status = this.deploymentJob?.status.toLowerCase();
+ if (status === "failed") {
return "error";
- } else if ("successful".includes(status)) {
+ } else if (status === "successful") {
return "success";
} else {
return "info";
@@ -159,9 +127,7 @@ export class AWXCommandDetails {
}
isFinished() {
- return ["error", "failed", "canceled", "successful"].includes(
- this.job?.status
- );
+ return ["failed", "successful"].includes(this.job?.status);
}
wasSuccessful() {
@@ -187,18 +153,18 @@ export class AdHocCommand {
}
isFinished() {
- return ["error", "failed", "canceled", "successful"].includes(
- this.command?.status
+ return ["failed", "successful"].includes(
+ this.command?.status.toLowerCase()
);
}
wasSuccessful() {
- return this.job?.status === "successful";
+ return this.job?.status.toLowerCase() === "successful";
}
message() {
const message = `The ${this.command.type} command ${
- jobMessages[this.command?.status]
+ jobMessages[this.command?.status.toLowerCase()]
}`;
return message;
}
@@ -214,7 +180,7 @@ export class CommandStatus {
message() {
const message = `The ${this.command.type} command ${
- jobMessages[this.command.status]
+ jobMessages[this.command.status.toLowerCase()]
}`;
return message;
}
@@ -255,7 +221,7 @@ export class Operation {
}
isFinished() {
- return ["failed", "canceled", "successful", "error"].includes(
+ return ["failed", "successful"].includes(
this.operation?.status?.toLowerCase()
);
}
@@ -265,13 +231,11 @@ export class Operation {
}
hasFailed() {
- return ["error", "failed", "canceled"].includes(
- this.operation?.status?.toLowerCase()
- );
+ return this.operation?.status?.toLowerCase() === "failed";
}
hasFinished() {
- return ["error", "failed", "canceled", "successful"].includes(
+ return ["failed", "successful"].includes(
this.operation?.status?.toLowerCase()
);
}
diff --git a/src/components/IOC/IOCService.js b/src/components/IOC/IOCService.js
index 7a582a95..9632d71f 100644
--- a/src/components/IOC/IOCService.js
+++ b/src/components/IOC/IOCService.js
@@ -126,7 +126,7 @@ export function IOCService({
style={{ fontFamily: "monospace", display: "inline-block" }}
>
{" "}
- {ioc.name}?{" "}
+ {ioc.namingName}?{" "}
</Typography>
</>
);
@@ -145,7 +145,7 @@ export function IOCService({
style={{ fontFamily: "monospace", display: "inline-block" }}
>
{" "}
- {ioc.name}?{" "}
+ {ioc.namingName}?{" "}
</Typography>
</>
);
diff --git a/src/components/Job/JobDetails.js b/src/components/Job/JobDetails.js
index 08964927..65f1c625 100644
--- a/src/components/Job/JobDetails.js
+++ b/src/components/Job/JobDetails.js
@@ -152,12 +152,9 @@ export function JobDetails({ operation, job }) {
<div>
{job && (
<DeploymentStepper
- activeStep={[
- "created",
- "pending",
- "running",
- "successful"
- ].indexOf(job.status.toLowerCase())}
+ activeStep={["queued", "running", "successful"].indexOf(
+ job.status.toLowerCase()
+ )}
deploymentStart={operation.startDate}
jobDetails={jobDetails}
/>
diff --git a/src/components/common/notification/Storage.js b/src/components/common/notification/Storage.js
index 6cde5bee..8cb4884b 100644
--- a/src/components/common/notification/Storage.js
+++ b/src/components/common/notification/Storage.js
@@ -80,7 +80,8 @@ function createNotification(type, id, status, message) {
id: id,
type: type,
message: message,
- status: status.toLowerCase()
+ status: status.toLowerCase(),
+ link: "/jobs/" + id
};
}
diff --git a/src/components/deployments/DeploymentDetails.js b/src/components/deployments/DeploymentDetails.js
index c33459cb..6a2de2fa 100644
--- a/src/components/deployments/DeploymentDetails.js
+++ b/src/components/deployments/DeploymentDetails.js
@@ -163,12 +163,9 @@ export function DeploymentDetails({ deployment, deploymentJob }) {
<div>
{deploymentJob && (
<DeploymentStepper
- activeStep={[
- "created",
- "pending",
- "running",
- "successful"
- ].indexOf(deploymentJob.status.toLowerCase())}
+ activeStep={["queued", "running", "successful"].indexOf(
+ deploymentJob.status.toLowerCase()
+ )}
deploymentStart={deployment.startDate}
jobDetails={jobDetails}
/>
diff --git a/src/components/deployments/DeploymentIcons.js b/src/components/deployments/DeploymentIcons.js
index 772b7758..821a8df7 100644
--- a/src/components/deployments/DeploymentIcons.js
+++ b/src/components/deployments/DeploymentIcons.js
@@ -3,10 +3,8 @@ import {
CheckCircleOutline,
ErrorOutline,
RotateRightOutlined,
- ScheduleOutlined,
QueueOutlined,
- ClearOutlined,
- HighlightOffOutlined
+ ClearOutlined
} from "@material-ui/icons";
import { Tooltip } from "@material-ui/core";
import { theme } from "../../style/Theme";
@@ -24,11 +22,6 @@ export function DeploymentStatusIcon({ status }) {
<ErrorOutline />
</Tooltip>
),
- canceled: (
- <Tooltip title="Canceled">
- <HighlightOffOutlined />
- </Tooltip>
- ),
running: (
<Tooltip title="Running">
<RotateRightOutlined />
@@ -38,21 +31,14 @@ export function DeploymentStatusIcon({ status }) {
<Tooltip title="Queued">
<QueueOutlined />
</Tooltip>
- ),
- pending: (
- <Tooltip title="Pending">
- <ScheduleOutlined />
- </Tooltip>
)
};
const deploymentStatusColors = {
successful: theme.palette.status.ok,
failed: theme.palette.status.fail,
- canceled: theme.palette.status.fail,
running: theme.palette.status.progress,
- queued: theme.palette.status.progress,
- pending: theme.palette.status.neutral
+ queued: theme.palette.status.progress
};
const state = status.toLowerCase();
diff --git a/src/components/deployments/DeploymentStepper.js b/src/components/deployments/DeploymentStepper.js
index 3777c343..b75dc619 100644
--- a/src/components/deployments/DeploymentStepper.js
+++ b/src/components/deployments/DeploymentStepper.js
@@ -1,6 +1,5 @@
import React from "react";
import {
- Person,
ScheduleOutlined,
RotateRightOutlined,
CheckCircleOutline
@@ -11,31 +10,29 @@ export function DeploymentStepper(props) {
let { activeStep, deploymentStart, jobDetails } = props;
const icons = {
- 1: <Person />,
- 2: <ScheduleOutlined />,
- 3: <RotateRightOutlined />,
- 4: <CheckCircleOutline />
+ 1: <ScheduleOutlined />,
+ 2: <RotateRightOutlined />,
+ 3: <CheckCircleOutline />
};
const steps = [
- "Creating " + jobDetails?.typeLabel(),
- jobDetails?.typeLabel() + " Queued ",
- "Running " + jobDetails?.typeLabel(),
+ jobDetails?.typeLabel() + " Queued",
+ jobDetails?.typeLabel() + " Running",
jobDetails?.typeLabel() + " Completed"
];
const isStepFailed = (step) => {
- if (jobDetails?.status() === "failed") {
+ if (jobDetails?.status().toLowerCase() === "failed") {
return step === activeStep;
}
return false;
};
- if (jobDetails?.status() === "failed") {
- activeStep = deploymentStart ? 2 : 1;
+ if (jobDetails?.status().toLowerCase() === "failed") {
+ activeStep = deploymentStart ? 1 : 0;
}
- activeStep = activeStep === 3 ? 4 : activeStep;
+ activeStep = activeStep === 2 ? 3 : activeStep;
return (
<StepperWithStyle
diff --git a/src/mocks/fixtures/AwxJobDetails.json b/src/mocks/fixtures/AwxJobDetails.json
index da0aca40..3c950aca 100644
--- a/src/mocks/fixtures/AwxJobDetails.json
+++ b/src/mocks/fixtures/AwxJobDetails.json
@@ -1,31 +1,31 @@
[
{
"id": 3925,
- "status": "failed",
+ "status": "FAILED",
"started": "2022-02-11T12:29:24.332+00:00",
"finished": "2022-02-11T12:29:29.595+00:00"
},
{
"id": 3928,
- "status": "failed",
+ "status": "FAILED",
"started": "2022-02-11T12:30:52.915+00:00",
"finished": "2022-02-11T12:30:57.888+00:00"
},
{
"id": 3931,
- "status": "failed",
+ "status": "FAILED",
"started": "2022-02-11T13:06:27.127+00:00",
"finished": "2022-02-11T13:06:32.280+00:00"
},
{
"id": 4382,
- "status": "successful",
+ "status": "SUCCESSFUL",
"started": "2022-03-29T13:00:52.023+00:00",
"finished": "2022-03-29T13:02:18.225+00:00"
},
{
"id": 4544,
- "status": "successful",
+ "status": "SUCCESSFUL",
"started": "2022-04-06T07:33:50.410+00:00",
"finished": "2022-04-06T07:35:20.736+00:00"
}
diff --git a/src/mocks/fixtures/DeploymentInfoDetails.json b/src/mocks/fixtures/DeploymentInfoDetails.json
index 86bf4257..d88267ae 100644
--- a/src/mocks/fixtures/DeploymentInfoDetails.json
+++ b/src/mocks/fixtures/DeploymentInfoDetails.json
@@ -13,7 +13,6 @@
"csEntryId": 1060,
"fqdn": "jsparger-test.cslab.esss.lu.se"
},
- "status": "JOB",
"awxJobId": 3925,
"iocId": 2,
"awxJobUrl": "https://awx-lab-01.cslab.esss.lu.se/#/jobs/playbook/3925",
@@ -34,7 +33,6 @@
"csEntryId": 1060,
"fqdn": "jsparger-test.cslab.esss.lu.se"
},
- "status": "JOB",
"awxJobId": 3928,
"iocId": 1,
"awxJobUrl": "https://awx-lab-01.cslab.esss.lu.se/#/jobs/playbook/3928",
@@ -55,7 +53,6 @@
"csEntryId": 1060,
"fqdn": "jsparger-test.cslab.esss.lu.se"
},
- "status": "JOB",
"awxJobId": 3931,
"iocId": 1,
"awxJobUrl": "https://awx-lab-01.cslab.esss.lu.se/#/jobs/playbook/3931",
diff --git a/src/mocks/fixtures/ccce-api.json b/src/mocks/fixtures/ccce-api.json
index dfb00989..f2a185c8 100644
--- a/src/mocks/fixtures/ccce-api.json
+++ b/src/mocks/fixtures/ccce-api.json
@@ -3,7 +3,7 @@
"info": {
"title": "CE deploy & monitor API",
"description": "CE deploy & monitor backend",
- "version": "0.0.11"
+ "version": "0.0.12"
},
"servers": [
{
@@ -12,39 +12,18 @@
}
],
"tags": [
- {
- "name": "Broadcasts"
- },
- {
- "name": "IOCs"
- },
- {
- "name": "Naming"
- },
- {
- "name": "Authentication"
- },
- {
- "name": "Helper"
- },
- {
- "name": "Records"
- },
- {
- "name": "Statistics"
- },
- {
- "name": "Hosts"
- },
- {
- "name": "Deployments"
- },
- {
- "name": "Git"
- },
- {
- "name": "Monitoring"
- }
+ { "name": "Broadcasts" },
+ { "name": "IOCs" },
+ { "name": "Naming" },
+ { "name": "Authentication" },
+ { "name": "AWX" },
+ { "name": "Helper" },
+ { "name": "Records" },
+ { "name": "Statistics" },
+ { "name": "Hosts" },
+ { "name": "Deployments" },
+ { "name": "Git" },
+ { "name": "Monitoring" }
],
"paths": {
"/api/v1/iocs/{ioc_id}/undeploy_in_db": {
@@ -59,73 +38,58 @@
"in": "path",
"description": "The id of the IOC to undeploy",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "Undeployment created",
+ "403": {
+ "description": "Forbidden: user doesn't have the necessary permissions to undeploy",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Deployment"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Undeployment created",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/Deployment" }
}
}
}
},
- "403": {
- "description": "Forbidden: user doesn't have the necessary permissions to undeploy",
+ "404": {
+ "description": "Not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Not found",
+ "422": {
+ "description": "IOC is not deployed",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "409": {
- "description": "Ongoing deployment, or undeployment for IOC",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "422": {
- "description": "IOC is not deployed",
+ "409": {
+ "description": "Ongoing deployment, or undeployment for IOC",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -133,18 +97,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/iocs/{ioc_id}/active_deployment/host": {
@@ -159,63 +117,50 @@
"in": "path",
"description": "The ID of the IOC",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"requestBody": {
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateHostRequest"
- }
+ "schema": { "$ref": "#/components/schemas/UpdateHostRequest" }
}
},
"required": true
},
"responses": {
- "200": {
- "description": "Successful host update",
+ "404": {
+ "description": "Not found",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Ioc"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Successful host update",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/Ioc" }
}
}
}
},
- "403": {
- "description": "Forbidden: user doesn't have the necessary permissions to modify",
+ "422": {
+ "description": "IOC is not deployed",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -223,19 +168,15 @@
"description": "Ongoing operation for IOC",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "422": {
- "description": "IOC is not deployed",
+ "403": {
+ "description": "Forbidden: user doesn't have the necessary permissions to modify",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -243,18 +184,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/iocs": {
@@ -278,57 +213,42 @@
"in": "query",
"description": "User name",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "query",
"in": "query",
"description": "Search text (Search for Naming name, Owner)",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "order_by",
"in": "query",
"description": "Order by",
"required": false,
- "schema": {
- "type": "string",
- "enum": ["ID", "OWNER", "IOC_NAME"]
- }
+ "schema": { "type": "string", "enum": ["ID", "OWNER", "IOC_NAME"] }
},
{
"name": "order_asc",
"in": "query",
"description": "Order Ascending",
"required": false,
- "schema": {
- "type": "boolean"
- }
+ "schema": { "type": "boolean" }
},
{
"name": "page",
"in": "query",
"description": "Page offset",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
},
{
"name": "limit",
"in": "query",
"description": "Page size",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
@@ -336,9 +256,7 @@
"description": "A paged array of IOCs",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PagedIocResponse"
- }
+ "schema": { "$ref": "#/components/schemas/PagedIocResponse" }
}
}
},
@@ -346,9 +264,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -356,9 +272,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -371,110 +285,86 @@
"requestBody": {
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/CreateIoc"
- }
+ "schema": { "$ref": "#/components/schemas/CreateIoc" }
}
},
"required": true
},
"responses": {
- "201": {
- "description": "IOC created",
+ "400": {
+ "description": "Incomplete request",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Ioc"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "400": {
- "description": "Incomplete request",
+ "424": {
+ "description": "Metadata file not found, or not processable",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "201": {
+ "description": "IOC created",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/Ioc" }
}
}
},
- "403": {
- "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
+ "422": {
+ "description": "Unprocessable request",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "409": {
- "description": "IOC already created",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "422": {
- "description": "Unprocessable request",
+ "409": {
+ "description": "IOC already created",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "424": {
- "description": "Metadata file not found, or not processable",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "403": {
+ "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/iocs/{ioc_id}/undeployment_job": {
@@ -488,18 +378,13 @@
"in": "path",
"description": "The id of the IOC to undeploy",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"requestBody": {
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Undeployment"
- }
+ "schema": { "$ref": "#/components/schemas/Undeployment" }
}
},
"required": true
@@ -511,40 +396,40 @@
"application/json": {
"schema": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Deployment"
- }
+ "items": { "$ref": "#/components/schemas/Deployment" }
}
}
}
},
- "401": {
- "description": "Unauthorized",
+ "403": {
+ "description": "Forbidden: user doesn't have the necessary permissions in Gitlab",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "403": {
- "description": "Forbidden: user doesn't have the necessary permissions in Gitlab",
+ "404": {
+ "description": "Not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
+ "503": {
+ "description": "Remote service exception",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -552,9 +437,7 @@
"description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -562,9 +445,7 @@
"description": "IOC is not deployed correctly",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -572,28 +453,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
- }
- }
- },
- "503": {
- "description": "Remote service exception",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/iocs/{ioc_id}/stop_job": {
@@ -607,10 +472,7 @@
"in": "path",
"description": "The id of the IOC to stop",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
@@ -618,9 +480,7 @@
"description": "IOC stop initiated",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/AdHocCommand"
- }
+ "schema": { "$ref": "#/components/schemas/AdHocCommand" }
}
}
},
@@ -628,78 +488,60 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "403": {
- "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "IOC not found",
+ "409": {
+ "description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "409": {
- "description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
+ "404": {
+ "description": "IOC not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "422": {
- "description": "IOC has no active deployment",
+ "403": {
+ "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "422": {
+ "description": "IOC has no active deployment",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/iocs/{ioc_id}/start_job": {
@@ -713,10 +555,7 @@
"in": "path",
"description": "The id of the IOC to start",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
@@ -724,9 +563,7 @@
"description": "IOC start initiated",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/AdHocCommand"
- }
+ "schema": { "$ref": "#/components/schemas/AdHocCommand" }
}
}
},
@@ -734,19 +571,23 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "403": {
- "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
+ "409": {
+ "description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -754,19 +595,15 @@
"description": "IOC not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "409": {
- "description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
+ "403": {
+ "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -774,9 +611,7 @@
"description": "IOC has no active deployment",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -784,28 +619,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
- }
- }
- },
- "503": {
- "description": "Remote service exception",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/iocs/{ioc_id}/deployment_job": {
@@ -819,40 +638,31 @@
"in": "path",
"description": "The id of the IOC to deploy",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"requestBody": {
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateAndDeployIoc"
- }
+ "schema": { "$ref": "#/components/schemas/UpdateAndDeployIoc" }
}
},
"required": true
},
"responses": {
- "201": {
- "description": "Deployment created",
+ "400": {
+ "description": "Incomplete request",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Deployment"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "400": {
- "description": "Incomplete request",
+ "424": {
+ "description": "Metadata file not found, or not processable",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -860,19 +670,31 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "403": {
- "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
+ "409": {
+ "description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
+ "201": {
+ "description": "Deployment created",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/Deployment" }
}
}
},
@@ -880,19 +702,15 @@
"description": "IOC not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "409": {
- "description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
+ "403": {
+ "description": "Forbidden: User doesn't have the necessary permissions in Gitlab",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -900,48 +718,70 @@
"description": "CSEntry host not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "424": {
- "description": "Metadata file not found, or not processable",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
+ }
+ },
+ "security": [{ "bearerAuth": [] }]
+ }
+ },
+ "/api/v1/awx/jobs": {
+ "post": {
+ "tags": ["AWX"],
+ "summary": "Update an AWX job's status",
+ "operationId": "updateJob",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/AwxJobMeta" }
+ }
},
- "500": {
- "description": "Service exception",
+ "required": true
+ },
+ "responses": {
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "404": {
+ "description": "Job not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
+ "200": {
+ "description": "Job updated",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
+ "500": {
+ "description": "Service exception",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "apiKey": [] }]
}
},
"/api/v1/authentication/renew": {
@@ -951,62 +791,48 @@
"description": "Renewing valid, non-expired JWT token",
"operationId": "tokenRenew",
"responses": {
- "200": {
- "description": "Ok",
+ "503": {
+ "description": "Login server unavailable",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoginResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "403": {
+ "description": "Permission denied",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "403": {
- "description": "Permission denied",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Ok",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/LoginResponse" }
}
}
},
- "503": {
- "description": "Login server unavailable",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/authentication/login": {
@@ -1018,31 +844,25 @@
"requestBody": {
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Login"
- }
+ "schema": { "$ref": "#/components/schemas/Login" }
}
},
"required": true
},
"responses": {
- "200": {
- "description": "Ok",
+ "401": {
+ "description": "Bad username, and/or password",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoginResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Bad username, and/or password",
+ "503": {
+ "description": "Login server unavailable",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1050,29 +870,23 @@
"description": "User doesn't have permission to log in",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Ok",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/LoginResponse" }
}
}
},
- "503": {
- "description": "Login server unavailable",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1090,40 +904,31 @@
"in": "path",
"description": "Unique ID of IOC",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "Found IOC",
+ "404": {
+ "description": "Ioc not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/IocDetails"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Found IOC",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/IocDetails" }
}
}
},
- "404": {
- "description": "Ioc not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1131,9 +936,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1149,30 +952,21 @@
"in": "path",
"description": "Id of IOC to delete",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
"204": {
"description": "IOC deleted",
"content": {
- "application/json": {
- "schema": {
- "type": "string"
- }
- }
+ "application/json": { "schema": { "type": "string" } }
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1180,19 +974,15 @@
"description": "Forbidden: User doesn't have the necessary permissions",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "IOC not found",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1200,38 +990,28 @@
"description": "Concurrent deployment, undeployment, start or stop for IOC is ongoing",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "404": {
+ "description": "IOC not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
},
"patch": {
"tags": ["IOCs"],
@@ -1243,109 +1023,96 @@
"in": "path",
"description": "Unique ID of IOC",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"requestBody": {
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/IOCUpdateRequest"
- }
+ "schema": { "$ref": "#/components/schemas/IOCUpdateRequest" }
}
},
"required": true
},
"responses": {
- "200": {
- "description": "IOC updated",
+ "404": {
+ "description": "Ioc not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Ioc"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "422": {
+ "description": "Unprocessable request",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "403": {
- "description": "Forbidden: User doesn't have the necessary permissions",
+ "200": {
+ "description": "IOC updated",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/Ioc" }
}
}
},
- "404": {
- "description": "Ioc not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "409": {
- "description": "IOC already created or concurrent deployment, undeployment, start or stop for IOC is ongoing",
+ "403": {
+ "description": "Forbidden: User doesn't have the necessary permissions",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "422": {
- "description": "Unprocessable request",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "409": {
+ "description": "IOC already created or concurrent deployment, undeployment, start or stop for IOC is ongoing",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
+ "security": [{ "bearerAuth": [] }]
+ }
+ },
+ "/healthcheck": {
+ "get": {
+ "tags": ["health-check-controller"],
+ "operationId": "getHealthCheck",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": { "*/*": { "schema": { "type": "string" } } }
}
- ]
+ }
}
},
"/api/v1/statistics/my_iocs": {
@@ -1368,9 +1135,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1378,18 +1143,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/statistics/general": {
@@ -1412,9 +1171,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1422,9 +1179,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1437,25 +1192,21 @@
"summary": "IOC statistics",
"operationId": "iocStatistics",
"responses": {
- "200": {
- "description": "Statistics about IOCs deployed to hosts",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DeploymentOnHost"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Statistics about IOCs deployed to hosts",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/DeploymentOnHost" }
}
}
}
@@ -1464,9 +1215,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1493,9 +1242,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1503,9 +1250,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1532,9 +1277,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1542,9 +1285,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1574,9 +1315,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1584,9 +1323,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1616,9 +1353,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1626,9 +1361,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1658,9 +1391,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1668,9 +1399,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1700,9 +1429,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1710,9 +1437,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1730,68 +1455,52 @@
"in": "query",
"description": "Record name",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "ioc_name",
"in": "query",
"description": "IOC name",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "page",
"in": "query",
"description": "Page offset",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
},
{
"name": "limit",
"in": "query",
"description": "Page size",
"required": false,
- "schema": {
- "maximum": 100,
- "type": "string"
- }
+ "schema": { "maximum": 100, "type": "string" }
}
],
"responses": {
- "200": {
- "description": "A paged array of Channel Finder records",
+ "503": {
+ "description": "Remote server exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PagedRecordResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "A paged array of Channel Finder records",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/PagedRecordResponse" }
}
}
},
- "503": {
- "description": "Remote server exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1809,9 +1518,7 @@
"in": "path",
"description": "Unique ID of the record",
"required": true,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
}
],
"responses": {
@@ -1819,9 +1526,7 @@
"description": "Found record",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/RecordDetails"
- }
+ "schema": { "$ref": "#/components/schemas/RecordDetails" }
}
}
},
@@ -1829,9 +1534,7 @@
"description": "Record not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -1839,9 +1542,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -1859,61 +1560,47 @@
"in": "query",
"description": "IOC name",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
}
],
"responses": {
- "200": {
- "description": "Naming names, and IDs from CCDB",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/NameResponse"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "503": {
+ "description": "Remote service unreachable",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Naming names, and IDs from CCDB",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/NameResponse" }
}
}
}
},
- "503": {
- "description": "Remote service unreachable",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/monitoring/syslog/host/{host_name}": {
@@ -1927,68 +1614,51 @@
"in": "path",
"description": "Host name (without network part)",
"required": true,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "time_range",
"in": "query",
"description": "Time range (in minutes)",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
- "200": {
- "description": "Log lines",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/LokiResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Log lines",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/LokiResponse" }
}
}
},
- "500": {
- "description": "Service exception",
+ "503": {
+ "description": "Logging server unavailable",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Logging server unavailable",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/monitoring/status/{ioc_id}": {
@@ -2002,40 +1672,31 @@
"in": "path",
"description": "Unique ID of the IOC",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "Log lines",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/IocStatusResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "404": {
+ "description": "Ioc not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Ioc not found",
+ "200": {
+ "description": "Log lines",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/IocStatusResponse" }
}
}
},
@@ -2043,9 +1704,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2063,48 +1722,45 @@
"in": "path",
"description": "Host name (without network part)",
"required": true,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "ioc_name",
"in": "path",
"description": "Name of the IOC to get procServ logs",
"required": true,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "time_range",
"in": "query",
"description": "Time range (in minutes)",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
"200": {
"description": "Log lines",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/LokiResponse"
- }
+ "schema": { "$ref": "#/components/schemas/LokiResponse" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "503": {
+ "description": "Logging server unavailable",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2112,28 +1768,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
- }
- }
- },
- "503": {
- "description": "Logging server unavailable",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/iocs/my_iocs_with_alarms": {
@@ -2148,9 +1788,7 @@
"application/json": {
"schema": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/IocWithAlarm"
- }
+ "items": { "$ref": "#/components/schemas/IocWithAlarm" }
}
}
}
@@ -2159,9 +1797,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2169,18 +1805,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/hosts": {
@@ -2194,9 +1824,7 @@
"in": "query",
"description": "Search text, this query string is passed directly to Elasticsearch. E.g.: To search all hosts where the string \"archiver\" appears in any field, use \"archiver\".To restrict the search to only the name field, use \"name:archiver\".Note that if you pass \"name:arch\", this will not match archiver as elasticsearch uses keywords for string matching. In this case you’d need to use a wildcard: \"name:arch*\".",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "filter",
@@ -2213,30 +1841,22 @@
"in": "query",
"description": "Page offset",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
},
{
"name": "limit",
"in": "query",
"description": "Page size",
"required": false,
- "schema": {
- "maximum": 100,
- "type": "string"
- }
+ "schema": { "maximum": 100, "type": "string" }
}
],
"responses": {
- "200": {
- "description": "A paged array of CSEntry hosts",
+ "503": {
+ "description": "Remote server exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PagedCSEntryHostResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2244,29 +1864,25 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "A paged array of CSEntry hosts",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "$ref": "#/components/schemas/PagedCSEntryHostResponse"
}
}
}
},
- "503": {
- "description": "Remote server exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2284,60 +1900,49 @@
"in": "path",
"description": "Unique CSEntry ID of the host",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "Found Host",
+ "404": {
+ "description": "Not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/CSEntryHostWithStatus"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "503": {
+ "description": "Remote server exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Found Host",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "$ref": "#/components/schemas/CSEntryHostWithStatus"
}
}
}
},
- "503": {
- "description": "Remote server exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2355,50 +1960,37 @@
"in": "path",
"description": "Unique CSEntry ID of the host",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
},
{
"name": "page",
"in": "query",
"description": "Page offset",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
},
{
"name": "limit",
"in": "query",
"description": "Page size",
"required": false,
- "schema": {
- "maximum": 100,
- "type": "string"
- }
+ "schema": { "maximum": 100, "type": "string" }
}
],
"responses": {
- "200": {
- "description": "Found Host",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PagedAssociatedIocs"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Found Host",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/PagedAssociatedIocs" }
}
}
},
@@ -2406,9 +1998,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2426,40 +2016,31 @@
"in": "path",
"description": "Unique CSEntry ID of the host",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "Found Host",
+ "404": {
+ "description": "Not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/TargetHost"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Found Host",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/TargetHost" }
}
}
},
- "404": {
- "description": "Not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2467,9 +2048,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2488,9 +2067,7 @@
"in": "path",
"description": "Naming UUID",
"required": true,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
}
],
"responses": {
@@ -2498,9 +2075,7 @@
"description": "Ok",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/IdUsedByIoc"
- }
+ "schema": { "$ref": "#/components/schemas/IdUsedByIoc" }
}
}
},
@@ -2508,9 +2083,7 @@
"description": "Too many IOCs use the same Naming UUID",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2518,9 +2091,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2539,10 +2110,7 @@
"in": "path",
"description": "Git repository Id",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
@@ -2550,9 +2118,7 @@
"description": "Ok",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/IdUsedByIoc"
- }
+ "schema": { "$ref": "#/components/schemas/IdUsedByIoc" }
}
}
},
@@ -2560,9 +2126,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2580,51 +2144,36 @@
"in": "path",
"description": "Git repo project ID",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
},
{
"name": "reference",
"in": "query",
"description": "Git reference",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "include_all_reference",
"in": "query",
"description": "Inculde all reference - optional. Default value: include all refernce (not limiting the response)",
"required": false,
- "schema": {
- "type": "boolean"
- }
+ "schema": { "type": "boolean" }
},
{
"name": "search_method",
"in": "query",
"description": "Search method - optional. Default value: filtering ref by EQUALS method",
"required": false,
- "schema": {
- "type": "string",
- "enum": ["EQUALS", "CONTAINS"]
- }
+ "schema": { "type": "string", "enum": ["EQUALS", "CONTAINS"] }
}
],
"responses": {
- "200": {
- "description": "List of Tags and CommitIds for a specific GitLab repo",
+ "503": {
+ "description": "Git exception",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/GitReference"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2632,29 +2181,26 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "List of Tags and CommitIds for a specific GitLab repo",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/GitReference" }
}
}
}
},
- "503": {
- "description": "Git exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2672,71 +2218,55 @@
"in": "query",
"description": "The username to retrieve info from - optional. If no user name provided the backend will look up for currently logged in user name",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
}
],
"responses": {
- "200": {
- "description": "Information about the current user",
+ "503": {
+ "description": "Git exception",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserInfoResponse"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "404": {
+ "description": "Not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Information about the current user",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/UserInfoResponse" }
}
}
}
},
- "503": {
- "description": "Git exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/git_helper/projects": {
@@ -2745,15 +2275,21 @@
"summary": "List IOC projects",
"operationId": "listProjects",
"responses": {
+ "503": {
+ "description": "Git exception",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
"200": {
"description": "List of Gitlab projects of allowed groups",
"content": {
"application/json": {
"schema": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/GitProject"
- }
+ "items": { "$ref": "#/components/schemas/GitProject" }
}
}
}
@@ -2762,9 +2298,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2772,28 +2306,12 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
- }
- }
- },
- "503": {
- "description": "Git exception",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/deployments": {
@@ -2807,20 +2325,14 @@
"in": "query",
"description": "IOC ID",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
},
{
"name": "host_csentry_id",
"in": "query",
"description": "Host CSEntry ID",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
},
{
"name": "status",
@@ -2837,18 +2349,14 @@
"in": "query",
"description": "User name",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "query",
"in": "query",
"description": "Search text (Search for IOC name, Git reference, Created by)",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "order_by",
@@ -2865,48 +2373,38 @@
"in": "query",
"description": "Order Ascending",
"required": false,
- "schema": {
- "type": "boolean"
- }
+ "schema": { "type": "boolean" }
},
{
"name": "page",
"in": "query",
"description": "Page offset",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
},
{
"name": "limit",
"in": "query",
"description": "Page size",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
- "200": {
- "description": "A paged array of deployments",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PagedOperationResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "A paged array of deployments",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "$ref": "#/components/schemas/PagedOperationResponse"
}
}
}
@@ -2915,9 +2413,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2935,40 +2431,33 @@
"in": "path",
"description": "Unique ID of deployment",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "A deployment with details",
- "content": {
+ "404": {
+ "description": "Deployment not found",
+ "content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/DeploymentInfoDetails"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "A deployment with details",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "$ref": "#/components/schemas/DeploymentInfoDetails"
}
}
}
},
- "404": {
- "description": "Deployment not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -2976,9 +2465,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -2996,20 +2483,14 @@
"in": "query",
"description": "IOC ID",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
},
{
"name": "type",
"in": "query",
"description": "Type",
"required": false,
- "schema": {
- "type": "string",
- "enum": ["DEPLOYMENT", "COMMAND"]
- }
+ "schema": { "type": "string", "enum": ["DEPLOYMENT", "COMMAND"] }
},
{
"name": "status",
@@ -3026,18 +2507,14 @@
"in": "query",
"description": "User name",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "query",
"in": "query",
"description": "Search text (Search for IOC name, Git reference, Created by)",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
},
{
"name": "order_by",
@@ -3054,48 +2531,38 @@
"in": "query",
"description": "Order Ascending",
"required": false,
- "schema": {
- "type": "boolean"
- }
+ "schema": { "type": "boolean" }
},
{
"name": "page",
"in": "query",
"description": "Page offset",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
},
{
"name": "limit",
"in": "query",
"description": "Page size",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
- "200": {
- "description": "A paged array of deployments",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PagedOperationResponse"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "A paged array of deployments",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GeneralException"
+ "$ref": "#/components/schemas/PagedOperationResponse"
}
}
}
@@ -3104,9 +2571,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -3124,40 +2589,31 @@
"in": "path",
"description": "Unique ID of operation",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "Operation details",
+ "404": {
+ "description": "Not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/OperationDetails"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "200": {
+ "description": "Operation details",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/OperationDetails" }
}
}
},
- "404": {
- "description": "Not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -3165,9 +2621,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -3185,20 +2639,23 @@
"in": "path",
"description": "Unique ID of AWX job",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
+ "404": {
+ "description": "AWX job not found",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
"200": {
"description": "AWX job details",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/AwxJobDetails"
- }
+ "schema": { "$ref": "#/components/schemas/AwxJobDetails" }
}
}
},
@@ -3206,19 +2663,15 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "AWX job not found",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -3226,19 +2679,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
- }
- }
- },
- "503": {
- "description": "Remote service exception",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -3256,20 +2697,15 @@
"in": "path",
"description": "Unique ID of AWX job",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "AWX job log",
+ "404": {
+ "description": "Deployment not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/AwxJobLog"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -3277,48 +2713,36 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Deployment not found",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "AWX job log",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/AwxJobLog" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/deployments/commands": {
@@ -3332,43 +2756,39 @@
"in": "query",
"description": "Unique ID of IOC",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
},
{
"name": "deployment_id",
"in": "query",
"description": "Unique ID of deployment",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
},
{
"name": "page",
"in": "query",
"description": "Page offset",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
},
{
"name": "limit",
"in": "query",
"description": "Page size",
"required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
+ "schema": { "type": "integer", "format": "int32" }
}
],
"responses": {
+ "404": {
+ "description": "Deployment not found",
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
+ }
+ }
+ },
"200": {
"description": "A command with details",
"content": {
@@ -3383,19 +2803,15 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Deployment not found",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -3403,19 +2819,7 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
- }
- }
- },
- "503": {
- "description": "Remote service exception",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -3433,10 +2837,7 @@
"in": "path",
"description": "Unique ID of command",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
@@ -3444,49 +2845,39 @@
"description": "A command descriptor",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/AdHocCommand"
- }
+ "schema": { "$ref": "#/components/schemas/AdHocCommand" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "404": {
+ "description": "Ad-hoc command not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Ad-hoc command not found",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -3504,30 +2895,23 @@
"in": "path",
"description": "Unique ID of the IOC",
"required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
+ "schema": { "type": "integer", "format": "int64" }
}
],
"responses": {
- "200": {
- "description": "Ongoing command (if exists)",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/AdHocCommand"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "503": {
+ "description": "Remote service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -3535,9 +2919,7 @@
"description": "IOC not found",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
@@ -3545,19 +2927,15 @@
"description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "503": {
- "description": "Remote service exception",
+ "200": {
+ "description": "Ongoing command (if exists)",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/AdHocCommand" }
}
}
}
@@ -3574,9 +2952,7 @@
"description": "Announcements text",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Announcements"
- }
+ "schema": { "$ref": "#/components/schemas/Announcements" }
}
}
},
@@ -3584,9 +2960,7 @@
"description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
@@ -3605,71 +2979,52 @@
"in": "query",
"description": "User name query",
"required": false,
- "schema": {
- "type": "string"
- }
+ "schema": { "type": "string" }
}
],
"responses": {
- "200": {
- "description": "Ok",
+ "503": {
+ "description": "Login server unavailable",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "404": {
+ "description": "Role not found by authorization service",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "404": {
- "description": "Role not found by authorization service",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Ok",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "type": "array", "items": { "type": "string" } }
}
}
},
- "503": {
- "description": "Login server unavailable",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/authentication/roles": {
@@ -3679,65 +3034,48 @@
"description": "Get user roles from authorization service",
"operationId": "getUserRoles",
"responses": {
- "200": {
- "description": "Ok",
+ "503": {
+ "description": "Login server unavailable",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "401": {
- "description": "Unauthorized",
+ "403": {
+ "description": "Permission denied",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "403": {
- "description": "Permission denied",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Ok",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "type": "array", "items": { "type": "string" } }
}
}
},
- "503": {
- "description": "Login server unavailable",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
},
"/api/v1/authentication/logout": {
@@ -3747,42 +3085,30 @@
"description": "Logging out the user",
"operationId": "logout",
"responses": {
- "200": {
- "description": "Ok",
+ "503": {
+ "description": "Login server unavailable or remote error",
"content": {
"application/json": {
- "schema": {
- "type": "object"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
},
- "500": {
- "description": "Service exception",
+ "200": {
+ "description": "Ok",
"content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
- }
+ "application/json": { "schema": { "type": "object" } }
}
},
- "503": {
- "description": "Login server unavailable or remote error",
+ "500": {
+ "description": "Service exception",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/GeneralException"
- }
+ "schema": { "$ref": "#/components/schemas/GeneralException" }
}
}
}
},
- "security": [
- {
- "bearerAuth": []
- }
- ]
+ "security": [{ "bearerAuth": [] }]
}
}
},
@@ -3791,227 +3117,131 @@
"GeneralException": {
"type": "object",
"properties": {
- "error": {
- "type": "string"
- },
- "description": {
- "type": "string"
- }
+ "error": { "type": "string" },
+ "description": { "type": "string" }
}
},
"Deployment": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "createdBy": {
- "type": "string"
- },
- "startDate": {
+ "id": { "type": "integer", "format": "int64" },
+ "createdBy": { "type": "string" },
+ "startDate": { "type": "string", "format": "date-time" },
+ "createdAt": { "type": "string", "format": "date-time" },
+ "undeployment": { "type": "boolean" },
+ "namingName": { "type": "string" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
+ "sourceVersion": { "type": "string" },
+ "endDate": { "type": "string", "format": "date-time" },
+ "comment": { "type": "string" },
+ "iocName": { "type": "string" },
+ "host": { "$ref": "#/components/schemas/Host" },
+ "awxJobId": { "type": "integer", "format": "int64" },
+ "sourceUrl": { "type": "string" },
+ "sourceVersionShort": { "type": "string" },
+ "operationStatus": {
"type": "string",
- "format": "date-time"
- },
- "createdAt": {
- "type": "string",
- "format": "date-time"
- },
- "undeployment": {
- "type": "boolean"
- },
- "namingName": {
- "type": "string"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
- "sourceVersion": {
- "type": "string"
- },
- "endDate": {
- "type": "string",
- "format": "date-time"
- },
- "comment": {
- "type": "string"
- },
- "iocName": {
- "type": "string"
- },
- "host": {
- "$ref": "#/components/schemas/Host"
- },
- "status": {
- "type": "string",
- "enum": ["PENDING", "JOB", "QUEUED", "ERROR"]
- },
- "awxJobId": {
- "type": "integer",
- "format": "int64"
- },
- "sourceUrl": {
- "type": "string"
- },
- "sourceVersionShort": {
- "type": "string"
- },
- "jobStatus": {
- "type": "string",
- "enum": [
- "UNKNOWN",
- "new",
- "pending",
- "waiting",
- "running",
- "failed",
- "canceled",
- "error",
- "successful"
- ]
+ "enum": ["UNKNOWN", "QUEUED", "RUNNING", "FAILED", "SUCCESSFUL"]
}
}
},
"Host": {
"type": "object",
"properties": {
- "csEntryId": {
- "type": "integer",
- "format": "int64"
- },
- "csEntryIdValid": {
- "type": "boolean"
- },
- "fqdn": {
- "type": "string"
- },
- "hostName": {
- "type": "string"
- },
- "network": {
- "type": "string"
- }
+ "csEntryId": { "type": "integer", "format": "int64" },
+ "csEntryIdValid": { "type": "boolean" },
+ "fqdn": { "type": "string" },
+ "hostName": { "type": "string" },
+ "network": { "type": "string" }
}
},
"UpdateHostRequest": {
"type": "object",
"properties": {
- "hostCSEntryId": {
- "type": "integer",
- "format": "int64"
- },
- "comment": {
- "type": "string"
- }
+ "hostCSEntryId": { "type": "integer", "format": "int64" },
+ "comment": { "type": "string" }
},
"description": "IOC to update"
},
"Alert": {
"type": "object",
"properties": {
- "type": {
- "type": "string",
- "enum": ["ERROR", "WARNING", "INFO"]
- },
- "message": {
- "type": "string"
- },
- "link": {
- "type": "string"
- }
+ "type": { "type": "string", "enum": ["ERROR", "WARNING", "INFO"] },
+ "message": { "type": "string" },
+ "link": { "type": "string" }
}
},
"Ioc": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "description": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- },
- "namingName": {
- "type": "string"
- },
- "externalNameId": {
- "type": "integer",
- "format": "int64"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
- "sourceUrl": {
- "type": "string"
- },
- "activeDeployment": {
- "$ref": "#/components/schemas/Deployment"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "description": { "type": "string" },
+ "owner": { "type": "string" },
+ "namingName": { "type": "string" },
+ "externalNameId": { "type": "integer", "format": "int64" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
+ "sourceUrl": { "type": "string" },
+ "activeDeployment": { "$ref": "#/components/schemas/Deployment" },
"alerts": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Alert"
- }
+ "items": { "$ref": "#/components/schemas/Alert" }
},
- "active": {
- "type": "boolean"
- }
+ "active": { "type": "boolean" }
}
},
"CreateIoc": {
"type": "object",
"properties": {
- "externalNameId": {
- "type": "integer",
- "format": "int64"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- }
+ "externalNameId": { "type": "integer", "format": "int64" },
+ "gitProjectId": { "type": "integer", "format": "int64" }
},
"description": "IOC to create"
},
"Undeployment": {
"type": "object",
- "properties": {
- "comment": {
- "type": "string"
- }
- },
+ "properties": { "comment": { "type": "string" } },
"description": "Undeployment parameters"
},
"AdHocCommand": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
+ "id": { "type": "integer", "format": "int64" },
"type": {
"type": "string",
"enum": ["DEPLOY", "UNDEPLOY", "START", "STOP"]
},
- "createdBy": {
- "type": "string"
- },
- "startDate": {
- "type": "string",
- "format": "date-time"
- },
- "endDate": {
+ "createdBy": { "type": "string" },
+ "startDate": { "type": "string", "format": "date-time" },
+ "endDate": { "type": "string", "format": "date-time" },
+ "status": {
"type": "string",
- "format": "date-time"
+ "enum": ["UNKNOWN", "QUEUED", "RUNNING", "FAILED", "SUCCESSFUL"]
},
+ "iocName": { "type": "string" },
+ "awxCommandId": { "type": "integer", "format": "int64" }
+ }
+ },
+ "UpdateAndDeployIoc": {
+ "type": "object",
+ "properties": {
+ "comment": { "type": "string" },
+ "sourceVersion": { "type": "string" },
+ "hostCSEntryId": { "type": "integer", "format": "int64" }
+ },
+ "description": "IOC to update"
+ },
+ "AwxJobMeta": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "integer", "format": "int64" },
+ "started": { "type": "string", "format": "date-time" },
+ "finished": { "type": "string", "format": "date-time" },
"status": {
"type": "string",
"enum": [
"UNKNOWN",
+ "CREATED",
+ "QUEUED_BY_BACKEND",
"new",
"pending",
"waiting",
@@ -4021,195 +3251,103 @@
"error",
"successful"
]
- },
- "iocName": {
- "type": "string"
- },
- "awxCommandId": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "UpdateAndDeployIoc": {
- "type": "object",
- "properties": {
- "comment": {
- "type": "string"
- },
- "sourceVersion": {
- "type": "string"
- },
- "hostCSEntryId": {
- "type": "integer",
- "format": "int64"
}
},
- "description": "IOC to update"
+ "description": "Job to update"
},
"LoginResponse": {
"type": "object",
- "properties": {
- "token": {
- "type": "string"
- }
- }
+ "properties": { "token": { "type": "string" } }
},
"Login": {
"type": "object",
"properties": {
- "userName": {
- "type": "string"
- },
- "password": {
- "type": "string"
- }
+ "userName": { "type": "string" },
+ "password": { "type": "string" }
}
},
"IOCUpdateRequest": {
"type": "object",
"properties": {
- "owner": {
- "type": "string"
- },
- "externalNameId": {
- "type": "integer",
- "format": "int64"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- }
+ "owner": { "type": "string" },
+ "externalNameId": { "type": "integer", "format": "int64" },
+ "gitProjectId": { "type": "integer", "format": "int64" }
}
},
"PersonalStatisticsResponse": {
"type": "object",
"properties": {
- "numberOfActiveIocs": {
- "type": "integer",
- "format": "int64"
- }
+ "numberOfActiveIocs": { "type": "integer", "format": "int64" }
}
},
"DbStatistics": {
"type": "object",
"properties": {
- "numberOfCreatedIocs": {
- "type": "integer",
- "format": "int64"
- },
- "numberOfActiveDeployments": {
- "type": "integer",
- "format": "int64"
- },
+ "numberOfCreatedIocs": { "type": "integer", "format": "int64" },
+ "numberOfActiveDeployments": { "type": "integer", "format": "int64" },
"numberOfIocHostsWithIocsDeployed": {
"type": "integer",
"format": "int64"
},
- "numberOfDeployments": {
- "type": "integer",
- "format": "int64"
- }
+ "numberOfDeployments": { "type": "integer", "format": "int64" }
}
},
"GeneralStatisticsResponse": {
"type": "object",
"properties": {
- "dbStatistics": {
- "$ref": "#/components/schemas/DbStatistics"
- },
+ "dbStatistics": { "$ref": "#/components/schemas/DbStatistics" },
"networkMonitoring": {
"$ref": "#/components/schemas/NetworkMonitoring"
},
"networkScopesIocCount": {
"type": "object",
- "additionalProperties": {
- "type": "integer",
- "format": "int32"
- }
+ "additionalProperties": { "type": "integer", "format": "int32" }
}
}
},
"NetworkMonitoring": {
"type": "object",
"properties": {
- "numberOfActiveIocs": {
- "type": "integer",
- "format": "int64"
- },
- "numberOfActiveHosts": {
- "type": "integer",
- "format": "int64"
- },
+ "numberOfActiveIocs": { "type": "integer", "format": "int64" },
+ "numberOfActiveHosts": { "type": "integer", "format": "int64" },
"numberOfIocHostsOnTechnicalNetwork": {
"type": "integer",
"format": "int64"
},
- "numberOfHostsWithIssue": {
- "type": "integer",
- "format": "int64"
- }
+ "numberOfHostsWithIssue": { "type": "integer", "format": "int64" }
}
},
"DeploymentCount": {
"type": "object",
"properties": {
- "iocCount": {
- "type": "integer",
- "format": "int64"
- },
- "countingDate": {
- "type": "string",
- "format": "date-time"
- }
+ "iocCount": { "type": "integer", "format": "int64" },
+ "countingDate": { "type": "string", "format": "date-time" }
}
},
"DeploymentOnHost": {
"type": "object",
"properties": {
- "network": {
- "type": "string"
- },
+ "network": { "type": "string" },
"deployments": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/DeploymentCount"
- }
+ "items": { "$ref": "#/components/schemas/DeploymentCount" }
}
}
},
"IocStatisticsResponse": {
"type": "object",
"properties": {
- "numOfRegisteredIocs": {
- "type": "integer",
- "format": "int64"
- },
- "numOfDeployedIocs": {
- "type": "integer",
- "format": "int64"
- },
- "numOfReachableIocs": {
- "type": "integer",
- "format": "int64"
- },
- "numOfIssueFreeIocs": {
- "type": "integer",
- "format": "int64"
- }
+ "numOfRegisteredIocs": { "type": "integer", "format": "int64" },
+ "numOfDeployedIocs": { "type": "integer", "format": "int64" },
+ "numOfReachableIocs": { "type": "integer", "format": "int64" },
+ "numOfIssueFreeIocs": { "type": "integer", "format": "int64" }
}
},
"HostStatisticsResponse": {
"type": "object",
"properties": {
- "numOfIocHosts": {
- "type": "integer",
- "format": "int64"
- },
- "numOfHostsWithIocs": {
- "type": "integer",
- "format": "int64"
- },
+ "numOfIocHosts": { "type": "integer", "format": "int64" },
+ "numOfHostsWithIocs": { "type": "integer", "format": "int64" },
"numOfReachableHostsWithIocs": {
"type": "integer",
"format": "int64"
@@ -4223,153 +3361,77 @@
"DeploymentStatisticsResponse": {
"type": "object",
"properties": {
- "deploymentDate": {
- "type": "string",
- "format": "date-time"
- },
- "numberOfDeployments": {
- "type": "integer",
- "format": "int64"
- },
- "successfulDeployments": {
- "type": "integer",
- "format": "int64"
- }
+ "deploymentDate": { "type": "string", "format": "date-time" },
+ "numberOfDeployments": { "type": "integer", "format": "int64" },
+ "successfulDeployments": { "type": "integer", "format": "int64" }
}
},
"ActiveIOCSForHistoryResponse": {
"type": "object",
"properties": {
- "iocCount": {
- "type": "integer",
- "format": "int64"
- },
- "historyDate": {
- "type": "string",
- "format": "date-time"
- }
+ "iocCount": { "type": "integer", "format": "int64" },
+ "historyDate": { "type": "string", "format": "date-time" }
}
},
"ActiveIocStatisticsResponse": {
"type": "object",
"properties": {
- "network": {
- "type": "string"
- },
- "iocCount": {
- "type": "integer",
- "format": "int64"
- }
+ "network": { "type": "string" },
+ "iocCount": { "type": "integer", "format": "int64" }
}
},
"PagedRecordResponse": {
"type": "object",
"properties": {
- "totalCount": {
- "type": "integer",
- "format": "int64"
- },
- "listSize": {
- "type": "integer",
- "format": "int32"
- },
- "pageNumber": {
- "type": "integer",
- "format": "int32"
- },
- "limit": {
- "type": "integer",
- "format": "int32"
- },
+ "totalCount": { "type": "integer", "format": "int64" },
+ "listSize": { "type": "integer", "format": "int32" },
+ "pageNumber": { "type": "integer", "format": "int32" },
+ "limit": { "type": "integer", "format": "int32" },
"recordList": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Record"
- }
+ "items": { "$ref": "#/components/schemas/Record" }
}
}
},
"Record": {
"type": "object",
"properties": {
- "name": {
- "type": "string"
- },
- "iocName": {
- "type": "string"
- },
- "hostName": {
- "type": "string"
- },
- "pvStatus": {
- "type": "string",
- "enum": ["ACTIVE", "INACTIVE"]
- },
- "iocVersion": {
- "type": "string"
- }
+ "name": { "type": "string" },
+ "iocName": { "type": "string" },
+ "hostName": { "type": "string" },
+ "pvStatus": { "type": "string", "enum": ["ACTIVE", "INACTIVE"] },
+ "iocVersion": { "type": "string" }
}
},
"RecordDetails": {
"type": "object",
"properties": {
- "name": {
- "type": "string"
- },
- "iocName": {
- "type": "string"
- },
- "hostName": {
- "type": "string"
- },
- "pvStatus": {
- "type": "string",
- "enum": ["ACTIVE", "INACTIVE"]
- },
- "iocVersion": {
- "type": "string"
- },
- "iocId": {
- "type": "integer",
- "format": "int64"
- },
- "hostCSentryId": {
- "type": "integer",
- "format": "int64"
- },
+ "name": { "type": "string" },
+ "iocName": { "type": "string" },
+ "hostName": { "type": "string" },
+ "pvStatus": { "type": "string", "enum": ["ACTIVE", "INACTIVE"] },
+ "iocVersion": { "type": "string" },
+ "iocId": { "type": "integer", "format": "int64" },
+ "hostCSentryId": { "type": "integer", "format": "int64" },
"properties": {
"type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "additionalProperties": { "type": "string" }
}
}
},
"NameResponse": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- }
+ "id": { "type": "integer", "format": "int64" },
+ "name": { "type": "string" },
+ "description": { "type": "string" }
}
},
"LokiMessage": {
"type": "object",
"properties": {
- "logDate": {
- "type": "string",
- "format": "date-time"
- },
- "logMessage": {
- "type": "string"
- }
+ "logDate": { "type": "string", "format": "date-time" },
+ "logMessage": { "type": "string" }
}
},
"LokiResponse": {
@@ -4377,83 +3439,49 @@
"properties": {
"lines": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/LokiMessage"
- }
+ "items": { "$ref": "#/components/schemas/LokiMessage" }
}
}
},
"IocStatusResponse": {
"type": "object",
"properties": {
- "iocId": {
- "type": "integer",
- "format": "int64"
- },
+ "iocId": { "type": "integer", "format": "int64" },
"alertSeverity": {
"type": "string",
"enum": ["ERROR", "WARNING", "INFO"]
},
"alerts": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Alert"
- }
+ "items": { "$ref": "#/components/schemas/Alert" }
},
- "active": {
- "type": "boolean"
- }
+ "active": { "type": "boolean" }
}
},
"ActiveDeployment": {
"type": "object",
"properties": {
- "host": {
- "$ref": "#/components/schemas/DeploymentHostInfo"
- },
- "sourceVersion": {
- "type": "string"
- },
- "sourceVersionShort": {
- "type": "string"
- }
+ "host": { "$ref": "#/components/schemas/DeploymentHostInfo" },
+ "sourceVersion": { "type": "string" },
+ "sourceVersionShort": { "type": "string" }
}
},
"DeploymentHostInfo": {
"type": "object",
"properties": {
- "externalHostId": {
- "type": "integer",
- "format": "int64"
- },
- "hostName": {
- "type": "string"
- },
- "network": {
- "type": "string"
- },
- "hostInfoFromCache": {
- "type": "boolean"
- }
+ "externalHostId": { "type": "integer", "format": "int64" },
+ "hostName": { "type": "string" },
+ "network": { "type": "string" },
+ "hostInfoFromCache": { "type": "boolean" }
}
},
"IocInfo": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "namingName": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "namingName": { "type": "string" },
+ "owner": { "type": "string" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
"activeDeployment": {
"$ref": "#/components/schemas/ActiveDeployment"
}
@@ -4462,723 +3490,321 @@
"PagedIocResponse": {
"type": "object",
"properties": {
- "totalCount": {
- "type": "integer",
- "format": "int64"
- },
- "listSize": {
- "type": "integer",
- "format": "int32"
- },
- "pageNumber": {
- "type": "integer",
- "format": "int32"
- },
- "limit": {
- "type": "integer",
- "format": "int32"
- },
+ "totalCount": { "type": "integer", "format": "int64" },
+ "listSize": { "type": "integer", "format": "int32" },
+ "pageNumber": { "type": "integer", "format": "int32" },
+ "limit": { "type": "integer", "format": "int32" },
"iocList": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/IocInfo"
- }
+ "items": { "$ref": "#/components/schemas/IocInfo" }
}
}
},
"IocDetails": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "description": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- },
- "namingName": {
- "type": "string"
- },
- "externalNameId": {
- "type": "integer",
- "format": "int64"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
- "sourceUrl": {
- "type": "string"
- },
- "activeDeployment": {
- "$ref": "#/components/schemas/Deployment"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "description": { "type": "string" },
+ "owner": { "type": "string" },
+ "namingName": { "type": "string" },
+ "externalNameId": { "type": "integer", "format": "int64" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
+ "sourceUrl": { "type": "string" },
+ "activeDeployment": { "$ref": "#/components/schemas/Deployment" },
"alerts": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Alert"
- }
- },
- "operationInProgress": {
- "type": "boolean"
+ "items": { "$ref": "#/components/schemas/Alert" }
},
- "active": {
- "type": "boolean"
- }
+ "operationInProgress": { "type": "boolean" },
+ "active": { "type": "boolean" }
}
},
"IocWithAlarm": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "description": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- },
- "namingName": {
- "type": "string"
- },
- "externalNameId": {
- "type": "integer",
- "format": "int64"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
- "sourceUrl": {
- "type": "string"
- },
- "activeDeployment": {
- "$ref": "#/components/schemas/Deployment"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "description": { "type": "string" },
+ "owner": { "type": "string" },
+ "namingName": { "type": "string" },
+ "externalNameId": { "type": "integer", "format": "int64" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
+ "sourceUrl": { "type": "string" },
+ "activeDeployment": { "$ref": "#/components/schemas/Deployment" },
"alerts": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Alert"
- }
- },
- "alert": {
- "type": "string",
- "enum": ["ERROR", "WARNING", "INFO"]
+ "items": { "$ref": "#/components/schemas/Alert" }
},
- "active": {
- "type": "boolean"
- }
+ "alert": { "type": "string", "enum": ["ERROR", "WARNING", "INFO"] },
+ "active": { "type": "boolean" }
}
},
"HostInfo": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "fqdn": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "scope": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "network": {
- "type": "string"
- },
- "deviceType": {
- "type": "string"
- }
+ "id": { "type": "integer", "format": "int64" },
+ "fqdn": { "type": "string" },
+ "name": { "type": "string" },
+ "scope": { "type": "string" },
+ "description": { "type": "string" },
+ "network": { "type": "string" },
+ "deviceType": { "type": "string" }
}
},
"HostInfoWithStatus": {
"type": "object",
"properties": {
- "csEntryHost": {
- "$ref": "#/components/schemas/HostInfo"
- },
- "status": {
- "type": "string",
- "enum": ["AVAILABLE", "UNREACHABLE"]
- },
- "alert": {
- "type": "string",
- "enum": ["ERROR", "WARNING", "INFO"]
- },
- "iocDeployed": {
- "type": "boolean"
- }
+ "csEntryHost": { "$ref": "#/components/schemas/HostInfo" },
+ "status": { "type": "string", "enum": ["AVAILABLE", "UNREACHABLE"] },
+ "alert": { "type": "string", "enum": ["ERROR", "WARNING", "INFO"] },
+ "iocDeployed": { "type": "boolean" }
}
},
"PagedCSEntryHostResponse": {
"type": "object",
"properties": {
- "totalCount": {
- "type": "integer",
- "format": "int64"
- },
- "listSize": {
- "type": "integer",
- "format": "int32"
- },
- "pageNumber": {
- "type": "integer",
- "format": "int32"
- },
- "limit": {
- "type": "integer",
- "format": "int32"
- },
+ "totalCount": { "type": "integer", "format": "int64" },
+ "listSize": { "type": "integer", "format": "int32" },
+ "pageNumber": { "type": "integer", "format": "int32" },
+ "limit": { "type": "integer", "format": "int32" },
"csEntryHosts": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/HostInfoWithStatus"
- }
+ "items": { "$ref": "#/components/schemas/HostInfoWithStatus" }
}
}
},
"CSEntryHost": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "fqdn": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "scope": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "user": {
- "type": "string"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "fqdn": { "type": "string" },
+ "name": { "type": "string" },
+ "scope": { "type": "string" },
+ "description": { "type": "string" },
+ "user": { "type": "string" },
"interfaces": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/CSEntryInterface"
- }
- },
- "is_ioc": {
- "type": "boolean"
- },
- "device_type": {
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
+ "items": { "$ref": "#/components/schemas/CSEntryInterface" }
},
+ "is_ioc": { "type": "boolean" },
+ "device_type": { "type": "string" },
+ "created_at": { "type": "string", "format": "date-time" },
"ansible_vars": {
"type": "object",
- "additionalProperties": {
- "type": "object"
- }
+ "additionalProperties": { "type": "object" }
},
- "ansible_groups": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
+ "ansible_groups": { "type": "array", "items": { "type": "string" } }
}
},
"CSEntryHostWithStatus": {
"type": "object",
"properties": {
- "csEntryHost": {
- "$ref": "#/components/schemas/CSEntryHost"
- },
- "assigned": {
- "type": "boolean"
- },
- "status": {
- "type": "string",
- "enum": ["AVAILABLE", "UNREACHABLE"]
- },
+ "csEntryHost": { "$ref": "#/components/schemas/CSEntryHost" },
+ "assigned": { "type": "boolean" },
+ "status": { "type": "string", "enum": ["AVAILABLE", "UNREACHABLE"] },
"alerts": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Alert"
- }
+ "items": { "$ref": "#/components/schemas/Alert" }
}
}
},
"CSEntryInterface": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "network": {
- "type": "string"
- },
- "domain": {
- "type": "string"
- },
- "ip": {
- "type": "string"
- },
- "mac": {
- "type": "string"
- },
- "host": {
- "type": "string"
- },
- "cnames": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "is_main": {
- "type": "boolean"
- }
+ "id": { "type": "integer", "format": "int64" },
+ "name": { "type": "string" },
+ "network": { "type": "string" },
+ "domain": { "type": "string" },
+ "ip": { "type": "string" },
+ "mac": { "type": "string" },
+ "host": { "type": "string" },
+ "cnames": { "type": "array", "items": { "type": "string" } },
+ "is_main": { "type": "boolean" }
}
},
"PagedAssociatedIocs": {
"type": "object",
"properties": {
- "totalCount": {
- "type": "integer",
- "format": "int64"
- },
- "listSize": {
- "type": "integer",
- "format": "int32"
- },
- "pageNumber": {
- "type": "integer",
- "format": "int32"
- },
- "limit": {
- "type": "integer",
- "format": "int32"
- },
+ "totalCount": { "type": "integer", "format": "int64" },
+ "listSize": { "type": "integer", "format": "int32" },
+ "pageNumber": { "type": "integer", "format": "int32" },
+ "limit": { "type": "integer", "format": "int32" },
"deployedIocs": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/IocInfo"
- }
+ "items": { "$ref": "#/components/schemas/IocInfo" }
}
}
},
"TargetHost": {
"type": "object",
"properties": {
- "externalId": {
- "type": "integer",
- "format": "int64"
- },
- "fqdn": {
- "type": "string"
- },
- "hostName": {
- "type": "string"
- },
- "network": {
- "type": "string"
- }
+ "externalId": { "type": "integer", "format": "int64" },
+ "fqdn": { "type": "string" },
+ "hostName": { "type": "string" },
+ "network": { "type": "string" }
}
},
"IdUsedByIoc": {
"type": "object",
- "properties": {
- "iocId": {
- "type": "integer",
- "format": "int64"
- }
- }
+ "properties": { "iocId": { "type": "integer", "format": "int64" } }
},
"GitReference": {
"type": "object",
"properties": {
- "reference": {
- "type": "string"
- },
- "shortReference": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "commitDate": {
- "type": "string",
- "format": "date-time"
- }
+ "reference": { "type": "string" },
+ "shortReference": { "type": "string" },
+ "description": { "type": "string" },
+ "commitDate": { "type": "string", "format": "date-time" }
}
},
"UserInfoResponse": {
"type": "object",
"properties": {
- "fullName": {
- "type": "string"
- },
- "loginName": {
- "type": "string"
- },
- "avatar": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "gitlabUserName": {
- "type": "string"
- }
+ "fullName": { "type": "string" },
+ "loginName": { "type": "string" },
+ "avatar": { "type": "string" },
+ "email": { "type": "string" },
+ "gitlabUserName": { "type": "string" }
}
},
"GitProject": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "url": {
- "type": "string"
- }
+ "id": { "type": "integer", "format": "int64" },
+ "url": { "type": "string" }
}
},
"Operation": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "createdBy": {
- "type": "string"
- },
- "startTime": {
- "type": "string",
- "format": "date-time"
- },
- "createdAt": {
- "type": "string",
- "format": "date-time"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "createdBy": { "type": "string" },
+ "startTime": { "type": "string", "format": "date-time" },
+ "createdAt": { "type": "string", "format": "date-time" },
"type": {
"type": "string",
"enum": ["DEPLOY", "UNDEPLOY", "START", "STOP"]
},
- "iocName": {
- "type": "string"
- },
- "iocId": {
- "type": "integer",
- "format": "int64"
- },
- "deploymentId": {
- "type": "integer",
- "format": "int64"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
- "gitReference": {
- "type": "string"
- },
- "host": {
- "$ref": "#/components/schemas/DeploymentHostInfo"
- },
+ "iocName": { "type": "string" },
+ "iocId": { "type": "integer", "format": "int64" },
+ "deploymentId": { "type": "integer", "format": "int64" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
+ "gitReference": { "type": "string" },
+ "host": { "$ref": "#/components/schemas/DeploymentHostInfo" },
"status": {
"type": "string",
- "enum": [
- "UNKNOWN",
- "PENDING",
- "QUEUED",
- "ERROR",
- "WAITING",
- "RUNNING",
- "FAILED",
- "CANCELED",
- "SUCCESSFUL"
- ]
+ "enum": ["UNKNOWN", "QUEUED", "RUNNING", "FAILED", "SUCCESSFUL"]
}
}
},
"PagedOperationResponse": {
"type": "object",
"properties": {
- "totalCount": {
- "type": "integer",
- "format": "int64"
- },
- "listSize": {
- "type": "integer",
- "format": "int32"
- },
- "pageNumber": {
- "type": "integer",
- "format": "int32"
- },
- "limit": {
- "type": "integer",
- "format": "int32"
- },
+ "totalCount": { "type": "integer", "format": "int64" },
+ "listSize": { "type": "integer", "format": "int32" },
+ "pageNumber": { "type": "integer", "format": "int32" },
+ "limit": { "type": "integer", "format": "int32" },
"operations": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Operation"
- }
+ "items": { "$ref": "#/components/schemas/Operation" }
}
}
},
"DeploymentInfoDetails": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "createdBy": {
- "type": "string"
- },
- "startDate": {
- "type": "string",
- "format": "date-time"
- },
- "createdAt": {
- "type": "string",
- "format": "date-time"
- },
- "undeployment": {
- "type": "boolean"
- },
- "namingName": {
- "type": "string"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
- "sourceVersion": {
- "type": "string"
- },
- "endDate": {
- "type": "string",
- "format": "date-time"
- },
- "comment": {
- "type": "string"
- },
- "host": {
- "$ref": "#/components/schemas/HostWithFqdn"
- },
- "status": {
- "type": "string",
- "enum": ["PENDING", "JOB", "QUEUED", "ERROR"]
- },
- "awxJobId": {
- "type": "integer",
- "format": "int64"
- },
- "iocId": {
- "type": "integer",
- "format": "int64"
- },
- "awxJobUrl": {
- "type": "string"
- },
- "sourceUrl": {
- "type": "string"
- },
- "sourceVersionShort": {
- "type": "string"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "createdBy": { "type": "string" },
+ "startDate": { "type": "string", "format": "date-time" },
+ "createdAt": { "type": "string", "format": "date-time" },
+ "undeployment": { "type": "boolean" },
+ "namingName": { "type": "string" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
+ "sourceVersion": { "type": "string" },
+ "endDate": { "type": "string", "format": "date-time" },
+ "comment": { "type": "string" },
+ "host": { "$ref": "#/components/schemas/HostWithFqdn" },
+ "awxJobId": { "type": "integer", "format": "int64" },
+ "iocId": { "type": "integer", "format": "int64" },
+ "awxJobUrl": { "type": "string" },
+ "sourceUrl": { "type": "string" },
+ "sourceVersionShort": { "type": "string" },
"alerts": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Alert"
- }
+ "items": { "$ref": "#/components/schemas/Alert" }
}
}
},
"HostWithFqdn": {
"type": "object",
"properties": {
- "csEntryId": {
- "type": "integer",
- "format": "int64"
- },
- "csEntryIdValid": {
- "type": "boolean"
- },
- "fqdn": {
- "type": "string"
- }
+ "csEntryId": { "type": "integer", "format": "int64" },
+ "csEntryIdValid": { "type": "boolean" },
+ "fqdn": { "type": "string" }
}
},
"OperationDetails": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "createdBy": {
- "type": "string"
- },
- "startTime": {
- "type": "string",
- "format": "date-time"
- },
- "createdAt": {
- "type": "string",
- "format": "date-time"
- },
+ "id": { "type": "integer", "format": "int64" },
+ "createdBy": { "type": "string" },
+ "startTime": { "type": "string", "format": "date-time" },
+ "createdAt": { "type": "string", "format": "date-time" },
"type": {
"type": "string",
"enum": ["DEPLOY", "UNDEPLOY", "START", "STOP"]
},
- "iocName": {
- "type": "string"
- },
- "iocId": {
- "type": "integer",
- "format": "int64"
- },
- "deploymentId": {
- "type": "integer",
- "format": "int64"
- },
- "gitProjectId": {
- "type": "integer",
- "format": "int64"
- },
- "gitReference": {
- "type": "string"
- },
- "gitProjectUrl": {
- "type": "string"
- },
- "gitShortReference": {
- "type": "string"
- },
- "host": {
- "$ref": "#/components/schemas/HostWithFqdn"
- },
- "awxJobId": {
- "type": "integer",
- "format": "int64"
- },
- "awxJobUrl": {
- "type": "string"
- }
+ "iocName": { "type": "string" },
+ "iocId": { "type": "integer", "format": "int64" },
+ "deploymentId": { "type": "integer", "format": "int64" },
+ "gitProjectId": { "type": "integer", "format": "int64" },
+ "gitReference": { "type": "string" },
+ "gitProjectUrl": { "type": "string" },
+ "gitShortReference": { "type": "string" },
+ "host": { "$ref": "#/components/schemas/HostWithFqdn" },
+ "awxJobId": { "type": "integer", "format": "int64" },
+ "awxJobUrl": { "type": "string" }
}
},
"AwxJobDetails": {
"type": "object",
"properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
+ "id": { "type": "integer", "format": "int64" },
"status": {
"type": "string",
- "enum": [
- "UNKNOWN",
- "new",
- "pending",
- "waiting",
- "running",
- "failed",
- "canceled",
- "error",
- "successful"
- ]
+ "enum": ["UNKNOWN", "QUEUED", "RUNNING", "FAILED", "SUCCESSFUL"]
},
- "started": {
- "type": "string",
- "format": "date-time"
- },
- "finished": {
- "type": "string",
- "format": "date-time"
- }
+ "started": { "type": "string", "format": "date-time" },
+ "finished": { "type": "string", "format": "date-time" }
}
},
"AwxJobLog": {
"type": "object",
"properties": {
- "awxJobId": {
- "type": "integer",
- "format": "int64"
- },
- "stdoutHtml": {
- "type": "string"
- },
- "elapsed": {
- "type": "number",
- "format": "double"
- }
+ "awxJobId": { "type": "integer", "format": "int64" },
+ "stdoutHtml": { "type": "string" },
+ "elapsed": { "type": "number", "format": "double" }
}
},
"PagedCommandResponse": {
"type": "object",
"properties": {
- "totalCount": {
- "type": "integer",
- "format": "int64"
- },
- "listSize": {
- "type": "integer",
- "format": "int32"
- },
- "pageNumber": {
- "type": "integer",
- "format": "int32"
- },
- "limit": {
- "type": "integer",
- "format": "int32"
- },
+ "totalCount": { "type": "integer", "format": "int64" },
+ "listSize": { "type": "integer", "format": "int32" },
+ "pageNumber": { "type": "integer", "format": "int32" },
+ "limit": { "type": "integer", "format": "int32" },
"commands": {
"type": "array",
- "items": {
- "$ref": "#/components/schemas/Operation"
- }
+ "items": { "$ref": "#/components/schemas/Operation" }
}
}
},
"Announcements": {
"type": "object",
- "properties": {
- "announcementsText": {
- "type": "string"
- }
- }
+ "properties": { "announcementsText": { "type": "string" } }
}
},
"securitySchemes": {
- "apiKey": {
- "type": "apiKey",
- "name": "CCCE-TOKEN",
- "in": "header"
- },
+ "apiKey": { "type": "apiKey", "name": "CCCE-TOKEN", "in": "header" },
"bearerAuth": {
"type": "http",
"scheme": "bearer",
diff --git a/src/views/deployments/DeploymentDetailsContainer.spec.js b/src/views/deployments/DeploymentDetailsContainer.spec.js
index 829c390d..cbd3e861 100644
--- a/src/views/deployments/DeploymentDetailsContainer.spec.js
+++ b/src/views/deployments/DeploymentDetailsContainer.spec.js
@@ -21,9 +21,8 @@ function commonTests() {
cy.get(".MuiAlert-message").contains("The deployment job failed");
// Stepper
- cy.get(".MuiStep-completed").contains("Creating Deployment");
cy.get(".MuiStep-completed").contains("Deployment Queued");
- cy.get(".Mui-error").contains("Running Deployment");
+ cy.get(".Mui-error").contains("Deployment Running");
cy.get(".Mui-disabled").contains("Deployment Completed");
}
--
GitLab