Repository navigation
Add 0.0.1 ProvenanceRecord spec (common, model-agnostic parts) - #5
Merged
Merged
Conversation
…ator, crosswalks Fills in the 0.0.1 skeleton on main with the concrete ProvenanceRecord shape developed and stress-tested across four open-model corpora (DFM Mimir, Pleias Common Corpus, BigScience BLOOM/ROOTS, AI2 OLMo/Dolma). The model-specific example records and stress-test notes stay on dedicated branches for dev-list discussion; only the common, model-agnostic solution parts land here. What lands: - schema/0.0.1/sourcelume.schema.json: the ProvenanceRecord JSON Schema. Required fields: id, type, identifier, name, license, creator[], created, added, contentCreated, origin, custodyChain[]. Optional: version, licenseScope, licenseNote, licenseCategory, licenseHistory. - schema/0.0.1/sourcelume.shacl.ttl: matching SHACL shapes. - context/0.0.1/sourcelume.jsonld: JSON-LD context. Reuses dct:/schema: terms where equivalents exist; keeps the sl: namespace minimal. Uses main's sl: prefix and version-inclusive namespace IRI (https://sourcelume.apache.org/ns/0.0.1#). - spec/0.0.1/index.md: normative prose. Field table + License IRI conventions subsection (CC Public Domain Mark for copyright-expiration PD; sl:agreement-supplied for agreement-gated data). No stress-test or example references. - tools/validate.py: Python validator (JSON Schema + SHACL). Exits 0 with "nothing to validate" when examples/ is empty, so it is useful on main before any example records land. - mappings/: draft crosswalks to Croissant, the SPDX AI Profile, and OTDI. - pyproject.toml, uv.lock: Python tooling for the validator. The four additive license fields (licenseScope, licenseNote, licenseCategory, licenseHistory) are optional and non-breaking; records that omit them validate. licenseScope qualifies jurisdiction-scoped licenses (especially public-domain claims). licenseNote flags when a license IRI is materially misleading (e.g. reflects a processing artifact). licenseCategory classifies the licensing model (open-source, open-data, public-domain, agreement-supplied, use-restricted, risk-based, other) so it is checkable at a glance. licenseHistory records prior licenses when a dataset's own license changed over time. Descriptive text in schema and spec is generic; no model-specific names appear in the common files. Apache-ai: Yes Generated-by: pi (anthropic/claude-opus-4-1) Reviewed-by: anierbeck
ANierbeck
added a commit
that referenced
this pull request
Sep 12, 2026
The 0.0.1 spec prose rewrite dropped the ASF license header comment that
RAT (apache-rat-plugin) enforces on non-excluded files. spec/0.0.1/index.md
is not in pom.xml's RAT exclude list (unlike context/**/*.jsonld,
schema/**/*.{json,ttl}, mappings/**/*.md, uv.lock), so it must carry the
standard ASF header. CI failed on PR #5 with "Files with unapproved licenses:
spec/0.0.1/index.md".
No content change beyond re-prepending the header comment block.
Apache-ai: Yes
Generated-by: pi (anthropic/claude-opus-4-1)
Reviewed-by: anierbeck
The 0.0.1 spec prose rewrite dropped the ASF license header comment that
RAT (apache-rat-plugin) enforces on non-excluded files. spec/0.0.1/index.md
is not in pom.xml's RAT exclude list (unlike context/**/*.jsonld,
schema/**/*.{json,ttl}, mappings/**/*.md, uv.lock), so it must carry the
standard ASF header. CI failed on PR #5 with "Files with unapproved licenses:
spec/0.0.1/index.md".
No content change beyond re-prepending the header comment block.
Apache-ai: Yes
Generated-by: pi (anthropic/claude-opus-4-1)
Reviewed-by: anierbeck
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Fills in the 0.0.1 skeleton on
mainwith the concreteProvenanceRecordshape developed and stress-tested across four open-model corpora. Only the common, model-agnostic solution parts land here; the model-specific example records and stress-test notes stay on dedicated branches for dev-list discussion.What lands (10 files)
schema/0.0.1/sourcelume.schema.json—ProvenanceRecordJSON Schema. Required:id,type,identifier,name,license,creator[],created,added,contentCreated,origin,custodyChain[]. Optional:version,licenseScope,licenseNote,licenseCategory,licenseHistory.schema/0.0.1/sourcelume.shacl.ttl— matching SHACL shapes.context/0.0.1/sourcelume.jsonld— JSON-LD context. Reusesdct:/schema:where equivalents exist; keeps thesl:namespace minimal. Usesmain'ssl:prefix and version-inclusive namespace IRI.spec/0.0.1/index.md— normative prose (field table + License IRI conventions subsection).tools/validate.py— Python validator (JSON Schema + SHACL). Exits 0 with "nothing to validate" whenexamples/is empty.mappings/— draft crosswalks to Croissant, the SPDX AI Profile, and OTDI.pyproject.toml,uv.lock— Python tooling.What stays on branches (not in this PR)
examples/*.jsonldmodel-specific records + 3examples/prototypes/notes/stress-test-*.mdandnotes/mimir-dynaword-sources.mdThese remain on
common-corpus-stress-test(and future dedicated branches) for dev-list discussion of the still-open gaps (B, C, D, E).The four additive license fields
All optional, non-breaking; records that omit them validate.
licenseScopelicenseNotelicenseCategoryopen-source,open-data,public-domain,agreement-supplied,use-restricted,risk-based,other) so it is checkable at a glance rather than only by reading the IRI.licenseHistorylicense.Conventions followed
main'ssl:prefix + version-inclusive IRI (https://sourcelume.apache.org/ns/0.0.1#), preserved.dct:/schema:terms where equivalents exist;sl:kept minimal.examples/ornotes/dependency: validator is tolerant of an emptyexamples/dir; spec has no dangling links to example files.Validation
tools/validate.pyexits 0 onmain+ this PR (no examples present).Apache-ai: Yes
Generated-by: pi (anthropic/claude-opus-4-1)
Reviewed-by: anierbeck