Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

schema: version and its annotation #568

Open
yarikoptic opened this issue Apr 13, 2021 · 0 comments
Open

schema: version and its annotation #568

yarikoptic opened this issue Apr 13, 2021 · 0 comments
Labels
schema Issues relating to metadata schema

Comments

@yarikoptic
Copy link
Member

@satra caught me in the middle of writing this, so I will just submit what I had, but intermediate agreement was wasGeneratedBy will be the remedy (details yet to be worked out ;))

ATM we have

class DandisetMeta(CommonModel, Identifiable):
    ...
    version: TempOptional[str] = Field(readOnly=True, nskey="schema")

dandi-api returns also created/modified time stamps (not part of the metadata but just come from DB), and I already requested addition of "description" to publish call: dandi/dandi-archive#189 . Also the notion of a Version is present within perspective Python client/API redesign: https://github.com/dandi/dandi-cli/pull/447/files#diff-ca726fb8fbfbf61284ae89742c7c5621e5d4305fc9fd8a83047f71eb07a28379R89 which ATM mimics it more from dandi-api returned structure.

I feel that if we are to have version within metadata, we should also encapsulate other related to that publishing process metadata (date of publishing, and optionally description). I wonder where should it "fit" in the metadata record for a published dandiset? I guess it could be added to wasGeneratedBy.

But ATM we override it to be of type Optional[List[Project]] from the original (in CommonModel) "wider" Optional[List[Activity]]. Should we then make it Optional[List[Union[Project,Activity]] (although Project is subclass of Activity, I guess it would be useful to direct web UI?)

@yarikoptic yarikoptic added the schema Issues relating to metadata schema label Apr 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
schema Issues relating to metadata schema
Projects
None yet
Development

No branches or pull requests

1 participant