service.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "File Storage Service",
    "version": "0.1"
  },
  "tags": [
    {
      "name": "FileStorageService"
    }
  ],
  "host": "localhost:8081",
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/v1/delete": {
      "delete": {
        "summary": "Delete deletes the file by given bucket and object name.",
        "operationId": "FileStorageService_Delete",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/Empty"
            }
          },
          "400": {
            "description": "Returned when the request parameters are invalid.",
            "schema": {}
          },
          "401": {
            "description": "Returned when the request lacks valid authentication credentials.",
            "schema": {}
          },
          "403": {
            "description": "Returned when the user does not have permission to access the resource.",
            "schema": {}
          },
          "500": {
            "description": "Returned when the server encountered an unexpected condition that prevented it from fulfilling the request.",
            "schema": {}
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "object",
            "description": "The Object name of target delete File.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "bucket",
            "description": "The Bucket name of target delete File.",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "FileStorageService"
        ]
      }
    },
    "/v1/list": {
      "get": {
        "summary": "List lists the files by given bucket name.",
        "operationId": "FileStorageService_List",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/ListResponse"
            }
          },
          "400": {
            "description": "Returned when the request parameters are invalid.",
            "schema": {}
          },
          "401": {
            "description": "Returned when the request lacks valid authentication credentials.",
            "schema": {}
          },
          "403": {
            "description": "Returned when the user does not have permission to access the resource.",
            "schema": {}
          },
          "500": {
            "description": "Returned when the server encountered an unexpected condition that prevented it from fulfilling the request.",
            "schema": {}
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "bucket",
            "description": "The Bucket name of target delete File.",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "FileStorageService"
        ]
      }
    },
    "/v1/upload": {
      "post": {
        "summary": "Upload uploads file to storage both request and response as stream.",
        "operationId": "FileStorageService_Upload",
        "responses": {
          "200": {
            "description": "A successful response.(streaming responses)",
            "schema": {
              "type": "object",
              "properties": {
                "result": {
                  "$ref": "#/definitions/UploadResponse"
                },
                "error": {
                  "$ref": "#/definitions/rpcStatus"
                }
              },
              "title": "Stream result of UploadResponse"
            }
          },
          "400": {
            "description": "Returned when the request parameters are invalid.",
            "schema": {}
          },
          "401": {
            "description": "Returned when the request lacks valid authentication credentials.",
            "schema": {}
          },
          "403": {
            "description": "Returned when the user does not have permission to access the resource.",
            "schema": {}
          },
          "500": {
            "description": "Returned when the server encountered an unexpected condition that prevented it from fulfilling the request.",
            "schema": {}
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "description": " (streaming inputs)",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UploadRequest"
            }
          }
        ],
        "tags": [
          "FileStorageService"
        ]
      }
    }
  },
  "definitions": {
    "Empty": {
      "type": "object",
      "title": "Empty"
    },
    "FileUpload": {
      "type": "object",
      "properties": {
        "data": {
          "type": "string",
          "format": "byte",
          "description": "The byte of the File."
        },
        "offset": {
          "type": "string",
          "format": "int64",
          "description": "The offset of the File."
        }
      },
      "title": "FileUpload"
    },
    "ListResponse": {
      "type": "object",
      "properties": {
        "files": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The list files from given bucket."
        }
      },
      "title": "ListResponse"
    },
    "UploadRequest": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/definitions/UploadType",
          "description": "The upload type, can be from File or URL."
        },
        "validation": {
          "$ref": "#/definitions/Validation",
          "description": "The validation need to pass for the File."
        },
        "filename": {
          "type": "string",
          "description": "The name of the target upload File when stored to storage."
        },
        "bucket": {
          "type": "string",
          "description": "The bucket name of the target upload File when stored to storage."
        },
        "file": {
          "$ref": "#/definitions/FileUpload",
          "description": "Details of the File Upload parameters."
        },
        "url": {
          "type": "string",
          "description": "Details of the URL Upload parameters."
        }
      },
      "title": "UploadRequest"
    },
    "UploadResponse": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the uploaded File, can be use for resume the upload."
        },
        "objectName": {
          "type": "string",
          "description": "The Object name for the uploaded File."
        },
        "storageLocation": {
          "type": "string",
          "description": "The Storage location for the uploaded File."
        },
        "offset": {
          "type": "string",
          "format": "int64",
          "description": "The offset of the uploaded File."
        },
        "size": {
          "type": "string",
          "format": "int64",
          "description": "The size of uploaded File."
        },
        "contentType": {
          "type": "string",
          "description": "Content Type of uploaded File."
        }
      },
      "title": "UploadResponse"
    },
    "UploadType": {
      "type": "string",
      "enum": [
        "UPLOAD_TYPE_UNSPECIFIED",
        "UPLOAD_TYPE_FILE",
        "UPLOAD_TYPE_URL"
      ],
      "default": "UPLOAD_TYPE_UNSPECIFIED",
      "description": "UploadType is type when do Upload.\n\n - UPLOAD_TYPE_UNSPECIFIED: UPLOAD_TYPE_UNSPECIFIED.\n - UPLOAD_TYPE_FILE: UPLOAD_TYPE_FILE.\n - UPLOAD_TYPE_URL: UPLOAD_TYPE_URL."
    },
    "Validation": {
      "type": "object",
      "properties": {
        "contentTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The Content Types need to pass."
        },
        "maxSize": {
          "type": "string",
          "format": "int64",
          "description": "Max size of the File in byte."
        }
      },
      "title": "Validation"
    },
    "protobufAny": {
      "type": "object",
      "properties": {
        "@type": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "rpcStatus": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/protobufAny"
          }
        }
      }
    }
  }
}