open-api.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "File-Share API",
    "version": "0.1.0"
  },
  "paths": {
    "/files": {
      "post": {
        "tags": ["File"],
        "summary": "Uploads a file",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "required": true
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the key pair object upon success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "publicKey": {
                      "type": "string",
                      "description": "The key that is usually distributed to consumers"
                    },
                    "privateKey": {
                      "type": "string",
                      "description": "The key that belongs to uploader"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "When file is missing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorResponse"
                }
              }
            }
          },
          "429": {
            "description": "When upload limit already reached for the day",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/files/{privateKey}": {
      "delete": {
        "tags": ["File"],
        "summary": "Deletes the file",
        "parameters": [
          {
            "name": "privateKey",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No content is returned upon success"
          },
          "404": {
            "description": "When file does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/files/{publicKey}": {
      "get": {
        "tags": ["File"],
        "summary": "Returns the file upon success",
        "parameters": [
          {
            "name": "publicKey",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The file"
          },
          "404": {
            "description": "When file does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorResponse"
                }
              }
            }
          },
          "429": {
            "description": "When download limit already reached for the day",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "errorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "The error message"
          }
        }
      }
    }
  }
}