Source code for structure

"""
Required fields for the different data types.

See documentation (Data Structure) for more information.
"""

import utils



[docs]def dataset():
    """
    Provide a basic data structure for a dataset document.

    Returns:
        dict: The data structure for a dataset.
    """
    return {
        "_id": utils.new_uuid(),
        "description": "",
        "title": "",
        "properties": {},
        "tags": [],
    }




[docs]def order():
    """
    Provide a basic data structure for an order document.

    Returns:
        dict: The data structure for an order.
    """
    return {
        "_id": utils.new_uuid(),
        "title": "",
        "description": "",
        "authors": [],
        "generators": [],
        "organisation": "",
        "editors": [],
        "datasets": [],
        "properties": {},
        "tags": [],
    }




[docs]def collection():
    """
    Provide a basic data structure for a project document.

    Returns:
        dict: The data structure for a project.
    """
    return {
        "_id": utils.new_uuid(),
        "datasets": [],
        "description": "",
        "properties": {},
        "tags": [],
        "editors": [],
        "title": "",
    }




[docs]def user():
    """
    Provide a basic data structure for a user document.

    Returns:
        dict: The data structure for a user.
    """
    return {
        "_id": utils.new_uuid(),
        "affiliation": "",
        "api_key": "",
        "api_salt": "",
        "auth_ids": [],
        "email": "",
        "contact": "",
        "name": "",
        "orcid": "",
        "permissions": [],
        "url": "",
    }




[docs]def log():
    """
    Provide a basic data structure for a log document.

    Returns:
        dict: The data structure for a log.
    """
    return {
        "_id": utils.new_uuid(),
        "action": "",
        "comment": "",
        "data_type": "",
        "data": "",
        "timestamp": utils.make_timestamp(),
        "user": "",
    }