opencloud/store/pkg/proto/v0/store.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "ownCloud Infinite Scale store",
    "version": "1.0.0",
    "contact": {
      "name": "ownCloud GmbH",
      "url": "https://github.com/owncloud/ocis",
      "email": "support@owncloud.com"
    },
    "license": {
      "name": "Apache-2.0",
      "url": "https://github.com/owncloud/ocis/blob/master/LICENSE"
    }
  },
  "tags": [
    {
      "name": "Store"
    }
  ],
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {},
  "definitions": {
    "protobufAny": {
      "type": "object",
      "properties": {
        "typeUrl": {
          "type": "string"
        },
        "value": {
          "type": "string",
          "format": "byte"
        }
      }
    },
    "rpcStatus": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/protobufAny"
          }
        }
      }
    },
    "v0DatabasesResponse": {
      "type": "object",
      "properties": {
        "databases": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v0DeleteOptions": {
      "type": "object",
      "properties": {
        "database": {
          "type": "string"
        },
        "table": {
          "type": "string"
        }
      }
    },
    "v0DeleteResponse": {
      "type": "object"
    },
    "v0Field": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "title": "type of value e.g string, int, int64, bool, float64"
        },
        "value": {
          "type": "string",
          "title": "the actual value"
        }
      }
    },
    "v0ListOptions": {
      "type": "object",
      "properties": {
        "database": {
          "type": "string"
        },
        "table": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        },
        "suffix": {
          "type": "string"
        },
        "limit": {
          "type": "string",
          "format": "uint64"
        },
        "offset": {
          "type": "string",
          "format": "uint64"
        }
      }
    },
    "v0ListResponse": {
      "type": "object",
      "properties": {
        "keys": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v0ReadOptions": {
      "type": "object",
      "properties": {
        "database": {
          "type": "string"
        },
        "table": {
          "type": "string"
        },
        "prefix": {
          "type": "boolean"
        },
        "suffix": {
          "type": "boolean"
        },
        "limit": {
          "type": "string",
          "format": "uint64"
        },
        "offset": {
          "type": "string",
          "format": "uint64"
        },
        "where": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/v0Field"
          }
        }
      }
    },
    "v0ReadResponse": {
      "type": "object",
      "properties": {
        "records": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v0Record"
          }
        }
      }
    },
    "v0Record": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "title": "key of the recorda"
        },
        "value": {
          "type": "string",
          "format": "byte",
          "title": "value in the record"
        },
        "expiry": {
          "type": "string",
          "format": "int64",
          "title": "time.Duration (signed int64 nanoseconds)"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/v0Field"
          },
          "title": "the associated metadata"
        }
      }
    },
    "v0TablesResponse": {
      "type": "object",
      "properties": {
        "tables": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v0WriteOptions": {
      "type": "object",
      "properties": {
        "database": {
          "type": "string"
        },
        "table": {
          "type": "string"
        },
        "expiry": {
          "type": "string",
          "format": "int64",
          "title": "time.Time"
        },
        "ttl": {
          "type": "string",
          "format": "int64",
          "title": "time.Duration"
        }
      }
    },
    "v0WriteResponse": {
      "type": "object"
    }
  },
  "externalDocs": {
    "description": "Developer Manual",
    "url": "https://owncloud.dev/extensions/store/"
  }
}