io.github.dronesecurity.userapplication.presentation.reporting.negligence.negligentAPI.json Maven / Gradle / Ivy

Go to download
{
  "openapi": "3.0.3",
  "info": {
    "title": "API exposing negligent operations.",
    "version": "1.0.1"
  },
  "servers": [
    {
      "url": "http://{host}:{port}/{basePath}",
      "description": "Localhost server",
      "variables": {
        "host": {
          "default": "localhost"
        },
        "port": {
          "default": "18000"
        },
        "basePath": {
          "default": "negligentAPI"
        }
      }
    }
  ],
  "paths": {
    "/retrieveOpenReports": {
      "get": {
        "operationId": "retrieveOpenReports",
        "parameters": [
          {
            "name": "negligent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved open reports.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Reports"
                }
              }
            }
          }
        }
      }
    },
    "/retrieveClosedReports": {
      "get": {
        "operationId": "retrieveClosedReports",
        "parameters": [
          {
            "name": "negligent",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved closed reports.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Reports"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Reports": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Report"
        },
        "uniqueItems": true
      },
      "Report": {
        "type": "object",
        "required": ["id", "negligent", "assignee", "data"],
        "properties": {
          "id" : {
            "type": "integer"
          },
          "negligent" : {
            "type": "string"
          },
          "assignee" : {
            "type": "string"
          },
          "data": {
            "type": "object",
            "properties": {
              "detectionInstant": {
                "type": "string"
              },
              "proximity": {
                "type": "number"
              },
              "roll": {
                "type": "integer"
              },
              "pitch": {
                "type": "integer"
              },
              "yaw": {
                "type": "integer"
              },
              "image": {
                "type": "integer"
              }
            }
          },
          "actionForm": {
            "type": "object",
            "properties": {
              "solution": {
                "type": "string"
              },
              "closingInstant": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}