openapi.yml

openapi: 3.0.0
info:
  description: balloon API
  version: 1.0.0
  title: balloon API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
paths:
  /api:
    get:
      tags:
        - core.v2
      summary: Get server status
      operationId: getApi
      responses:
        "200":
          description: API root
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.ApiRoot"
  /api/v2:
    get:
      tags:
        - core.v2
      summary: Get server status
      operationId: getV2
      responses:
        "200":
          description: API root
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.ApiRoot"
  /api/v2/tokens:
    get:
      tags:
        - core.v2
      summary: OAUTH2/OIDC token endpoint
      operationId: createToken
      responses:
        "200":
          description: Oauth2 token
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.OAuth2Token"
  /api/v2/groups:
    get:
      tags:
        - core.v2
      summary: Get groups
      description: A group is a colletion of users
      operationId: getGroups
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: List of groups
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Groups"
        "403":
          description: Access denied
    post:
      tags:
        - core.v2
      summary: Add new group
      operationId: addGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/core.v2.Group"
      responses:
        "201":
          description: If successful the server will respond with 201 Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Group"
        "403":
          description: Access denied
  "/api/v2/groups/{group}":
    get:
      tags:
        - core.v2
      operationId: getGroup
      summary: Get single group
      parameters:
        - name: group
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        "200":
          description: Group
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Group"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    patch:
      tags:
        - core.v2
      summary: Set attributes for group
      operationId: patchGroup
      parameters:
        - name: group
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/core.v2.Group"
        description: Set attributes for group
        required: true
      responses:
        "200":
          description: Group
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Group"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    delete:
      tags:
        - core.v2
      summary: Delete group
      operationId: deleteGroup
      parameters:
        - name: group
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
        - name: force
          in: query
          required: false
          description: Per default the group gets disabled, if force is set the group gets
            removed completely.
          schema:
            type: boolean
      responses:
        "204":
          description: If successful the server will respond with 204 No Content
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/groups/{group}/members":
    get:
      tags:
        - core.v2
      summary: Request all member of a group
      operationId: getGroupMembers
      parameters:
        - name: group
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      responses:
        "200":
          description: List of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/core.v2.User"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/groups/{group}/undelete":
    post:
      tags:
        - core.v2
      summary: Restore deleted group
      operationId: undeleteGroup
      parameters:
        - name: group
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      responses:
        "200":
          description: Group
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Group"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/users:
    get:
      tags:
        - core.v2
      summary: Get users
      description: A user is a colletion of users
      operationId: getUsers
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: List of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/core.v2.Users"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    post:
      tags:
        - core.v2
      summary: Add new user
      operationId: addUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/core.v2.User"
      responses:
        "201":
          description: If successful the server will respond with 201 Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.User"
        "403":
          description: Access denied
  "/api/v2/users/{user}":
    get:
      tags:
        - core.v2
      operationId: getUser
      summary: Get single user
      parameters:
        - name: user
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        "200":
          description: User
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.User"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    patch:
      tags:
        - core.v2
      summary: Set attributes for user
      operationId: patchUser
      parameters:
        - name: user
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/core.v2.User"
        description: Set attributes for user
        required: true
      responses:
        "200":
          description: User
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.User"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    delete:
      tags:
        - core.v2
      summary: Delete user
      operationId: deleteUser
      parameters:
        - name: user
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
        - name: force
          in: query
          required: false
          description: Per default the user gets disabled, if force is set the user gets
            removed completely.
          schema:
            type: boolean
      responses:
        "204":
          description: If successful the server will respond with 204 No Content
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/users/{user}/node-attribute-summary":
    get:
      tags:
        - core.v2
      summary: Get summary of node usage.
      operationId: getNodeAttributeSummary
      parameters:
        - name: user
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      responses:
        "200":
          description: User
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.UserNodeAttributeSummary"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/users/{user}/groups":
    get:
      tags:
        - core.v2
      summary: Request all groups of a user
      operationId: getUserGroups
      parameters:
        - name: user
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Groups
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Groups"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/users/{user}/undelete":
    post:
      tags:
        - core.v2
      summary: Restore deleted user
      operationId: undeleteUser
      parameters:
        - name: user
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      responses:
        "200":
          description: User
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.User"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/users/whoami:
    get:
      tags:
        - core.v2
      summary: Get user object of the current authenticated user
      operationId: getCurrentUser
      parameters:
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        "200":
          description: User
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.User"
  "/api/v2/users/{user}/avatar":
    get:
      tags:
        - core.v2
      summary: Get user avatar
      operationId: getUserAvatar
      parameters:
        - name: user
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      responses:
        "200":
          description: Binaray user avatar
          content:
            octet/stream:
              schema:
                $ref: "#/components/schemas/core.v2.User"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/nodes/trash:
    get:
      tags:
        - core.v2
      summary: Return delete nodes (Excluding sub nodes of deleted collections)
      operationId: getDeletedNodes
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Nodes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Nodes"
  /api/v2/nodes/search:
    get:
      tags:
        - ballon.app.elasticsearch.v2
      summary: Extended search query using elasticsearch
      operationId: queryElasticsearch
      parameters:
        - name: query
          in: query
          required: true
          description: Elasticsearch query as JSON
          schema:
            type: string
        - name: deleted
          in: query
          required: false
          description: "Wherever include deleted nodes or not, possible values:  0 Exclude
            deleted 1 Only deleted 2 Include deleted."
          schema:
            type: number
      responses:
        "200":
          description: Nodes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Nodes"
  /api/v2/notifications:
    get:
      tags:
        - notification.v2
      summary: Get my nofitifications
      operationId: getMyNotifications
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: List of notifications
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/notification.v2.Notifications"
    post:
      tags:
        - notification.v2
      summary: Send notification
      operationId: postNotification
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/notification.v2.Notification"
      responses:
        "202":
          description: Notification
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/notification.v2.Notification"
  "/api/v2/notifications/{notification}":
    get:
      tags:
        - notification.v2
      summary: Get a single notification
      operationId: getNotification
      parameters:
        - name: notification
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      responses:
        "200":
          description: Notification
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/notification.v2.Notification"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    delete:
      tags:
        - notification.v2
      summary: Delete a notification
      operationId: deleteNotification
      parameters:
        - name: notification
          in: path
          required: true
          description: Resource identifier
          schema:
            type: string
      responses:
        "204":
          description: If successful the server will respond with 204 No Content
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/notifications/broadcast:
    post:
      tags:
        - notification.v2
      summary: Send notification to all users
      operationId: sendBroadcast
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/notification.v2.Notification"
        description: Notification
      responses:
        "202":
          description: Notification
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/notification.v2.Notification"
        "403":
          description: Access denied
  /api/v2/notifications/mail:
    post:
      tags:
        - notification.v2
      summary: Send mail
      operationId: sendMail
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/notification.v2.Mail"
        description: Mail
      responses:
        "202":
          description: Mail
        "403":
          description: Access denied
  "/api/v2/nodes/{node}/subscription":
    post:
      tags:
        - notification.v2
      summary: Receive node updates
      operationId: subscribeNode
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: subscribe
          in: query
          required: false
          description: If true the subscription is active
          schema:
            type: boolean
        - name: exclude_me
          in: query
          required: false
          description: Exclude subscription owner (me) from change notifications
          schema:
            type: boolean
        - name: recursive
          in: query
          required: false
          description: Apply subscription to children (inclusive newly added children)
          schema:
            type: boolean
      responses:
        "202":
          description: Node
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Node"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/files/{file}/convert/slaves":
    get:
      tags:
        - convert.v2
      summary: Get existing convert slaves
      operationId: getSlaves
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
      responses:
        "200":
          description: Slaves
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/convert.v2.Slaves"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    post:
      tags:
        - convert.v2
      summary: Add new convert slave
      operationId: addSlave
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/convert.v2.Slave"
        description: "Add new conversion slave "
        required: true
      responses:
        "202":
          description: Slave
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/convert.v2.Slave"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/files/{file}/convert/slaves/{slave}":
    get:
      tags:
        - convert.v2
      summary: Get single slave
      operationId: getSlave
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
        - name: slave
          in: path
          required: true
          description: Slave identifier
          schema:
            type: string
      responses:
        "200":
          description: Slave
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/convert.v2.Slave"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    delete:
      tags:
        - convert.v2
      summary: Delete slave
      operationId: deleteSlave
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
        - name: slave
          in: path
          required: true
          description: Slave identifier
          schema:
            type: string
      responses:
        "204":
          description: If successful the server will respond with 204 No Content
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/files/{file}/convert/supported-formats":
    get:
      tags:
        - convert.v2
      summary: Get supported file formats to convert to (formats do vary between files)
      operationId: getSupportedFormats
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
      responses:
        "200":
          description: Formats
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/desktop-clients/{format}/content":
    get:
      tags:
        - desktopclient.v2
      summary: Download balloon desktop client
      operationId: getDesktopClient
      parameters:
        - name: format
          in: path
          required: true
          description: Request client foramt (deb, rpm, exe, pkg, zip or a custom format)
          schema:
            type: string
            enum:
              - deb
              - rpm
              - exe
              - pkg
              - zip
      responses:
        "200":
          description: Desktop client (binary)
          content:
            octet/stream:
              schema:
                type: string
                format: binary
  "/api/v2/office/wopi/document/{document}":
    get:
      tags:
        - wopi.v2
      summary: Get document session information including document owner, session user
        and document size
      operationId: getWopiDocument
      parameters:
        - name: document
          in: path
          required: true
          description: The document id
          schema:
            type: string
        - name: access_token
          in: query
          required: true
          description: An access token to access the document
          schema:
            type: string
      responses:
        "200":
          description: WOPI document information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/office.v2.WopiDocument"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/office/wopi/document/{document}/contents":
    get:
      tags:
        - wopi.v2
      summary: Get document contents
      operationId: getWopiDocumentContent
      parameters:
        - name: document
          in: path
          required: true
          description: "The document id "
          schema:
            type: string
        - name: access_token
          in: query
          required: true
          description: An access token to access the document
          schema:
            type: string
      responses:
        "200":
          description: Contents
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    post:
      tags:
        - wopi.v2
      summary: Save document contents
      operationId: updateWopiDocuemntContent
      parameters:
        - name: document
          in: query
          required: true
          description: "The document id "
          schema:
            type: string
        - name: access_token
          in: query
          required: true
          description: An access token to access the document
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: Document content
      responses:
        "200":
          description: Operation was successful
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/office/documents:
    post:
      tags:
        - wopi.v2
      description: Create new document from an existing office document template
      operationId: createDocument
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/core.v2.File"
        required: true
      responses:
        "201":
          description: File
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.File"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/nodes/{node}/clone":
    post:
      tags:
        - core.v2
      summary: Clone existing node
      operationId: cloneNode
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: destid
          in: query
          required: false
          description: Destination collection, if this is null root is taken
          schema:
            type: string
        - name: conflict
          in: query
          required: false
          description: Conflict resolution
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
            default: 0
      responses:
        "201":
          description: Node
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Node"
        "207":
          description: Multi status if batch request
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/nodes/{node}/move":
    post:
      tags:
        - core.v2
      summary: Move node (Change parent collection), single or multiple ones
      operationId: moveNode
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: destid
          in: query
          required: false
          description: Destination collection, if this is null root is taken
          schema:
            type: string
        - name: conflict
          in: query
          required: false
          description: Conflict resolution
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
            default: 0
      responses:
        "200":
          description: Node
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Node"
        "207":
          description: Multi status if batch request
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/nodes/{node}/undelete":
    post:
      tags:
        - core.v2
      summary: Undelete (Restore from trash) a single node or multiple ones.
      operationId: undeleteNode
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: move
          in: query
          required: false
          description: If node should also be moved during undelete
          schema:
            type: boolean
            default: false
        - name: destid
          in: query
          required: false
          description: If node should also be moved during undelete
          schema:
            type: string
        - name: conflict
          in: query
          required: false
          description: Conflict resolution
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
            default: 0
      responses:
        "200":
          description: Node
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Node"
        "207":
          description: Multi status if batch request
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/collections/{collection}/share":
    get:
      tags:
        - core.v2
      summary: Get share acl and share name
      operationId: getShare
      parameters:
        - name: collection
          in: path
          required: true
          description: Collection identifier
          schema:
            type: string
      responses:
        "200":
          description: Share
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Share"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    post:
      tags:
        - core.v2
      summary: Create a new share from an existing collection
      operationId: shareCollection
      parameters:
        - name: collection
          in: path
          required: true
          description: Collection identifier
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/core.v2.Share"
        description: "Create a new share from an existing collection "
        required: true
      responses:
        "200":
          description: Collection
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Collection"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    delete:
      tags:
        - core.v2
      summary: Does only remove sharing options and transform a share back into a
        normal collection. There will not be any data loss after this action.
        All existing references would be removed automatically.
      operationId: deleteShare
      parameters:
        - name: collection
          in: path
          required: true
          description: Collection identifier
          schema:
            type: string
      responses:
        "204":
          description: The server responds with 204 if successful.
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/collections/{collection}/children":
    get:
      tags:
        - core.v2
      summary: Get all children of a collection
      operationId: getChildren
      parameters:
        - name: collection
          in: path
          required: true
          description: Parent collection
          schema:
            type: string
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: deleted
          description: Wheter to include deleted or not
          required: false
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
        - in: query
          name: recursive
          description: Include children recursively.
          required: false
          schema:
            type: boolean
            default: false
      responses:
        "200":
          description: List of children
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Nodes"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/collections/children:
    get:
      tags:
        - core.v2
      summary: Get all children of the root collection
      operationId: getRootChildren
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: deleted
          description: Wheter to include deleted or not
          required: false
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
        - in: query
          name: recursive
          description: Include children recursively.
          required: false
          schema:
            type: boolean
            default: false
      responses:
        "200":
          description: List of children
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Nodes"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/collections:
    get:
      tags:
        - core.v2
      summary: Get all collections
      operationId: getCollections
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: deleted
          description: Wheter to include deleted or not
          required: false
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: List of collections
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Collections"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    post:
      tags:
        - core.v2
      summary: Create a new collection in root
      operationId: createRootCollection
      requestBody:
        $ref: "#/components/requestBodies/core.v2.Collection"
      responses:
        "201":
          description: Collection
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Collection"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/collections/{collection}":
    post:
      tags:
        - core.v2
      summary: Create a new collection
      operationId: createCollection
      parameters:
        - name: collection
          in: path
          required: true
          description: Parent collection
          schema:
            type: string
      requestBody:
        $ref: "#/components/requestBodies/core.v2.Collection"
      responses:
        "201":
          description: Collection
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Collection"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/files:
    get:
      tags:
        - core.v2
      summary: Get all files
      operationId: getFiles
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: deleted
          description: Wheter to include deleted or not
          required: false
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: List of files
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Files"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    put:
      tags:
        - core.v2
      summary: Upload an entire file in one-shot. Use this endpoint only for small
        files, for bigger files use the chunking endpoint.
      operationId: uploadFile
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: File content
      responses:
        "201":
          description: File created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.File"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/files/{file}/history":
    get:
      tags:
        - core.v2
      summary: Get a full change history of a file
      operationId: getFileHistory
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
      responses:
        "200":
          description: File history
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.FileHistory"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/files/{file}/restore":
    post:
      tags:
        - core.v2
      summary: Rollback to a recent version from history. Use the version number from
        history.
      operationId: rollbackFile
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
      responses:
        "200":
          description: File
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.File"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/files/chunk:
    put:
      tags:
        - core.v2
      summary: Upload a file chunk. You have to manually splitt the binary data into
        multiple chunks and upload them successively! using this method. Once
        uploading the last chunk, the server will automatically create or update
        the file node. You may set the parent collection, name and or custom
        attributes only with the last request to save traffic.
      operationId: uploadChunk
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: File content
        required: true
      responses:
        "200":
          description: File updated
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.File"
        "201":
          description: File newly created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.File"
        "206":
          description: Chunk uploaded
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.ChunkSession"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/nodes:
    get:
      tags:
        - core.v2
      summary: Get all nodes
      operationId: getNodes
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: deleted
          description: Wheter to include deleted or not
          required: false
          schema:
            type: number
            enum:
              - 0
              - 1
              - 2
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: List of nodes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Nodes"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/nodes/{node}":
    delete:
      tags:
        - core.v2
      summary: Delete node
      operationId: deleteNode
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: force
          in: query
          required: false
          description: "Force flag need to be set to delete a node from trash (node must
            have the deleted flag) "
          schema:
            type: boolean
        - name: ignore_flag
          in: query
          required: false
          description: "If both ignore_flag and force_flag were set, the node will be
            deleted completely "
          schema:
            type: boolean
        - name: at
          in: query
          required: false
          description: Has to be a valid unix timestamp if so the node will destroy itself
            at this specified time instead immediatly
          schema:
            type: number
      responses:
        "204":
          description: If successful the server will respond with 204 No Content
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    get:
      tags:
        - core.v2
      summary: Get single node
      operationId: getNode
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: attributes
          in: query
          required: false
          description: Filter attributes
          schema:
            type: array
            items:
              type: string
      responses:
        "200":
          description: Node
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Node"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    patch:
      tags:
        - core.v2
      summary: Change attributes
      operationId: updateNode
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/core.v2.Node"
        description: "Change attributes "
        required: true
      responses:
        "200":
          description: Node
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Node"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/nodes/{node}/share-link":
    delete:
      tags:
        - sharelink.v2
      summary: Delete an existing sharing link
      operationId: deleteLink
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
      responses:
        "204":
          description: The server responds with 204 if operation was successful
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
    post:
      tags:
        - sharelink.v2
      summary: "Create a unique sharing link of a node (global accessible): a possible
        existing link will be deleted if this method will be called."
      operationId: createLink
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: expiration
          in: query
          required: false
          description: Expire timestamp as unix timestap. Tells the server when the public
            link should expire automatically. The default is to never expire.
          schema:
            type: number
            default: 0
        - name: password
          in: query
          required: false
          description: Optionally set a password to protect the public link.
          schema:
            type: string
      responses:
        "201":
          description: Node
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Node"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/nodes/last-cursor:
    get:
      tags:
        - core.v2
      summary: Use this method to request the latest cursor if you only need to now if
        there are changes on the server. This method will not return any other
        data than the newest cursor. To request a feed with all deltas request
        /delta.
      operationId: getLastCursor
      responses:
        "200":
          description: Cursor
          content:
            application/json:
              schema:
                type: string
  "/api/v2/nodes/{node}/content":
    get:
      tags:
        - core.v2
      summary: Download node contents. Note that collections are zipped on-the-fly.
      operationId: getContent
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - name: Byte-Ranges
          in: header
          required: false
          description: "Read stream from a specific offset/limit in bytes "
          schema:
            type: number
        - name: encode
          in: query
          required: false
          description: Can be set to base64 to encode content as base64.
          schema:
            type: string
            enum:
              - base64
        - name: download
          in: query
          required: false
          description: "Force download file (Content-Disposition: attachment HTTP header)"
          schema:
            type: boolean
            default: false
      responses:
        "200":
          description: Content
          content:
            octet/stream:
              schema:
                type: string
                format: binary
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/nodes/delta:
    get:
      tags:
        - core.v2
      summary: Delta stream with cursor support.
      operationId: getDelta
      parameters:
        - name: limit
          in: query
          required: false
          description: "Limit the number of delta entries, if too low you have to call this
            endpoint more often since has_more would be true more often "
          schema:
            type: number
        - name: attributes
          in: query
          required: false
          description: Filter attributes, per default not all attributes would be returned
          schema:
            type: array
            items:
              type: string
        - name: cursor
          in: query
          required: false
          description: "Set a cursor to rquest next nodes within delta processing "
          schema:
            type: string
      responses:
        "200":
          description: Delta
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Delta"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  /api/v2/nodes/event-log:
    get:
      tags:
        - core.v2
      summary: Get event log containing all operations which are made by the user
        himself or share members
      operationId: getEventLog
      parameters:
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Event log
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.EventLogs"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/nodes/{node}/event-log":
    get:
      tags:
        - core.v2
      summary: Get event log containing all operations which are made by the user
        himself or share members on a given node
      operationId: getNodeEventLog
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - in: query
          name: query
          description: |-
            Specify a MongoDB based resource query
            (https://docs.mongodb.com/manual/tutorial/query-documents) using
            JSON (For example: {"name": {$regex: 'foo.*'}}).
          required: false
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - in: query
          name: offset
          description: |-
            Objects offset, per default it starts from 0. You may also request a
            negative offset which will return results from the end [total -
            offset].
          required: false
          schema:
            type: number
        - in: query
          name: limit
          description: Objects limit, per default 20 objects will get returned
          required: false
          schema:
            type: number
        - in: query
          name: sort
          description: |-
            Specify a MongoDB sort operation
            (https://docs.mongodb.com/manual/reference/method/cursor.sort/)
            using JSON (For example: {"name": -1}).
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Event log
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.EventLogs"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/nodes/{node}/parents":
    get:
      tags:
        - core.v2
      summary: The hirarchy of all parent nodes is ordered in a single level array
        beginning with the collection on the highest level.
      operationId: getParentNodes
      parameters:
        - name: node
          in: path
          required: true
          description: Node identifier
          schema:
            type: string
        - in: query
          name: attributes
          description: Filter attributes
          required: false
          schema:
            type: array
            items:
              type: string
        - name: self
          in: query
          required: false
          description: Include requested collection itself at the end of the list (Will be
            ignored if the requested node is a file)
          schema:
            type: boolean
      responses:
        "200":
          description: Parent nodes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/core.v2.Nodes"
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
  "/api/v2/files/{file}/preview":
    get:
      tags:
        - preview.v2
      summary: Get a preview of the files content. The body either contains an encoded
        string or a jpeg binary.
      operationId: getPreview
      parameters:
        - name: file
          in: path
          required: true
          description: File identifier
          schema:
            type: string
        - name: encode
          in: query
          required: false
          description: Set to base64 to return a jpeg encoded preview as base64, else
            return it as jpeg binary
          schema:
            type: string
      responses:
        "200":
          description: Binara data
        "403":
          description: Access denied
        "404":
          description: Resource does not exists
servers:
  - url: /
components:
  requestBodies:
    core.v2.Collection:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/core.v2.Collection"
      required: true
  schemas:
    core.v2.JsonPatch:
      description: A JSON Patch according rfc6902.
      type: object
      properties:
        op:
          type: string
        path:
          type: string
        value:
          type: string
    core.v2.ApiRoot:
      description: Describes the api root.
      type: object
      properties:
        name:
          type: string
        api:
          type: number
    core.v2.Links:
      description: Contains resource links (URL) to other resources.
      type: object
      properties:
        self:
          $ref: "#/components/schemas/core.v2.Link"
    core.v2.ListLinks:
      type: object
      properties:
        self:
          $ref: "#/components/schemas/core.v2.Link"
        prev:
          $ref: "#/components/schemas/core.v2.Link"
        next:
          $ref: "#/components/schemas/core.v2.Link"
    core.v2.Link:
      type: object
      properties:
        href:
          type: string
    core.v2.ResourceList:
      type: object
      properties:
        _links:
          $ref: "#/components/schemas/core.v2.ListLinks"
        kind:
          description: The resource type, always List.
          type: string
          default: List
        count:
          description: Holds the number of items in the current list response.
          type: number
        total:
          description: Holds the number of total available items on the server. Note that a
            List resource is always paged. You need to traverse with offset and
            limit to request further resources in the list.
          type: number
    core.v2.Resource:
      type: object
      properties:
        _links:
          $ref: "#/components/schemas/core.v2.Links"
        id:
          description: Unique 12-byte resource identifier. Note this is a MongoDB ObjectId.
            The name is the standard resource identifier, the id only useful to
            verify that a given resource was completely recreated. An ID is
            immutable and will be created on the server.
          type: string
        created:
          description: ISO 8601 timestamp when the resource was created.
          type: string
          format: date-time
    core.v2.OAuth2Token:
      description: "OAUTH2 access token response according RFC6749 https://tools.ietf.org/html/rfc6749#section-4.3.3"
      type: object
      properties:
        access_token:
          description: Resource access_token.
          type: string
        expires_in:
          description: The number of seconds the issues acceess_token is valid for. This is usually 1hour.
          type: number
          default: 3600
        token_type:
          description: The type of token. This is usually a Bearer token.
          type: string
          default: Bearer
        scope:
          description: The scopes.
          type: string
        refresh_token:
          description: An optional refresh token to get new access_tokens via the refresh_token grant type.
          type: string
    core.v2.Users:
      description: A list of users.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/core.v2.User"
    core.v2.User:
      description: A user is used to access the server.
      allOf:
        - $ref: "#/components/schemas/core.v2.Resource"
        - type: object
          properties:
            changed:
              description: ISO 8601 timestamp when the resource was changed.
              type: string
              format: date-time
            username:
              description: Unique username.
              type: string
            name:
              description: Display name (Usuallly same as username).
              type: string
            admin:
              description: Admin user flag.
              type: boolean
              default: false
            namespace:
              description: User namespace.
              type: string
            locale:
              description: User locale.
              type: string
              default: en_US
            auth:
              description: Authentication source.
              type: string
              default: internal
              enum:
                - internal
                - external
            has_password:
              description: Is true if the user has a local password set.
              type: boolean
              default: false
            hard_quota:
              description: Hard quota in bytes (Max. limit of storage usage). Note that
                external storage is not part of the quota. The default is no
                limit.
              type: number
              default: -1
            soft_quota:
              description: Soft quota in bytes (Warning of high quota usage). The default
                is no limit.
              type: number
              default: -1
            available:
              description: Available storage in bytes. Is -1 if there is no hard_quota.
              type: number
              default: -1
            used:
              description: Used storage in bytes.
              type: number
              default: 0
    core.v2.Groups:
      description: A list of groups.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/core.v2.Group"
    core.v2.Group:
      description: A group contains user resources.
      allOf:
        - $ref: "#/components/schemas/core.v2.Resource"
        - type: object
          properties:
            changed:
              description: ISO 8601 timestamp when the resource was changed.
              type: string
              format: date-time
            name:
              description: Group name.
              type: string
            namespace:
              description: User namespace.
              type: string
            member:
              description: Array of user id's.
              type: array
              items:
                type: string
    core.v2.Nodes:
      description: A list of nodes.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/core.v2.Node"
    core.v2.NodeMeta:
      description: Node meta data.
      type: object
      properties:
        tags:
          description: Node tags. Tags can be freely choosen.
          type: array
          items:
            type: string
        author:
          description: Author.
          type: string
        license:
          description: Content license.
          type: string
        color:
          description: A color tag.
          type: string
    core.v2.Node:
      description: A Node.
      allOf:
        - $ref: "#/components/schemas/core.v2.Resource"
        - type: object
          properties:
            changed:
              description: ISO 8601 timestamp when the resource was changed.
              type: string
              format: date-time
            deleted:
              description: ISO 8601 timestamp when the resource was deleted.
              type: string
              format: date-time
            name:
              description: Node name.
              type: string
            mime:
              description: Mimetype.
              type: string
            readonly:
              description: Readonly only affects the content of the node but not metadata.
              type: boolean
              default: false
            directory:
              description: If node is of type Collection this flag is true.
              type: boolean
              default: false
            meta:
              $ref: "#/components/schemas/core.v2.NodeMeta"
            size:
              description: The size in bytes. If the node is of type collection the size is
                the number of child nodes.
              type: number
              default: 0
            path:
              description: The path abstraction of the node.
              type: string
            access:
              description: Access level.
              type: string
              default: rw
              enum:
                - rw
                - w
                - m
                - w+
            parent:
              description: Points to the parent collection. If the nodes is in the root
                this is null.
              type: object
              properties:
                id:
                  description: The id of the parent collection
                  type: string
                name:
                  description: The name of the parent collection
                  type: string
            share:
              description: Points to the shared node (or share reference). If the node is
                not part of any share this is null.
              type: object
              properties:
                id:
                  description: The id of the share collection. If the share is a reference
                    (incoming share) it will point to the share reference and
                    not the id of the shared collection itself.
                  type: string
                name:
                  description: The name of the share (or share reference).
                  type: string
            shareowner:
              description: Points to the share owner. If the node is not part of any share
                this is null.
              type: object
              properties:
                id:
                  description: The id of the share owner.
                  type: string
                name:
                  description: The username of the share owner.
                  type: string
            subscription:
              description: Is true if the user has an active subscription on this node.
              type: boolean
              default: false
            subscription_exclude_me:
              description: Subscription excludes actions from the subscribed user itself.
              type: boolean
              default: false
            sharelink_has_password:
              description: Is true if the node has a protected public sharelink.
              type: boolean
              default: false
    core.v2.Collections:
      description: A list of collections.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/core.v2.Collection"
    core.v2.Collection:
      description: A collection can hold an unlimited number of child nodes.
      allOf:
        - $ref: "#/components/schemas/core.v2.Node"
    core.v2.Files:
      description: A list of files.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/core.v2.File"
    core.v2.File:
      description: A collection can hold an unlimited number of child nodes.
      allOf:
        - $ref: "#/components/schemas/core.v2.Node"
        - type: object
          properties:
            version:
              description: The content version. Does increase if the content gets changed.
              type: number
              default: 1
            hash:
              description: MD5 content checksum.
              type: string
            preview:
              description: Is true if there is a preview
              type: boolean
    core.v2.FileHistory:
      description: File history.
      type: object
      properties:
        version:
          description: The version number.
          type: number
          default: 1
        changed:
          description: ISO 8601 timestamp when the resource was changed.
          type: string
          format: date-time
        type:
          description: Type of change.
          type: number
        user:
          description: Resolves to user who executed the operation.
          type: object
          properties:
            id:
              description: The id of the share owner.
              type: string
            name:
              description: The username of the share owner.
              type: string
    core.v2.Delta:
      description: The delta is a differential feed to get changes since the last delta
        call.
      type: object
      properties:
        reset:
          description: If true the client needs to reset its state.
          type: boolean
          default: false
        cursor:
          description: ACL rules.
          type: string
        has_more:
          description: If true the server has more entries and the client must send another
            request with the latest cursor.
          type: boolean
          default: false
        nodes:
          type: array
          items:
            $ref: "#/components/schemas/core.v2.Node"
    core.v2.Share:
      description: Node share.
      type: object
      properties:
        share_name:
          description: The name of the share. By default the name of the node.
          type: string
        acl:
          description: ACL rules.
          type: array
          items:
            $ref: "#/components/schemas/core.v2.AclRule"
    core.v2.AclRule:
      description: ACL rule.
      type: object
      properties:
        type:
          description: The type of the resource.
          type: string
          enum:
            - user
            - group
        id:
          description: ACL rules.
          type: string
        privilege:
          description: Privilege.
          type: string
          enum:
            - rw
            - w
            - m
            - w+
            - d
        role:
          description: Points to the share owner. If the node is not part of any share this
            is null.
          type: object
          properties:
            id:
              description: The id of the role resource.
              type: string
            name:
              description: The name of role resource.
              type: string
    core.v2.UserNodeAttributeSummary:
      description: Request node fiel statistics.
      type: object
      additionalProperties:
        type: array
        items:
          type: object
          properties:
            _id:
              type: string
            sum:
              type: number
    core.v2.ChunkSession:
      description: Chunking upload session.
      type: object
      properties:
        session:
          description: The upload session id
          type: string
        chunks_left:
          description: Tells how many chunks are left to upload.
          type: number
    core.v2.EventLogs:
      description: A list of events.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/core.v2.EventLog"
    core.v2.EventLog:
      description: Event log entry. Each event represents an executed operation on the
        server.
      type: object
      properties:
        event:
          description: The event id.
          type: string
        timestamp:
          description: ISO 8601 timestamp when the event was created.
          type: string
        operation:
          description: The event operation.
          type: string
          enum:
            - deleteCollectionReference
            - deleteCollectionShare
            - deleteCollection
            - addCollection
            - addFile
            - addCollectionShare
            - addCollectionReference
            - undeleteFile
            - undeleteCollectionReference
            - undeleteCollectionShare
            - restoreFile
            - renameFile
            - renameCollection
            - renameCollectionShare
            - renameCollectionReference
            - copyFile
            - copyCollection
            - copyCollectionShare
            - copyCollectionRFeference
            - moveFile
            - moveCollection
            - moveCollectionReference
            - moveCollectionShare
        node:
          description: Resolves to the node involved in the operation.
          type: object
          properties:
            id:
              description: The id of the node
              type: string
            name:
              description: The name of the node
              type: string
        parent:
          description: Points to the parent collection. If the node is in the root this is
            null.
          type: object
          properties:
            id:
              description: The id of the parent collection
              type: string
            name:
              description: The name of the parent collection
              type: string
        share:
          description: Points to the shared node (or share reference). If the node is not
            part of any share this is null.
          type: object
          properties:
            id:
              description: The id of the share collection. If the share is a reference
                (incoming share) it will point to the share reference and not
                the id of the shared collection itself.
              type: string
            name:
              description: The name of the share (or share reference).
              type: string
        user:
          description: Resolves to user who executed the operation.
          type: object
          properties:
            id:
              description: The id of the share owner.
              type: string
            name:
              description: The username of the share owner.
              type: string
        client:
          description: Describes the client from which the operation was executed.
          type: object
          properties:
            type:
              description: The type of the client.
              type: string
            app:
              description: The client app name.
              type: string
            v:
              description: The version of the client app.
              type: string
            hostname:
              description: The hostname of the client.
              type: string
    office.v2.WopiDocument:
      description: WOPI document
        https://wopi.readthedocs.io/projects/wopirest/en/latest/files/CheckFileInfo.html
      type: object
      properties:
        BaseFileName:
          type: string
        Size:
          type: string
        Version:
          type: string
        OwnerId:
          type: string
        UserId:
          type: string
        UserFriendlyName:
          type: string
        UserCanWrite:
          type: boolean
        PostMessageOrigin:
          type: string
    notification.v2.Mail:
      description: Mail
      type: object
      properties:
        receiver:
          type: array
          items:
            type: string
            format: mail
        subject:
          type: string
        body:
          type: string
    notification.v2.Notifications:
      description: A list of notifications.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/notification.v2.Notification"
    notification.v2.Notification:
      description: A notification
      allOf:
        - $ref: "#/components/schemas/core.v2.Resource"
        - type: object
          properties:
            locale:
              description: Notification locale. A locale contains a static message which is
                of a given locale.
              type: string
              default: en_US
            subject:
              description: Subject.
              type: string
            message:
              description: Message.
              type: string
            sender:
              description: Points to the message. If there is no sender (For example the
                message came from the system itself) this is null.
              type: object
              properties:
                id:
                  description: The id of the sender.
                  type: string
                name:
                  description: The username of the sender.
                  type: string
            node:
              description: A notification may point to a node. If there is no node given
                this is null.
              type: object
              properties:
                id:
                  description: The id of the node.
                  type: string
                name:
                  description: The name of the node.
                  type: string
    convert.v2.Slaves:
      description: A list of convert slaves.
      allOf:
        - $ref: "#/components/schemas/core.v2.ResourceList"
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: "#/components/schemas/convert.v2.Slave"
    convert.v2.Slave:
      description: A convert slave
      allOf:
        - $ref: "#/components/schemas/core.v2.Resource"
        - type: object
          properties:
            format:
              description: Slave format.
              type: string
            master:
              description: Master node from which the slave is from.
              type: object
              properties:
                id:
                  description: The id of the node.
                  type: string
                name:
                  description: The name of the node.
                  type: string
            slave:
              description: The generated slave node. As long as the slave has not yet been
                created this is null.
              type: object
              properties:
                id:
                  description: The id of the node.
                  type: string
                name:
                  description: The name of the node.
                  type: string