Skip to content
scienceversePublic

About

JSON schema to describe scientific outputs

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

ScienceVerse Schema

JSON Schema documents describing scientific outputs, published at https://scienceverse.org/schema/.

bibr paper exports

paper.json describes the current bibr 12.2 export. It is the generated strict schema from scienceverse/bibr, with only $id changed to https://scienceverse.org/schema/paper.json.

File Contract
paper.json Current strict export schema; requires schema_version: "12.2" and rejects unknown keys.
bibr-export-v12.schema.json Unmodified upstream strict schema for 12.2.
bibr-export-v12-reader.schema.json Reader contract for any 12.x export; accepts unknown keys and new vocabulary values while checking known field types.
bibr-export-v11.schema.json Frozen upstream v11 schema.
bibr-export-v10.schema.json Frozen upstream v10 schema.
paper-v10.5.json Previous ScienceVerse paper.json, preserved with its own $id.

The upstream files retain their canonical $id values under https://bibr.org/schema/ and their CC0 license declaration. All JSON files are included in the published site.

Migrating from the previous paper schema

This is a breaking update from 10.5. v12 requires a root schema_version, source, metadata, and extraction; info becomes metadata, info_match becomes metadata_match, and affiliations becomes affiliation. The schema includes affiliation and funding match tables, footnotes, text geometry, and extraction provenance and field states. Every root key is present even when its record table is empty. The strict schema also requires every column the exporter always emits, including nullable columns.

Use the reader schema when consuming exports across 12.x minor versions. Older major versions need their corresponding schema; they do not validate against v12. Consumers needing the previous ScienceVerse contract can use paper-v10.5.json.

Updating from bibr

Synced from scienceverse/bibr commit 2da14cce8d34c00e701f706e3cf415943a1f46f3. The source is docs/schema/, generated by bibr's scripts/generate_schema.py from its export models.

For a future update, copy the generated strict and reader artifacts from a reviewed bibr commit without modifying them. Update paper.json from the current strict artifact, changing only its $id, and update the version and source commit recorded here and in index.qmd. Keep superseded major schemas published. Check the schemas with a Draft 2020-12 validator and run bibr's tests/fixtures/schema_conformance/ examples against the strict and reader documents before publishing.

About

JSON schema to describe scientific outputs

Resources

Stars

1 star

Watchers

0 watching

Forks

Contributors