openapi: 3.0.1
info:
  title: Documents Rest Api
  description: Documents addon rest endpoints
  license:
    name: AGPL
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
  version: "1.0"
tags:
- name: /v1/documents
  description: Manages documents associated to users and spaces
paths:
  /v1/documents:
    get:
      tags:
      - /v1/documents
      summary: Retrieves the list of document items (folders and files) for an authenticated
        user switch filter
      description: Retrieves the list of document items (folders and files) for an
        authenticated user switch filter.
      operationId: getDocumentItems
      parameters:
      - name: ownerId
        in: query
        description: Identity technical identifier
        schema:
          type: integer
          format: int64
      - name: parentFolderId
        in: query
        description: Parent folder technical identifier
        schema:
          type: string
      - name: symlinkFolderId
        in: query
        description: Symlink technical identifier
        schema:
          type: string
      - name: folderPath
        in: query
        description: Parent folder path
        schema:
          type: string
      - name: listingType
        in: query
        description: Listing type of folder. Can be 'TIMELINE' or 'FOLDER'.
        schema:
          type: string
          enum:
          - TIMELINE
          - FOLDER
          - FAVORITES
      - name: query
        in: query
        description: Search query entered by the user
        schema:
          type: string
      - name: extendedSearch
        in: query
        description: extendedSearch
        schema:
          type: boolean
      - name: userId
        in: query
        description: userId
        schema:
          type: string
      - name: favorites
        in: query
        description: favorites
        schema:
          type: boolean
          default: false
      - name: expand
        in: query
        description: File properties to expand.
        schema:
          type: string
      - name: sortField
        in: query
        description: Document items sort field
        schema:
          type: string
      - name: ascending
        in: query
        description: Sort ascending or descending
        schema:
          type: boolean
      - name: offset
        in: query
        description: Offset of results to return
        schema:
          type: integer
          format: int32
          default: 10
      - name: limit
        in: query
        description: Limit of results to return
        schema:
          type: integer
          format: int32
          default: 10
      - name: showHiddenFiles
        in: query
        description: showHiddenFiles of results to return
        schema:
          type: boolean
          default: false
      - name: fileType
        in: query
        description: fileType
        schema:
          type: string
      - name: categoryId
        in: query
        description: Category id used to search associated document
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: excludedCategoryId
        in: query
        description: Category IDs to exclude from the result
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: afterDate
        in: query
        description: afterDate
        schema:
          type: integer
          format: int64
      - name: beforeDate
        in: query
        description: beforeDate
        schema:
          type: integer
          format: int64
      - name: minSize
        in: query
        description: minSize
        schema:
          type: integer
          format: int64
      - name: maxSize
        in: query
        description: maxSize
        schema:
          type: integer
          format: int64
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/biggest/{ownerId}:
    get:
      tags:
      - /v1/documents
      summary: Get biggest documents
      operationId: getBiggestDocuments
      parameters:
      - name: ownerId
        in: path
        description: "Identity technical identifier, required = true"
        required: true
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: Offset of results to return
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: Limit of results to return
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        "200":
          description: Request fulfilled
        "500":
          description: Internal server error
  /v1/documents/breadcrumb:
    get:
      tags:
      - /v1/documents
      summary: Get breadcrumb of given
      description: Get breadcrumb of given
      operationId: getBreadcrumb
      parameters:
      - name: ownerId
        in: query
        description: Identity technical identifier
        schema:
          type: integer
          format: int64
      - name: folderId
        in: query
        description: Folder technical identifier
        schema:
          type: string
      - name: folderPath
        in: query
        description: Folder path
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/bulk/cancel/{actionId}:
    get:
      tags:
      - /v1/documents
      summary: cancel bulk action
      description: Cancel bulk action.
      operationId: cancelBulkAction
      parameters:
      - name: actionId
        in: path
        description: List items
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "403":
          description: Unauthorized operation
        "404":
          description: Resource not found
  /v1/documents/bulk/download/{actionId}:
    get:
      tags:
      - /v1/documents
      summary: Download zipped list of files
      description: This download a zipped list of files.
      operationId: getDownloadZip
      parameters:
      - name: actionId
        in: path
        description: List items
        required: true
        schema:
          type: integer
          format: int32
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "410":
          description: Resource no more available
    post:
      tags:
      - /v1/documents
      summary: download list of documents
      description: This download a list of documents
      operationId: downloadDocuments
      parameters:
      - name: actionId
        in: path
        description: action ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: documents List
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AbstractNodeEntity'
        required: true
      responses:
        "200":
          description: Documents downloaded
        "400":
          description: Invalid query input
        "401":
          description: User not authorized to download the documents
        "500":
          description: Internal server error
  /v1/documents/bulk/move/{actionId}:
    put:
      tags:
      - /v1/documents
      summary: move list of documents to specific path
      description: This moves a list of documents
      operationId: moveDocuments
      parameters:
      - name: actionId
        in: path
        description: action ID
        required: true
        schema:
          type: integer
          format: int32
      - name: ownerId
        in: query
        description: ownerId
        schema:
          type: integer
          format: int64
      - name: destPath
        in: query
        description: new path
        schema:
          type: string
      requestBody:
        description: documents List
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AbstractNodeEntity'
        required: true
      responses:
        "200":
          description: Documents moved
        "400":
          description: Invalid query input
        "401":
          description: User not authorized
        "500":
          description: Internal server error
  /v1/documents/bulk/{actionId}:
    delete:
      tags:
      - /v1/documents
      summary: Delete list of documents
      description: This deletes a list of documents
      operationId: bulkDeleteDocuments
      parameters:
      - name: actionId
        in: path
        description: action ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: documents List
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AbstractNodeEntity'
        required: true
      responses:
        "200":
          description: Document deleted
        "400":
          description: Invalid query input
        "401":
          description: User not authorized to delete the document
        "500":
          description: Internal server error
  /v1/documents/canAddDocument:
    get:
      tags:
      - /v1/documents
      summary: check if the current user can add document
      description: This checks if the current user can add document.
      operationId: canAddDocument
      parameters:
      - name: spaceId
        in: query
        description: Space technical identifier
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
  /v1/documents/createNewVersion:
    put:
      tags:
      - /v1/documents
      summary: Creates a new version of a document from an input stream
      description: Creates a new version of a document from an input stream
      operationId: createNewVersion
      parameters:
      - name: nodeId
        in: query
        description: target file node identifier
        required: true
        schema:
          type: string
      requestBody:
        description: New content
        content:
          '*/*':
            schema:
              type: object
        required: true
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/deleted:
    get:
      tags:
      - /v1/documents
      summary: Fetch trash documents
      description: Fetch trash document
      operationId: getDeletedDocuments
      parameters:
      - name: sortField
        in: query
        description: Sort filed
        schema:
          type: string
          default: modifiedDate
      - name: sortDirection
        in: query
        description: Sort ascending or descending
        schema:
          type: string
          default: desc
      - name: offset
        in: query
        description: Offset of results to return
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: Limit of results to return
        schema:
          type: integer
          format: int32
          default: 20
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/download:
    get:
      tags:
      - /v1/documents
      summary: Download a given document
      description: Download a given document
      operationId: downloadDocument
      parameters:
      - name: nodeId
        in: query
        description: public link node id
        required: true
        schema:
          type: string
      - name: password
        in: query
        description: public access password
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/duplicate:
    post:
      tags:
      - /v1/documents
      summary: POST DUPLICATE of given document
      description: POST DUPLICATE of given document
      operationId: duplicateDocument
      parameters:
      - name: ownerId
        in: query
        description: Identity technical identifier
        schema:
          type: integer
          format: int64
      - name: fileId
        in: query
        description: File technical identifier
        schema:
          type: string
      - name: destinationId
        in: query
        description: File prefix Clone
        schema:
          type: string
      - name: prefixClone
        in: query
        description: File prefix Clone
        schema:
          type: string
      - name: expand
        in: query
        description: File properties to expand.
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/favoriteIds:
    get:
      tags:
      - /v1/documents
      description: Retrieves the list of favorite documents for an authenticated
      operationId: getFavoriteDocumentIds
      parameters:
      - name: offset
        in: query
        description: Offset of results to return
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: Limit of results to return
        schema:
          type: integer
          format: int32
          default: 10
      - name: afterDate
        in: query
        description: afterDate
        schema:
          type: integer
          format: int64
      responses:
        "200":
          description: Request fulfilled
        "401":
          description: Unauthorized operation
  /v1/documents/folder:
    post:
      tags:
      - /v1/documents
      summary: Add a new Folder
      description: This adds a new Folder under givin Folder.
      operationId: createFolder
      parameters:
      - name: parentid
        in: query
        description: parent id
        schema:
          type: string
      - name: folderPath
        in: query
        description: folder Path
        schema:
          type: string
      - name: ownerId
        in: query
        description: owner id
        schema:
          type: integer
          format: int64
      - name: name
        in: query
        description: folder name
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "403":
          description: Unauthorized operation
        "404":
          description: Resource not found
  /v1/documents/fullTree:
    get:
      tags:
      - /v1/documents
      summary: Get Full Tree of given folder
      description: Get Full Tree of given folder
      operationId: getFullTreeData
      parameters:
      - name: ownerId
        in: query
        description: Identity technical identifier
        schema:
          type: integer
          format: int64
      - name: folderId
        in: query
        description: Folder technical identifier
        schema:
          type: string
      - name: destinationFolderPath
        in: query
        description: destination folder path
        schema:
          type: string
      - name: withChildren
        in: query
        description: include children
        schema:
          type: boolean
      - name: showHidden
        in: query
        description: show hidden folder
        schema:
          type: boolean
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/group/count:
    get:
      tags:
      - /v1/documents
      summary: Get documents groups sizes
      description: Get documents groups sizes
      operationId: getDocumentGroupsCount
      parameters:
      - name: ownerId
        in: query
        description: Identity technical identifier
        schema:
          type: integer
          format: int64
      - name: parentFolderId
        in: query
        schema:
          type: string
      - name: query
        in: query
        description: Search query entered by the user
        schema:
          type: string
      - name: favorites
        in: query
        description: favorites
        schema:
          type: boolean
          default: false
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/importzip/{uploadId}:
    post:
      tags:
      - /v1/documents
      summary: Import document from a zip
      description: Import document from a zip
      operationId: importDocuments
      parameters:
      - name: uploadId
        in: path
        description: upload id
        required: true
        schema:
          type: string
      - name: ownerId
        in: query
        description: the owner id
        schema:
          type: string
      - name: folderId
        in: query
        description: "the folder id, where the documents will be imported"
        schema:
          type: string
      - name: folderPath
        in: query
        description: "the folder path, where the documents will be imported"
        schema:
          type: string
      - name: conflict
        in: query
        description: the rule to apply in case of conflict
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/move:
    put:
      tags:
      - /v1/documents
      summary: Move documents
      description: This move a giving document.
      operationId: moveDocument
      parameters:
      - name: documentID
        in: query
        description: document id
        schema:
          type: string
      - name: ownerId
        in: query
        description: ownerId
        schema:
          type: integer
          format: int64
      - name: destPath
        in: query
        description: new path
        schema:
          type: string
      - name: conflictAction
        in: query
        description: conflict action name
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "403":
          description: Unauthorized operation
        "404":
          description: Resource not found
  /v1/documents/newname:
    get:
      tags:
      - /v1/documents
      summary: propose a new name for Folder is there is already a folder with the
        provided name
      description: propose a new name for Folder is there is already a folder with
        the provided name
      operationId: getNewName
      parameters:
      - name: parentid
        in: query
        description: parent id
        schema:
          type: string
      - name: folderPath
        in: query
        description: folder Path
        schema:
          type: string
      - name: ownerId
        in: query
        description: ownerId
        schema:
          type: integer
          format: int64
      - name: name
        in: query
        description: folder name
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "403":
          description: Unauthorized operation
        "404":
          description: Resource not found
  /v1/documents/permissions:
    post:
      tags:
      - /v1/documents
      summary: Undo deleting document if not yet effectively deleted
      description: Undo deleting document if not yet effectively deleted
      operationId: updatePermissions
      requestBody:
        description: Permission object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/FileNodeEntity'
        required: true
      responses:
        "400":
          description: Invalid query input
        "403":
          description: Forbidden operation
  /v1/documents/publicAccessDocument:
    get:
      tags:
      - /v1/documents
      summary: Get public access information
      description: Get public access document
      operationId: publicAccessDocument
      parameters:
      - name: nodeId
        in: query
        description: public link node id
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/publicAccessLink:
    get:
      tags:
      - /v1/documents
      summary: Get public access details of a specific document
      description: Get public access details of a specific document
      operationId: getPublicAccessLink
      parameters:
      - name: nodeId
        in: query
        description: target file node identifier
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
    post:
      tags:
      - /v1/documents
      summary: Generate a new public link for a specific document
      description: Generate a new public link for a specific document
      operationId: createPublicAccessLink
      parameters:
      - name: nodeId
        in: query
        description: target file node identifier
        required: true
        schema:
          type: string
      requestBody:
        description: public access document options object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/PublicDocumentAccessOptionsEntity'
        required: true
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/settings/{ownerId}:
    get:
      tags:
      - /v1/documents
      summary: Get User documents settings
      operationId: getSettings
      parameters:
      - name: ownerId
        in: path
        description: "Identity technical identifier, required = true"
        required: true
        schema:
          type: integer
          format: int64
      responses:
        "200":
          description: Request fulfilled
        "500":
          description: Internal server error
  /v1/documents/shortcut:
    post:
      tags:
      - /v1/documents
      summary: document shortcut
      description: Creates a document shortcut.
      operationId: createShortcut
      parameters:
      - name: documentID
        in: query
        description: document id
        schema:
          type: string
      - name: destPath
        in: query
        description: new path
        schema:
          type: string
      - name: conflictAction
        in: query
        description: conflict action name
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "403":
          description: Unauthorized operation
        "404":
          description: Resource not found
  /v1/documents/size/{ownerId}:
    get:
      tags:
      - /v1/documents
      summary: Get documents size
      operationId: getSize
      parameters:
      - name: ownerId
        in: path
        description: "Identity technical identifier, required = true"
        required: true
        schema:
          type: integer
          format: int64
      responses:
        "200":
          description: Request fulfilled
        "500":
          description: Internal server error
    post:
      tags:
      - /v1/documents
      summary: Calculate documents size
      operationId: addSize
      parameters:
      - name: ownerId
        in: path
        description: "Identity technical identifier, required = true"
        required: true
        schema:
          type: integer
          format: int64
      responses:
        "200":
          description: Request fulfilled
        "500":
          description: Internal server error
  /v1/documents/trash/bulk/delete/{actionId}:
    delete:
      tags:
      - /v1/documents
      summary: Delete list of documents permanently
      description: This deletes a list of documents permanently
      operationId: deleteDocumentsPermanently
      parameters:
      - name: actionId
        in: path
        description: action ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: documents List
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TrashElementEntity'
        required: true
      responses:
        "200":
          description: Document deleted
        "401":
          description: Unauthorized operation
        "400":
          description: Invalid request body input
        "500":
          description: Internal server error
  /v1/documents/trash/bulk/restore/{actionId}:
    put:
      tags:
      - /v1/documents
      summary: Restore list of documents
      description: This restore a list of documents
      operationId: restoreDocuments
      parameters:
      - name: actionId
        in: path
        description: action ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: documents List
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TrashElementEntity'
        required: true
      responses:
        "200":
          description: Document deleted
        "401":
          description: Unauthorized operation
        "400":
          description: Invalid request body input
        "500":
          description: Internal server error
  /v1/documents/trash/delete:
    delete:
      tags:
      - /v1/documents
      summary: Delete a document from the trash
      description: Delete a document from the trash based on the specified trash node
        path
      operationId: deleteDocumentPermanently
      parameters:
      - name: documentPath
        in: query
        description: node path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Document not found
        "500":
          description: Internal server error
  /v1/documents/trash/restore:
    put:
      tags:
      - /v1/documents
      summary: Restores a document from the trash
      description: Restores a document from the trash based on the specified trash
        node path
      operationId: restoreDocumentFromTrash
      parameters:
      - name: documentPath
        in: query
        description: node path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "500":
          description: Internal server error
  /v1/documents/versions:
    get:
      tags:
      - /v1/documents
      summary: Get versions list of a a given document
      description: Get versions list of a a given document
      operationId: getFileVersions
      parameters:
      - name: fileId
        in: query
        description: Identity technical identifier
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
    put:
      tags:
      - /v1/documents
      summary: Restore a document to a specific version
      description: Restore a document to a specific version
      operationId: restoreVersion
      parameters:
      - name: versionId
        in: query
        description: version file node identifier
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
    patch:
      tags:
      - /v1/documents
      summary: update version summary of a give document version
      description: update version summary of a give document version
      operationId: updateVersionSummary
      parameters:
      - name: originFileId
        in: query
        description: original file node identifier
        required: true
        schema:
          type: string
      - name: versionId
        in: query
        description: version file node identifier
        required: true
        schema:
          type: string
      requestBody:
        description: version summary to update
        content:
          '*/*':
            schema:
              type: object
              additionalProperties:
                type: string
        required: true
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/{documentId}:
    get:
      tags:
      - /v1/documents
      summary: Get all details of a given document
      description: Get versions list of a a given document
      operationId: getDocument
      parameters:
      - name: documentId
        in: path
        description: Document identifier
        required: true
        schema:
          type: string
      - name: expand
        in: query
        description: File properties to expand.
        schema:
          type: string
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
    delete:
      tags:
      - /v1/documents
      summary: Delete document
      description: This deletes document
      operationId: deleteDocument
      parameters:
      - name: documentId
        in: path
        description: Document id
        required: true
        schema:
          type: string
      - name: document path
        in: query
        description: folder path
        required: true
        schema:
          type: string
      - name: favorite
        in: query
        description: Is favorite document
        schema:
          type: boolean
      - name: delay
        in: query
        description: Time to effectively delete document
        schema:
          type: integer
          format: int64
      responses:
        "200":
          description: Document deleted
        "400":
          description: Invalid query input
        "401":
          description: User not authorized to delete the document
        "500":
          description: Internal server error
  /v1/documents/{documentId}/undoDelete:
    post:
      tags:
      - /v1/documents
      summary: Undo deleting document if not yet effectively deleted
      description: Undo deleting document if not yet effectively deleted
      operationId: undoDeleteDocument
      parameters:
      - name: documentId
        in: path
        description: Document identifier
        required: true
        schema:
          type: string
      responses:
        "400":
          description: Invalid query input
        "403":
          description: Forbidden operation
  /v1/documents/{fileType}/{documentId}:
    get:
      tags:
      - /v1/documents
      summary: Get content of a given document
      description: Get content a a given document
      operationId: getDocumentContent
      parameters:
      - name: documentId
        in: path
        description: Document identifier
        required: true
        schema:
          type: string
      - name: fileType
        in: path
        description: Document type to be able to get the content
        required: true
        schema:
          type: string
      - name: lastModified
        in: query
        description: "The value of lastModified parameter will determine whether the\
          \ query should be cached by browser or not. If not set, no 'expires HTTP\
          \ Header will be sent'"
        schema:
          type: string
      - name: size
        in: query
        description: Resized image size. Use 250x250 as default size.
        schema:
          type: string
          default: 0x0
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "404":
          description: Not found
        "500":
          description: Internal server error
    post:
      tags:
      - /v1/documents
      summary: Create a thumbnail with provided content
      description: Create a thumbnail with provided content
      operationId: createVideoThumbnail
      parameters:
      - name: documentId
        in: path
        description: Document identifier
        required: true
        schema:
          type: string
      - name: fileType
        in: path
        description: Document type for created thumb
        required: true
        schema:
          type: string
      - name: size
        in: query
        description: Resized image size. Use 250x250 as default size.
        schema:
          type: string
          default: 250x250
      requestBody:
        description: image content
        content:
          '*/*':
            schema:
              type: string
        required: true
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "401":
          description: Unauthorized operation
        "500":
          description: Internal server error
  /v1/documents/{property}:
    patch:
      tags:
      - /v1/documents
      summary: Update a document property
      description: This updates a document prperty.
      operationId: updateDocument
      parameters:
      - name: property
        in: path
        description: Property to update
        required: true
        schema:
          type: string
      - name: documentId
        in: query
        description: document id
        required: true
        schema:
          type: string
      - name: ownerId
        in: query
        description: ownerId
        schema:
          type: integer
          format: int64
      - name: newName
        in: query
        description: new name
        schema:
          type: string
      - name: description
        in: query
        description: new description
        schema:
          type: string
      - name: hidden
        in: query
        description: new document hidden value
        schema:
          type: boolean
      responses:
        "200":
          description: Request fulfilled
        "400":
          description: Invalid query input
        "403":
          description: Unauthorized operation
        "404":
          description: Resource not found
components:
  schemas:
    AbstractNodeEntity:
      type: object
      properties:
        acl:
          $ref: '#/components/schemas/NodePermissionEntity'
        auditTrails:
          $ref: '#/components/schemas/NodeAuditTrailsEntity'
        cloudDriveFile:
          type: boolean
        cloudDriveFolder:
          type: boolean
        createdDate:
          type: integer
          format: int64
        creatorIdentity:
          $ref: '#/components/schemas/IdentityEntity'
        creatorUserName:
          type: string
        datasource:
          type: string
        description:
          type: string
        favorite:
          type: boolean
        folder:
          type: boolean
        hidden:
          type: boolean
        id:
          type: string
        metadatas:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/MetadataItemEntity'
        modifiedDate:
          type: integer
          format: int64
        modifierIdentity:
          $ref: '#/components/schemas/IdentityEntity'
        name:
          type: string
        ownerIdentity:
          $ref: '#/components/schemas/IdentityEntity'
        parentFolderId:
          type: string
        path:
          type: string
        sourceID:
          type: string
        versionNumber:
          type: string
        versionable:
          type: boolean
    FileNodeEntity:
      type: object
      properties:
        acl:
          $ref: '#/components/schemas/NodePermissionEntity'
        auditTrails:
          $ref: '#/components/schemas/NodeAuditTrailsEntity'
        categoryIds:
          type: array
          items:
            type: integer
            format: int64
        cloudDriveFile:
          type: boolean
        cloudDriveFolder:
          type: boolean
        createdDate:
          type: integer
          format: int64
        creatorIdentity:
          $ref: '#/components/schemas/IdentityEntity'
        creatorUserName:
          type: string
        datasource:
          type: string
        description:
          type: string
        favorite:
          type: boolean
        folder:
          type: boolean
        hidden:
          type: boolean
        id:
          type: string
        linkedFileId:
          type: string
        metadatas:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/MetadataItemEntity'
        mimeType:
          type: string
        modifiedDate:
          type: integer
          format: int64
        modifierIdentity:
          $ref: '#/components/schemas/IdentityEntity'
        name:
          type: string
        ownerIdentity:
          $ref: '#/components/schemas/IdentityEntity'
        parentFolderId:
          type: string
        path:
          type: string
        size:
          type: integer
          format: int64
        sizeWithVersions:
          type: integer
          format: int64
        sourceID:
          type: string
        versionNumber:
          type: string
        versionable:
          type: boolean
        versionnedFileId:
          type: string
        versions:
          $ref: '#/components/schemas/FileVersionsEntity'
        views:
          type: integer
          format: int64
    FileVersionEntity:
      type: object
      properties:
        author:
          type: string
        authorFullName:
          type: string
        createdDate:
          type: string
          format: date-time
        current:
          type: boolean
        frozenId:
          type: string
        id:
          type: string
        originId:
          type: string
        size:
          type: integer
          format: int64
        summary:
          type: string
        title:
          type: string
        versionNumber:
          type: integer
          format: int32
    FileVersionsEntity:
      type: object
      properties:
        limit:
          type: integer
          format: int64
        offset:
          type: integer
          format: int64
        size:
          type: integer
          format: int64
        versions:
          type: array
          items:
            $ref: '#/components/schemas/FileVersionEntity'
    IdentityEntity:
      type: object
      properties:
        avatar:
          type: string
        fullname:
          type: string
        id:
          type: string
        name:
          type: string
        providerId:
          type: string
        remoteId:
          type: string
    MetadataItemEntity:
      type: object
      properties:
        audienceId:
          type: integer
          format: int64
        creatorId:
          type: integer
          format: int64
        id:
          type: integer
          format: int64
        name:
          type: string
        objectId:
          type: string
        objectType:
          type: string
        parentObjectId:
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
    NodeAuditTrailItemEntity:
      type: object
      properties:
        actionType:
          type: string
        date:
          type: integer
          format: int64
        id:
          type: integer
          format: int64
        properties:
          type: object
          additionalProperties:
            type: string
        targetIdentity:
          $ref: '#/components/schemas/IdentityEntity'
        userIdentity:
          $ref: '#/components/schemas/IdentityEntity'
    NodeAuditTrailsEntity:
      type: object
      properties:
        limit:
          type: integer
          format: int64
        offset:
          type: integer
          format: int64
        size:
          type: integer
          format: int64
        trails:
          type: array
          items:
            $ref: '#/components/schemas/NodeAuditTrailItemEntity'
    NodePermissionEntity:
      type: object
      properties:
        allMembersCanEdit:
          type: boolean
        canAccess:
          type: boolean
        canDelete:
          type: boolean
        canEdit:
          type: boolean
        collaborators:
          type: array
          items:
            $ref: '#/components/schemas/PermissionEntryEntity'
        visibilityChoice:
          type: string
    PermissionEntryEntity:
      type: object
      properties:
        identity:
          $ref: '#/components/schemas/IdentityEntity'
        permission:
          type: string
    PublicDocumentAccessOptionsEntity:
      type: object
      properties:
        expirationDate:
          type: integer
          format: int64
        hasPassword:
          type: boolean
        password:
          type: string
    TrashElementEntity:
      type: object
      properties:
        folder:
          type: boolean
        id:
          type: string
        lastModificationDate:
          type: integer
          format: int64
        mimeType:
          type: string
        name:
          type: string
        origin:
          type: string
        path:
          type: string
        restorePath:
          type: string
        size:
          type: integer
          format: int64