swagger.api-files-swagger.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of molgenis-api-files Show documentation
File upload/download API.
The newest version!
{
  "swagger" : "2.0",
  "info" : {
    "description" : "File upload/download API.",
    "version" : "8.4.5",
    "title" : "api-files"
  },
  "tags" : [ {
    "name" : "Files"
  } ],
  "paths" : {
    "/api/files" : {
      "post" : {
        "tags" : [ "Files" ],
        "summary" : "Upload file (see documentation)",
        "description" : "",
        "operationId" : "createFile",
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/CompletableFutureResponseEntityFileResponse"
            }
          },
          "201" : {
            "description" : ""
          }
        }
      }
    },
    "/api/files/{fileId}" : {
      "get" : {
        "tags" : [ "Files" ],
        "summary" : "Download file (see documentation)",
        "description" : "",
        "operationId" : "downloadFile",
        "parameters" : [ {
          "name" : "fileId",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/StreamingResponseBody"
            }
          }
        }
      },
      "delete" : {
        "tags" : [ "Files" ],
        "summary" : "Delete file (see documentation)",
        "description" : "",
        "operationId" : "deleteFile",
        "parameters" : [ {
          "name" : "fileId",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "204" : {
            "description" : ""
          }
        }
      }
    }
  },
  "definitions" : {
    "CompletableFuture" : {
      "type" : "object",
      "properties" : {
        "done" : {
          "type" : "boolean"
        },
        "cancelled" : {
          "type" : "boolean"
        },
        "completedExceptionally" : {
          "type" : "boolean"
        },
        "numberOfDependents" : {
          "type" : "integer",
          "format" : "int32"
        }
      }
    },
    "CompletableFutureResponseEntityFileResponse" : {
      "type" : "object",
      "properties" : {
        "done" : {
          "type" : "boolean"
        },
        "cancelled" : {
          "type" : "boolean"
        },
        "completedExceptionally" : {
          "type" : "boolean"
        },
        "numberOfDependents" : {
          "type" : "integer",
          "format" : "int32"
        }
      }
    },
    "FileResponse" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "size" : {
          "type" : "integer",
          "format" : "int64"
        },
        "contentType" : {
          "type" : "string"
        },
        "filename" : {
          "type" : "string"
        }
      }
    },
    "StreamingResponseBody" : {
      "type" : "object"
    }
  }
}