{
  "openapi": "3.4.1",
  "info": {
    "title": "Riverline Workspace API",
    "version": "3.4.1",
    "description": "Control-plane API for Riverline encrypted sync. Manages workspaces, the folder tree, device pairing and version history. Content endpoints move ciphertext only; the API never receives plaintext or workspace keys.",
    "contact": {
      "name": "Riverline Platform",
      "url": "https://rc.bacon123.eu.org/contact.html"
    }
  },
  "servers": [
    {
      "url": "https://api.riverline.dev/v3"
    }
  ],
  "paths": {
    "/v3/workspaces": {
      "get": {
        "summary": "List workspaces",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/workspaces/{id}": {
      "get": {
        "summary": "Retrieve one record from workspaces",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update workspaces",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete workspaces",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/folders": {
      "get": {
        "summary": "List folders",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/folders/{id}": {
      "get": {
        "summary": "Retrieve one record from folders",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update folders",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete folders",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/files": {
      "get": {
        "summary": "List files",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/files/{id}": {
      "get": {
        "summary": "Retrieve one record from files",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update files",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete files",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/devices": {
      "get": {
        "summary": "List devices",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/devices/{id}": {
      "get": {
        "summary": "Retrieve one record from devices",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update devices",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete devices",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/versions": {
      "get": {
        "summary": "List versions",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/versions/{id}": {
      "get": {
        "summary": "Retrieve one record from versions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update versions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete versions",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/shares": {
      "get": {
        "summary": "List shares",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/shares/{id}": {
      "get": {
        "summary": "Retrieve one record from shares",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update shares",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete shares",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/keys": {
      "get": {
        "summary": "List keys",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/keys/{id}": {
      "get": {
        "summary": "Retrieve one record from keys",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update keys",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete keys",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/webhooks": {
      "get": {
        "summary": "List webhooks",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/webhooks/{id}": {
      "get": {
        "summary": "Retrieve one record from webhooks",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update webhooks",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete webhooks",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/events": {
      "get": {
        "summary": "List events",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/events/{id}": {
      "get": {
        "summary": "Retrieve one record from events",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update events",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete events",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/transfers": {
      "get": {
        "summary": "List transfers",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/transfers/{id}": {
      "get": {
        "summary": "Retrieve one record from transfers",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "summary": "Update transfers",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "summary": "Delete transfers",
        "responses": {
          "204": {
            "description": "Deleted"
          }
        }
      }
    },
    "/v3/workspaces/{id}/members": {
      "get": {
        "summary": "List members for workspaces",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/workspaces/{id}/permissions": {
      "get": {
        "summary": "List permissions for workspaces",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/workspaces/{id}/activity": {
      "get": {
        "summary": "List activity for workspaces",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/workspaces/{id}/settings": {
      "get": {
        "summary": "List settings for workspaces",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/workspaces/{id}/stats": {
      "get": {
        "summary": "List stats for workspaces",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/folders/{id}/members": {
      "get": {
        "summary": "List members for folders",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/folders/{id}/permissions": {
      "get": {
        "summary": "List permissions for folders",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/folders/{id}/activity": {
      "get": {
        "summary": "List activity for folders",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/folders/{id}/settings": {
      "get": {
        "summary": "List settings for folders",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/folders/{id}/stats": {
      "get": {
        "summary": "List stats for folders",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/files/{id}/members": {
      "get": {
        "summary": "List members for files",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/files/{id}/permissions": {
      "get": {
        "summary": "List permissions for files",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/files/{id}/activity": {
      "get": {
        "summary": "List activity for files",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/files/{id}/settings": {
      "get": {
        "summary": "List settings for files",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/files/{id}/stats": {
      "get": {
        "summary": "List stats for files",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/devices/{id}/members": {
      "get": {
        "summary": "List members for devices",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/devices/{id}/permissions": {
      "get": {
        "summary": "List permissions for devices",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/devices/{id}/activity": {
      "get": {
        "summary": "List activity for devices",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/devices/{id}/settings": {
      "get": {
        "summary": "List settings for devices",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/devices/{id}/stats": {
      "get": {
        "summary": "List stats for devices",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/versions/{id}/members": {
      "get": {
        "summary": "List members for versions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/versions/{id}/permissions": {
      "get": {
        "summary": "List permissions for versions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/versions/{id}/activity": {
      "get": {
        "summary": "List activity for versions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/versions/{id}/settings": {
      "get": {
        "summary": "List settings for versions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/versions/{id}/stats": {
      "get": {
        "summary": "List stats for versions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/shares/{id}/members": {
      "get": {
        "summary": "List members for shares",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/shares/{id}/permissions": {
      "get": {
        "summary": "List permissions for shares",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/shares/{id}/activity": {
      "get": {
        "summary": "List activity for shares",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/shares/{id}/settings": {
      "get": {
        "summary": "List settings for shares",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/shares/{id}/stats": {
      "get": {
        "summary": "List stats for shares",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/keys/{id}/members": {
      "get": {
        "summary": "List members for keys",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/keys/{id}/permissions": {
      "get": {
        "summary": "List permissions for keys",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/keys/{id}/activity": {
      "get": {
        "summary": "List activity for keys",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/keys/{id}/settings": {
      "get": {
        "summary": "List settings for keys",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/keys/{id}/stats": {
      "get": {
        "summary": "List stats for keys",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/webhooks/{id}/members": {
      "get": {
        "summary": "List members for webhooks",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/webhooks/{id}/permissions": {
      "get": {
        "summary": "List permissions for webhooks",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/webhooks/{id}/activity": {
      "get": {
        "summary": "List activity for webhooks",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/webhooks/{id}/settings": {
      "get": {
        "summary": "List settings for webhooks",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v3/webhooks/{id}/stats": {
      "get": {
        "summary": "List stats for webhooks",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "Block": {
        "type": "object",
        "properties": {
          "hash": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "ciphertext_url": {
            "type": "string"
          }
        }
      },
      "Transfer": {
        "type": "object",
        "properties": {
          "direction": {
            "type": "string",
            "enum": [
              "up",
              "down"
            ]
          },
          "blocks": {
            "type": "integer"
          },
          "bytes": {
            "type": "integer"
          }
        }
      }
    }
  }
}
