auditforge / docs /api /swagger.json
Kaballas's picture
initialize project structure with essential configurations and components
56b6519
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "REST API",
"description": ""
},
"host": "localhost:3000",
"basePath": "/",
"schemes": [
"http"
],
"paths": {
"/api/audits": {
"get": {
"description": "",
"parameters": [
{
"name": "findingTitle",
"in": "query",
"type": "string"
}
],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"language": {
"example": "any"
},
"auditType": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/audits/{auditId}": {
"delete": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
},
"get": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/audits/{auditId}/general": {
"get": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"reviewers": {
"example": "any"
},
"collaborators": {
"example": "any"
},
"name": {
"example": "any"
},
"location": {
"example": "any"
},
"date": {
"example": "any"
},
"date_start": {
"example": "any"
},
"date_end": {
"example": "any"
},
"client": {
"example": "any"
},
"company": {
"example": "any"
},
"language": {
"example": "any"
},
"scope": {
"example": "any"
},
"template": {
"example": "any"
},
"customFields": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/audits/{auditId}/network": {
"get": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"scope": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/audits/{auditId}/findings": {
"post": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"example": "any"
},
"vulnType": {
"example": "any"
},
"description": {
"example": "any"
},
"observation": {
"example": "any"
},
"remediation": {
"example": "any"
},
"remediationComplexity": {
"example": "any"
},
"priority": {
"example": "any"
},
"references": {
"example": "any"
},
"cwes": {
"example": "any"
},
"cvssv3": {
"example": "any"
},
"poc": {
"example": "any"
},
"scope": {
"example": "any"
},
"status": {
"example": "any"
},
"category": {
"example": "any"
},
"customFields": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/audits/{auditId}/findings/{findingId}": {
"get": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "findingId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "findingId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"example": "any"
},
"vulnType": {
"example": "any"
},
"description": {
"example": "any"
},
"observation": {
"example": "any"
},
"remediation": {
"example": "any"
},
"remediationComplexity": {
"example": "any"
},
"priority": {
"example": "any"
},
"references": {
"example": "any"
},
"cwes": {
"example": "any"
},
"cvssv3": {
"example": "any"
},
"poc": {
"example": "any"
},
"scope": {
"example": "any"
},
"status": {
"example": "any"
},
"category": {
"example": "any"
},
"customFields": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "findingId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/audits/{auditId}/sections/{sectionId}": {
"get": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "sectionId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "sectionId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"customFields": {
"example": "any"
},
"text": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/audits/{auditId}/generate": {
"get": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/audits/{auditId}/sortfindings": {
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"sortFindings": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/audits/{auditId}/movefinding": {
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"oldIndex": {
"example": "any"
},
"newIndex": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/audits/{auditId}/toggleApproval": {
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/audits/{auditId}/updateReadyForReview": {
"put": {
"description": "",
"parameters": [
{
"name": "auditId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"state": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/clients": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"email": {
"example": "any"
},
"lastname": {
"example": "any"
},
"firstname": {
"example": "any"
},
"phone": {
"example": "any"
},
"cell": {
"example": "any"
},
"title": {
"example": "any"
},
"company": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/clients/{id}": {
"put": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"email": {
"example": "any"
},
"lastname": {
"example": "any"
},
"firstname": {
"example": "any"
},
"phone": {
"example": "any"
},
"cell": {
"example": "any"
},
"title": {
"example": "any"
},
"company": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/companies": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"shortName": {
"example": "any"
},
"logo": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/companies/{id}": {
"put": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"shortName": {
"example": "any"
},
"logo": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/data/roles": {
"get": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/data/languages": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"locale": {
"example": "any"
},
"language": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"locale": {
"example": "any"
},
"req": {
"example": "any"
},
"forEach(e": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/data/languages/{locale(*)}": {
"delete": {
"description": "",
"parameters": [
{
"name": "locale(*)",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/data/audit-types": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"templates": {
"example": "any"
},
"sections": {
"example": "any"
},
"hidden": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"templates": {
"example": "any"
},
"forEach(e": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/data/audit-types/{name(*)}": {
"delete": {
"description": "",
"parameters": [
{
"name": "name(*)",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/data/vulnerability-types": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"locale": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"locale": {
"example": "any"
},
"forEach(e": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/data/vulnerability-types/{name(*)}": {
"delete": {
"description": "",
"parameters": [
{
"name": "name(*)",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/data/vulnerability-categories": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"sortValue": {
"example": "any"
},
"sortOrder": {
"example": "any"
},
"sortAuto": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"forEach(e": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/data/vulnerability-categories/{name(*)}": {
"delete": {
"description": "",
"parameters": [
{
"name": "name(*)",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/data/sections": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"field": {
"example": "any"
},
"name": {
"example": "any"
},
"locale": {
"example": "any"
},
"text": {
"example": "any"
},
"icon": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"field": {
"example": "any"
},
"forEach(e": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/data/sections/{field}/{locale(*)}": {
"delete": {
"description": "",
"parameters": [
{
"name": "field",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "locale(*)",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/data/custom-fields": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"fieldType": {
"example": "any"
},
"label": {
"example": "any"
},
"display": {
"example": "any"
},
"displaySub": {
"example": "any"
},
"size": {
"example": "any"
},
"offset": {
"example": "any"
},
"required": {
"example": "any"
},
"description": {
"example": "any"
},
"text": {
"example": "any"
},
"options": {
"example": "any"
},
"position": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"label": {
"example": "any"
},
"_id": {
"example": "any"
},
"display": {
"example": "any"
},
"fieldType": {
"example": "any"
},
"forEach(e": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/data/custom-fields/{fieldId}": {
"delete": {
"description": "",
"parameters": [
{
"name": "fieldId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/images/{imageId}": {
"get": {
"description": "",
"parameters": [
{
"name": "imageId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [
{
"name": "imageId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/images/": {
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"value": {
"example": "any"
},
"name": {
"example": "any"
},
"auditId": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/images/download/{imageId}": {
"get": {
"description": "",
"parameters": [
{
"name": "imageId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/settings": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"put": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/settings/public": {
"get": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/settings/revert": {
"put": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/settings/export": {
"get": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/templates": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"file": {
"example": "any"
},
"ext": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/templates/{templateId}": {
"put": {
"description": "",
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"example": "any"
},
"file": {
"example": "any"
},
"ext": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/templates/download/{templateId}": {
"get": {
"description": "",
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/users/checktoken": {
"get": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/users/refreshtoken": {
"get": {
"description": "",
"parameters": [
{
"name": "user-agent",
"in": "header",
"type": "string"
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/users/token": {
"post": {
"description": "",
"parameters": [
{
"name": "user-agent",
"in": "header",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"password": {
"example": "any"
},
"username": {
"example": "any"
},
"totpToken": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/users/init": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/users": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"username": {
"example": "any"
},
"password": {
"example": "any"
},
"firstname": {
"example": "any"
},
"lastname": {
"example": "any"
},
"role": {
"example": "any"
},
"email": {
"example": "any"
},
"phone": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/users/reviewers": {
"get": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/users/me": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"put": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"currentPassword": {
"example": "any"
},
"newPassword": {
"example": "any"
},
"confirmPassword": {
"example": "any"
},
"username": {
"example": "any"
},
"firstname": {
"example": "any"
},
"lastname": {
"example": "any"
},
"email": {
"example": "any"
},
"phone": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/users/totp": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"totpToken": {
"example": "any"
},
"totpSecret": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"totpToken": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/users/{username}": {
"get": {
"description": "",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/users/{id}": {
"put": {
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"password": {
"example": "any"
},
"username": {
"example": "any"
},
"firstname": {
"example": "any"
},
"lastname": {
"example": "any"
},
"email": {
"example": "any"
},
"phone": {
"example": "any"
},
"role": {
"example": "any"
},
"totpEnabled": {
"example": "any"
},
"enabled": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/vulnerabilities": {
"get": {
"description": "",
"parameters": [],
"responses": {}
},
"post": {
"description": "",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"length": {
"example": "any"
},
"details": {
"example": "any"
},
"cvssv3": {
"example": "any"
},
"priority": {
"example": "any"
},
"remediationComplexity": {
"example": "any"
},
"category": {
"example": "any"
},
"status": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/vulnerabilities/export": {
"get": {
"description": "",
"parameters": [],
"responses": {}
}
},
"/api/vulnerabilities/{vulnerabilityId}": {
"put": {
"description": "",
"parameters": [
{
"name": "vulnerabilityId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"details": {
"example": "any"
},
"cvssv3": {
"example": "any"
},
"priority": {
"example": "any"
},
"remediationComplexity": {
"example": "any"
},
"category": {
"example": "any"
},
"status": {
"example": "any"
}
}
}
}
],
"responses": {}
},
"delete": {
"description": "",
"parameters": [
{
"name": "vulnerabilityId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/vulnerabilities/{locale}": {
"get": {
"description": "",
"parameters": [
{
"name": "locale",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/vulnerabilities/finding/{locale}": {
"post": {
"description": "",
"parameters": [
{
"name": "locale",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"example": "any"
},
"cvssv3": {
"example": "any"
},
"priority": {
"example": "any"
},
"remediationComplexity": {
"example": "any"
},
"references": {
"example": "any"
},
"vulnType": {
"example": "any"
},
"description": {
"example": "any"
},
"observation": {
"example": "any"
},
"remediation": {
"example": "any"
},
"category": {
"example": "any"
},
"customFields": {
"example": "any"
}
}
}
}
],
"responses": {}
}
},
"/api/vulnerabilities/updates/{vulnId}": {
"get": {
"description": "",
"parameters": [
{
"name": "vulnId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {}
}
},
"/api/vulnerabilities/merge/{vulnId}": {
"put": {
"description": "",
"parameters": [
{
"name": "vulnId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"vulnId": {
"example": "any"
},
"locale": {
"example": "any"
}
}
}
}
],
"responses": {}
}
}
}
}