Our latest version as a JSON schema. Add comments below for consideration in the next version.
{
"description": "a bibjson dataset",
"id": "ae56d69fa457442e94d5a7e7417a3c9a",
"type": "object",
"properties": {
"metadata": {
"required": "true",
"type": "object"
"description": "collection metadata",
"properties": {
"created": {
"format": "date-time",
"type": "string"
},
"from": {
"description": "the starting record if
currently showing a subset - see query key",
"type": "number"
},
"id": {
"description": "a unique collection
identifier. must be unique within the
bibserver install it exists in. for
export, becomes unique by virtue of
the URL of the install it exists in",
"required": "true",
"type": "string"
},
"modified": {
"format": "date-time",
"type": "string"
},
"namespaces": {
"description": "namespaces used in this collection",
"properties": {
"ns1": {
"description": "a namespace URL",
"format": "url",
"type": "string"
}
},
"type": "object"
},
"owner": {
"description": "the username of the collection
owner on the bibserver instance the
collection exists in",
"type": "string"
},
"query": {
"description": "the query used to build this
particular representation of the collection,
if any. e.g. if currently looking at a subset
of records, this is the query URL with parameters
that returns said subset",
"type": "string"
},
"size": {
"description": "number of records in current
display, e.g. if a subset - see query key",
"type": "number"
},
"source": {
"description": "The URL where the collection file
was uploaded from, if there is one",
"format": "url",
"type": "string"
},
"title": {
"description": "a human friendly collection name,
suitable as html title element",
"required": "true",
"type": "string"
}
},
},
"records": {
"required": "true",
"type": "array"
"description": "a list of bibjson records",
"items": {
"description": "a record object",
"properties": {
"author_list": {
"description": "list of author name strings
relevant to this record",
"items": {
"type": "string"
},
"type": "array"
},
"booktitle": {
"type": "string"
},
"chapter": {
"type": "string"
},
"collection": {
"description": "the collection this record
belongs to",
"type": "string"
},
"edition": {
"type": "string"
},
"editor_list": {
"description": "list of editor name strings
relevant to this record",
"items": {
"type": "string"
},
"type": "array"
},
"howpublished": {
"type": "string"
},
"id_list": {
"description": "list of unique identifiers
for this record.",
"items": {
"properties": {
"id": {
"description": "the identifier",
"required": "true",
"type": "string"
},
"idname": {
"description": "a short name for
a given identifier, e.g. doi",
"required": "true",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"institution": {
"type": "string"
},
"journal": {
"type": "string"
},
"link_list": {
"description": "list of link objects
relevant to this record",
"items": {
"properties": {
"anchor": {
"description": "text to
display inside link",
"type": "string"
},
"required": "true",
"url": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"month": {
"type": "string"
},
"number": {
"type": "string"
},
"organization": {
"type": "string"
},
"pages": {
"type": "string"
},
"publisher": {
"type": "string"
},
"school": {
"type": "string"
},
"series": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"description": "the bibliographic type,
as per the usual values found in bibtex",
"type": "string"
},
"volume": {
"type": "string"
},
"year": {
"type": "string"
}
},
"type": "object"
},
}
},
}
