models¶

DataCreate¶

class msdss_data_api.models.DataCreate(*, title: str = None, description: str = None, source: str = None, data: List[Dict[str, Any]])[source]¶

Model for creating data.

title¶

Title of the dataset stored in metadata.

Type: str

description¶

Description of dataset stored in metadata.

Type: str

source¶

Data source stored in metadata.

Type: str

data¶

The data itself for the dataset. Should be a list of dictionaries with the same keys, where each key in each dict is a column name.

Type: list(dict)

Author

Richard Wen <rrwen.dev@gmail.com>

Example

from msdss_data_api.models import *
from pprint import pprint

fields = DataCreate.__fields__
pprint(fields)

{'data': ModelField(name='data', type=List[Dict[str, Any]], required=True),
 'description': ModelField(name='description', type=Optional[str], required=False, default=None),
 'source': ModelField(name='source', type=Optional[str], required=False, default=None),
 'title': ModelField(name='title', type=Optional[str], required=False, default=None)}

MetadataUpdate¶

class msdss_data_api.models.MetadataUpdate(*, title: str = None, description: str = None, source: str = None)[source]¶

Model for updating metadata.