Skip to content

DOC: embargoedUntil -- extend semantic to be able to mark with the date when it was unembargoed#143

Draft
yarikoptic wants to merge 1 commit intomasterfrom
enh-unembargoed
Draft

DOC: embargoedUntil -- extend semantic to be able to mark with the date when it was unembargoed#143
yarikoptic wants to merge 1 commit intomasterfrom
enh-unembargoed

Conversation

@yarikoptic
Copy link
Member

The motivation is to (ab)use this metadata field to enable annotating dandisets which were unembargoed in the archive. ATM it would be impossible (?) to tell from dandiset metadata if it was unemabrgoed since we do not carry much (if any) of provenance. Whenever we unemabrgo a dandiset we could use this field then to fill-in datetime for when it was unembargoed, which would actually be "semantically" correct since that would be the date time until when it was embargoed. Of cause if the intention of this field is more of "unembargoUntil" (so no "done" notion), then it must remain as is.

If merged -- TODO: file an issue with dandi-archive to fill-in this field (possibly overwriting an existing value) upon "unembargo" action for the dandiset.

@yarikoptic yarikoptic requested a review from satra September 19, 2022 19:34
@satra
Copy link
Member

satra commented Sep 20, 2022

this will cause a change to the schema. but i think the field can be used when unembargo happens. so i would suggest doing the archive change first and use the field.

in terms of provenance, i've talked about a full audit log that's different from the schema. i think it should be prioritized once current issue are resolved. cc/ (@waxlamp)

@yarikoptic yarikoptic added the patch Increment the patch version when merged label Sep 20, 2022
@yarikoptic
Copy link
Member Author

this will cause a change to the schema

rright... since such a minor change as a doc, I think we could make it just a patch and delay actual release until some other change "pushes it out"

but i think the field can be used when unembargo happens. so i would suggest doing the archive change first and use the field.

coolio, so we are inline in our thinking then. Filed dandi/dandi-archive#1286

@yarikoptic
Copy link
Member Author

ok, I will move it to draft, and say that it is blocked by dandi/dandi-archive#1286

@yarikoptic yarikoptic marked this pull request as draft February 17, 2023 13:46
Copy link
Member

@satra satra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is fine with me.

…te when it was unemabroed

The motivation is to (ab)use this metadata field to enable annotating
dandisets which were unembargoed in the archive. ATM it would be impossible (?)
to tell from dandiset metadata if it was unemabrgoed since we do not carry
much (if any) of provenance.  Whenever we unemabrgo a dandiset we could use
this field then  to fill-in datetime for when it was unembargoed, which would
actually be "semantically" correct since that would be the date time until when
it was embargoed.  Of cause if the intention of this field is more of "unembargoUntil"
(so no "done" notion), then it must remain as is

 Conflicts:
	dandischema/models.py -- so much water since old days
@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.92%. Comparing base (4b89e4f) to head (ebe4e5c).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #143   +/-   ##
=======================================
  Coverage   97.92%   97.92%           
=======================================
  Files          18       18           
  Lines        2405     2405           
=======================================
  Hits         2355     2355           
  Misses         50       50           
Flag Coverage Δ
unittests 97.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@yarikoptic
Copy link
Member Author

.... so i would suggest doing the archive change first and use the field.

coolio, so we are inline in our thinking then. Filed dandi/dandi-archive#1286

well -- as it appeared to be a chicken/egg issue as someone should do it first, and as schema is the "driver" here -- I will likely to proceed with this PR first so archive would 'match' the doc spec eventually ;)

yarikoptic added a commit to dandi/dandi-archive that referenced this pull request Mar 12, 2026
Fixes #1286

When a dandiset transitions from EmbargoedAccess to OpenAccess,
record the actual unembargo timestamp in the embargoedUntil field,
replacing the original embargo end date.

The logic is in Version._populate_access_metadata() which detects
the status transition and sets the timestamp at that point.

See dandi/dandi-schema#143 for field semantics.

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
yarikoptic added a commit to dandi/dandi-archive that referenced this pull request Mar 13, 2026
Fixes #1286

When a dandiset transitions from EmbargoedAccess to OpenAccess,
record the actual unembargo timestamp in the embargoedUntil field,
replacing the original embargo end date.

The logic is in Version._populate_access_metadata() which detects
the status transition and sets the timestamp at that point.

See dandi/dandi-schema#143 for field semantics.

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked patch Increment the patch version when merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants