openapi.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "OmnAIView- OpenAPI 3.0.1",
    "version": "0.1.0",
    "description": "This is the description of the API used for the OmnAIView software. For each analysis that can be connected to the OmnAIView software an API has to be provided. This API should be implementing the following Interface.\n\nSome useful links:\n- [OmnAIView Repository](https://github.com/skunkforce/OmniView)\n- [OmnAIView FFT example FFT]()"
  },
  "tags": [
    {
      "name": "Informations",
      "description": "Everything to know about the API"
    },
    {
      "name": "Analyze and Generate Training data",
      "description": "Endpoints for the analysis"
    },
    {
      "name": "Test your API",
      "description": "Endpoints to test your API"
    }
  ],
  "paths": {
    "/version": {
      "get": {
        "tags": [
          "Informations"
        ],
        "summary": "Get version",
        "description": "Get the current version of the API ; format main.feature.patch",
        "operationId": "getVersion",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppVersion"
                }
              }
            }
          }
        }
      }
    },
    "/info": {
      "get": {
        "tags": [
          "Informations"
        ],
        "summary": "Get Information",
        "description": "Get Information about the APIs function and main usage",
        "operationId": "getInfo",
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/APIInfo"
                }
              }
            }
          }
        }
      }
    },
    "/analyze": {
      "post": {
        "tags": [
          "Analyze and Generate Training data"
        ],
        "summary": "Analyze Waveform",
        "description": "Analysing the data that was send and responding with an answer. If only data should be generated this should still answer with a sucessful response. If metadata is needed this information will be transfered from the user via a form. To generate the correct form fields each formular field has a specific datatype. This datatype should be set as the type property. If a description to the field should be visible in the form, this needs to be added as a title. The following table lists the datatypes for each form field: int :: number field, string :: Input field, enum :: Drop Down Menu, boolean :: Radio Buttons. The fields need to be described in the properties section of the meta field. The response follows the same rules. The data field will be visualized as a drag and drop field for the request and is optional for the response.",
        "operationId": "analyzeWaveform",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Waveform"
              }
            }
          }
        },
        "responses": { 
          "200": {
            "description": "Successful analysis",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request format or data.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "examples": [
                        "Invalid waveform data."
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/upload": {
      "post": {
        "tags": [
          "Analyze and Generate Training data"
        ],
        "summary": "Upload Training data",
        "description": "Taking the data that was send for a AI-Modell, if not needed there still should be a response. If additional metadata is needed the form follows the same rules as the analyze endpoint.",
        "operationId": "uploadTrainingData",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Waveform"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Data was send successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "examples": [
                        "Data was send successfully"
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request format or data.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "examples": [
                        "Invalid waveform data."
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }, 
  "components": {
    "schemas": {
      "AppVersion": {
        "type": "object",
        "properties": {
          "app_version": {
            "type": "string",
            "title": "App Version"
          },
          "commit_hash": {
            "type": "string",
            "title": "Commit Hash"
          },
          "build_date": {
            "type": "string",
            "title": "Build Date"
          },
          "maintainer": {
            "type": "string",
            "title": "Maintainer"
          }
        },
        "required": [
          "app_version",
          "commit_hash",
          "build_date",
          "maintainer"
        ],
        "title": "AppVersion"
      },
      "APIInfo": {
        "type": "object",
        "properties": {
          "apiVersion": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        },
        "title": "API Information"
      },
      "FormInfo": {
        "type": "object",
        "properties": {
          "apiVersion": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        },
        "title": "API Information"
      },
      "Waveform": {
        "type": "object",
        "properties": {
          "meta": {
            "type": "object",
            "description": "Here are all informations that are needed for the formular fields",
            "properties": {}
          },
          "data": {
            "type": "object",
            "properties": {
              "sampling_rate": {
                "type": "number",
                "format": "float"
              },
              "y_values": {
                "type": "array",
                "items": {
                  "type": "number",
                  "format": "float"
                }
              }
            },
            "required": [
              "sampling_rate",
              "y"
            ]
          }
        },
        "required": [
          "meta",
          "data"
        ],
        "title": "Waveform"
      },
      "Result": { 
        "type": "object",
        "description": "Here are all informations that the user gets from the analysis, the data field needs to be set here in the properties",
        "properties": {}
      }
    }
  }
}