:py:mod:`routers.documents`
===========================

.. py:module:: routers.documents

.. autoapi-nested-parse::

   Module for the methods regarding the documents



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   routers.documents.add_document_schema_to_project
   routers.documents.put_document_to_project
   routers.documents.patch_document_of_project
   routers.documents.get_document_of_project
   routers.documents.post_path_document_of_project
   routers.documents.delete_document_of_project
   routers.documents.add_document_permissions
   routers.documents.delete_document_permissions
   routers.documents.get_document_permissions_for_user



Attributes
~~~~~~~~~~

.. autoapisummary::

   routers.documents.router


.. py:data:: router
   

   

.. py:function:: add_document_schema_to_project(request_body = Depends(get_request_body), user = Depends(get_current_active_user), db_project = Depends(get_project), session = Depends(get_session))
   :async:

   Add a document schema to a project
   Requires the authenticated user to have the permission to create a document

   :param request_body: schema to add
   :param user: current user from dependencies
   :param db_project: project of path from dependencies
   :param session: session from dependencies
   :return: the document added


.. py:function:: put_document_to_project(document_body = Depends(get_request_body), user = Depends(get_current_active_user), db_project = Depends(get_project), db_doc = Depends(get_document), session = Depends(get_session))
   :async:

   Add or update content of document
   Requires the authenticated user to have the permission to edit the document

   :param document_body: document content to add or update
   :param user: current user from dependencies
   :param db_project: project of path from dependencies
   :param db_doc: document of path from dependencies
   :param session: session from dependencies
   :return: the document


.. py:function:: patch_document_of_project(document_body = Depends(get_request_body), user = Depends(get_current_active_user), db_project = Depends(get_project), db_doc = Depends(get_document), session = Depends(get_session))
   :async:

   Patch content of document
   Requires the authenticated user to have the permission to edit the document

   :param document_body: document content to patch
   :param user: current user from dependencies
   :param db_project: project of path from dependencies
   :param db_doc: document of path from dependencies
   :param session: session from dependencies
   :return: the document


.. py:function:: get_document_of_project(field = None, path = None, db_doc = Depends(get_document))

   Get specified content in path of field of document
   Requires the authenticated user to have the permission to view the document

   :param field: field of document
   :param path: path in field
   :param db_doc: document of path from dependencies
   :return: content in path of field of document


.. py:function:: post_path_document_of_project(path = None, session = Depends(get_session), user = Depends(get_current_active_user), document_body = Depends(get_request_body), db_project = Depends(get_project), db_doc = Depends(get_document))
   :async:

   Post content in path of document content
   Requires the authenticated user to have the permission to edit the document

   :param path: path in document content
   :param session: session from dependencies
   :param user: current user from dependencies
   :param document_body: document content to post
   :param db_project: project of path from dependencies
   :param db_doc: document of path from dependencies
   :return: the document


.. py:function:: delete_document_of_project(db_doc = Depends(get_document), session = Depends(get_session))

   Delete document of project
   Requires the authenticated user to have the permission to delete the document

   :param db_doc:
   :param session:
   :return: 200 OK if document is deleted, else the corresponding error


.. py:function:: add_document_permissions(doc_permissions, db_project = Depends(get_project), db_doc = Depends(get_document), session = Depends(get_session))

   Add user permissions to document
   Requires the authenticated user to have the permission to edit the document permissions

   :param doc_permissions: permissions to add
   :param db_project: project of path from dependencies
   :param db_doc: document of path from dependencies
   :param session: session from dependencies
   :return: current user permissions of the document


.. py:function:: delete_document_permissions(doc_permissions, db_project = Depends(get_project), db_doc = Depends(get_document), session = Depends(get_session))

   Deletes user permissions of document
   Requires the authenticated user to have the permission to edit the document permissions

   :param doc_permissions: permissions to delete
   :param db_project: project of path from dependencies
   :param db_doc: document of path from dependencies
   :param session: session from dependencies
   :return: current user permissions of the document


.. py:function:: get_document_permissions_for_user(user_name, db_project = Depends(get_project), db_doc = Depends(get_document), session = Depends(get_session))

   Gets user permissions of document
   Requires the authenticated user to have the permission to edit the document permissions

   :param user_name: user name of permissions to get
   :param db_project: project of path from dependencies
   :param db_doc: document of path from dependencies
   :param session: session from dependencies
   :return: current user permissions of the document