Skip to content

Instantly share code, notes, and snippets.

@codersquid
Created January 29, 2014 17:41
Show Gist options
  • Save codersquid/8693031 to your computer and use it in GitHub Desktop.
Save codersquid/8693031 to your computer and use it in GitHub Desktop.
{
"properties": {
"metadata": {
"required": "true",
"type": "object",
"description": "collection metadata",
"properties": {
"from": {
"type": "number",
"description": "the starting record if currently showing a subset - see query key"
},
"created": {
"type": "string",
"format": "date-time"
},
"modified": {
"type": "string",
"format": "date-time"
},
"label": {
"required": "true",
"type": "string",
"description": "a human friendly collection name, suitable as html title element"
},
"source": {
"type": "string",
"description": "The URL where the collection file was uploaded from, if there is one",
"format": "url"
},
"namespaces": {
"type": "object",
"description": "namespaces used in this collection",
"properties": {
"ns1": {
"type": "string",
"description": "a namespace URL, not necessarily called ns1",
"format": "url"
}
}
},
"records": {
"items": {
"type": "object",
"description": "a record object",
"properties": {
"identifiers": {
"items": {
"type": "object",
"properties": {
"type": {
"required": "true",
"type": "string",
"description": "a short name for a given identifier, e.g. doi"
},
"id": {
"required": "true",
"type": "string",
"description": "the identifier"
}
}
},
"type": "array",
"description": "list of unique identifiers for this record."
},
"links": {
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"required": "true",
"anchor": {
"type": "string",
"description": "text to display inside link"
}
}
},
"type": "array",
"description": "list of link objects relevant to this record"
},
"series": {
"type": "string"
},
"number": {
"type": "string"
},
"month": {
"type": "string"
},
"edition": {
"type": "string"
},
"year": {
"type": "string"
},
"id": {
"type": "string",
"description": "a key that is unique within the collection"
},
"uuid": {
"type": "string",
"description": "a key that is universally unique, created whenever a record is uploaded to a bibserver."
},
"title": {
"type": "string"
},
"booktitle": {
"type": "string"
},
"pages": {
"type": "string"
},
"editor": {
"items": {
"type": "string"
},
"type": "array",
"description": "list of editor name strings relevant to this record"
},
"howpublished": {
"type": "string"
},
"type": {
"type": "string",
"description": "the bibliographic type, as per the usual values found in bibtex"
},
"journal": {
"type": "string"
},
"collection": {
"items": {
"type": "string"
},
"type": "array",
"description": "the collection this record belongs to"
},
"volume": {
"type": "string"
},
"institution": {
"type": "string"
},
"chapter": {
"type": "string"
},
"publisher": {
"type": "string"
},
"school": {
"type": "string"
},
"author": {
"items": {
"type": "object",
"properties": {
"name": "string",
"id": "string"
}
},
"type": "array",
"description": "list of author name strings relevant to this record"
},
"organization": {
"type": "string"
}
}
},
"required": "true",
"type": "array",
"description": "a list of bibjson records"
},
"owner": {
"type": "string",
"description": "the username of the collection owner on the bibserver instance the collection exists in"
},
"query": {
"type": "object",
"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",
"properties": {}
},
"schema": {
"type": "object",
"description": "identifies the schema to which this collection conforms",
"properties": {
"url": {
"type": "string",
"description": "An address from which the schema to which this collection conforms can be downloaded (by human or machine) for validation."
},
"name": "v0.82"
}
},
"id": {
"required": "true",
"type": "string",
"description": "a unique collection identifier string."
},
"size": {
"type": "number",
"description": "number of records in current display, e.g. if a subset - see query key"
}
}
}
},
"type": "object",
"description": "bibjson dataset definition, version 0.82",
"id": "ae56d69fa457442e94d5a7e7417a3c9a"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment