siraver/node/data/documentation.json

{
  "application": "simple storage server",
  "ver": "1.0.0",
  "wip": true,
  "entrypoint": {
    "GET": {
      "/": {
        "desc": "get information about the server API",
        "params": null,
        "return": "description of the API"
      },
      "/authentication": {
        "desc": "indicates whether authentication is required on the server",
        "params": null,
        "return": [
          {
            "key": "success",
            "value": true
          },
          {
            "key": "authentication",
            "value": "boolean"
          }
        ]
      },
      "/token": {
        "desc": "indicates whether the token is valid",
        "params": [
          {
            "key": "user",
            "value": "string",
            "desc": "name of the user"
          },
          {
            "key": "token",
            "value": "string"
          }
        ],
        "return": [
          {
            "key": "success",
            "value": true
          },
          {
            "key": "valid",
            "value": "boolean"
          }
        ]
      },
      "/list": {
        "desc": "list of user files",
        "params": [
          {
            "key": "user",
            "value": "string",
            "desc": "name of the user"
          },
          {
            "key": "token",
            "value": "string"
          }
        ],
        "return": [
          {
            "key": "success",
            "value": true
          },
          {
            "key": "total",
            "value": "number"
          },
          {
            "key": "list",
            "value": "string array",
            "desc": "array of fileId"
          }
        ]
      },
      "/{fileId}": {
        "desc": "get a file",
        "params": [
          {
            "key": "user",
            "value": "string",
            "desc": "name of the user"
          },
          {
            "key": "token",
            "value": "string"
          }
        ],
        "return": [
          {
            "key": "success",
            "value": true
          },
          {
            "key": "fileId",
            "value": "string"
          },
          {
            "key": "filename",
            "value": "string"
          },
          {
            "key": "data",
            "value": "string"
          }
        ]
      }
    },
    "POST": {
      "/register": {
        "desc": "register a new user",
        "params": [
          {
            "key": "user",
            "value": "string",
            "desc": "name of the new user"
          },
          {
            "key": "password",
            "value": "string",
            "desc": "password of the new user"
          }
        ],
        "return": [
          {
            "key": "success",
            "value": true
          }
        ]
      },
      "/login": {
        "desc": "Connect a user",
        "params": [
          {
            "key": "user",
            "value": "string",
            "desc": "name of the user"
          },
          {
            "key": "password",
            "value": "string",
            "desc": "password of the new user"
          }
        ],
        "return": [
          {
            "key": "success",
            "value": true
          },
          {
            "key": "token",
            "value": "string"
          }
        ]
      },
      "/save": {
        "desc": "save a new file",
        "params": [
          {
            "key": "user",
            "value": "string",
            "desc": "name of the user"
          },
          {
            "key": "token",
            "value": "string"
          },
          {
            "key": "file",
            "value": "string",
            "desc": "name of the file"
          },
          {
            "key": "data",
            "value": "string",
            "desc": "content of the file"
          }
        ],
        "return": [
          {
            "key": "success",
            "value": true
          },
          {
            "key": "fileId",
            "value": "string"
          },
          {
            "key": "filename",
            "value": "string"
          }
        ]
      }
    },
    "PUT": {
      "/save/{fileId}": {
        "desc": "save an existing file",
        "params": [
          {
            "key": "user",
            "value": "string",
            "desc": "name of the user"
          },
          {
            "key": "token",
            "value": "string"
          },
          {
            "key": "data",
            "value": "string",
            "desc": "content of the file"
          }
        ],
        "return": [
          {
            "key": "success",
            "value": true
          },
          {
            "key": "fileId",
            "value": "string"
          }
        ]
      }
    },
    "/rename/{fileId}": {
      "desc": "rename an existing file",
      "params": [
        {
          "key": "user",
          "value": "string",
          "desc": "name of the user"
        },
        {
          "key": "token",
          "value": "string"
        },
        {
          "key": "name",
          "value": "string",
          "desc": "new name of the file"
        }
      ],
      "return": [
        {
          "key": "success",
          "value": true
        },
        {
          "key": "fileId",
          "value": "string"
        },
        {
          "key": "filename",
          "value": "string"
        }
      ]
    }
  },
  "DELETE": {
    "/{fileId}": {
      "desc": "delete an existing file",
      "params": [
        {
          "key": "user",
          "value": "string",
          "desc": "name of the user"
        },
        {
          "key": "token",
          "value": "string"
        }
      ],
      "return": [
        {
          "key": "success",
          "value": true
        }
      ]
    }
  },
  "Error": {
    "desc": "Return when error occurs",
    "returns": [
      {
        "key": "success",
        "value": false
      },
      {
        "key": "code",
        "value": "int"
      },
      {
        "key": "message",
        "value": "string"
      }
    ]
  }
}