api_spec_example_swagger_v2.0.json

{
  "swagger": "2.0",
  "info": {
    "version": "2016-01-06",
    "title": "QingStor",
    "description": "QingStor provides low-cost and reliable online storage service with unlimited storage space, high read and write performance, high reliability and data safety, fine-grained access control, and easy to use API.",
    "termsOfService": "https://www.qingcloud.com/about/tos",
    "license": {
      "name": "The Apache License (Version 2)",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "contact": {
      "name": "Yunify SDK Group",
      "email": "sdk_group@yunify.com"
    }
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "ListBuckets",
        "summary": "Get Service",
        "description": "Retrieve the bucket list.",
        "externalDocs": {
          "url": "https://docs.qingcloud.com/qingstor/api/service/get.html"
        },
        "parameters": [
          {
            "name": "Location",
            "description": "Limits results to buckets that in the location",
            "type": "string",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "object",
              "properties": {
                "count": {
                  "description": "Bucket count",
                  "type": "integer"
                },
                "buckets": {
                  "description": "Buckets information",
                  "type": "array",
                  "items": {
                    "$ref": "#/definitions/bucket"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/{bucketName}": {
      "parameters": [
        {
          "$ref": "#/parameters/bucketName"
        },
        {
          "$ref": "#/parameters/zone"
        }
      ],
      "get": {
        "tags": [
          "Bucket"
        ],
        "operationId": "ListObjects",
        "summary": "GET Bucket (List Objects)",
        "description": "Retrieve the object list in a bucket.",
        "externalDocs": {
          "url": "https://docs.qingcloud.com/qingstor/api/bucket/get.html"
        },
        "parameters": [
          {
            "name": "prefix",
            "description": "Limits results to keys that begin with the prefix",
            "type": "string",
            "in": "query"
          },
          {
            "name": "delimiter",
            "description": "Put all keys that share a common prefix into a list",
            "type": "string",
            "in": "query"
          },
          {
            "name": "marker",
            "description": "Limit results to keys that start at this marker",
            "type": "string",
            "in": "query"
          },
          {
            "name": "limit",
            "description": "Results count limit",
            "type": "integer",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "Bucket name",
                  "type": "string"
                },
                "owner": {
                  "$ref": "#/definitions/owner"
                },
                "prefix": {
                  "description": "Prefix that specified in request parameters",
                  "type": "string"
                },
                "delimiter": {
                  "description": "Delimiter that specified in request parameters",
                  "type": "string"
                },
                "limit": {
                  "description": "Limit that specified in request parameters",
                  "type": "integer"
                },
                "marker": {
                  "description": "Marker that specified in request parameters",
                  "type": "string"
                },
                "next_marker": {
                  "description": "The last key in keys list",
                  "type": "string"
                },
                "keys": {
                  "description": "Object keys",
                  "type": "array",
                  "items": {
                    "$ref": "#/definitions/key"
                  }
                },
                "common_prefixes": {
                  "description": "Other object keys that share common prefixes",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "parameters": {
    "bucketName": {
      "name": "bucketName",
      "description": "Bucket name",
      "type": "string",
      "required": true,
      "in": "path"
    },
    "zone": {
      "name": "zone",
      "description": "QingCloud Zone ID",
      "type": "string",
      "in": "query"
    }
  },
  "definitions": {
    "bucket": {
      "description": "Bucket",
      "type": "object",
      "properties": {
        "location": {
          "description": "QingCloud Zone ID",
          "type": "string"
        },
        "name": {
          "description": "Bucket name",
          "type": "string"
        },
        "url": {
          "description": "URL to access the bucket",
          "type": "string"
        },
        "created": {
          "description": "Created time of the bucket",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "key": {
      "description": "Object key",
      "type": "object",
      "properties": {
        "key": {
          "description": "Object key",
          "type": "string"
        },
        "mime_type": {
          "description": "MIME type of the object",
          "type": "string"
        },
        "etag": {
          "description": "MD5sum of the object",
          "type": "string"
        },
        "size": {
          "description": "Object content size",
          "type": "integer"
        },
        "modified": {
          "description": "Last modified time in unix time format",
          "type": "integer"
        },
        "created": {
          "description": "Object created time",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "owner": {
      "description": "Bucket owner",
      "type": "object",
      "properties": {
        "id": {
          "description": "User ID",
          "type": "string"
        },
        "name": {
          "description": "Username",
          "type": "string"
        }
      }
    }
  }
}