This repository contains the schemas for events, payloads and definitions.
NOTE: Do not modify this README.md file directly, it's a compiled file. Please modify the README.md.template and execute python build_docs.py > README.md.
Event schema(root objectevent)Payload schema: Relation(nested object underevent["payload"])Payload schema: object(nested object underevent["payload"])Payload definitions(Object definitions used in payloads)
Schema of the event message.
Properties
| Type | Description | Required | |
|---|---|---|---|
| event_type | string | Type of the event. Controlled vocabulary: 'relation_created' or 'relation_deleted' | Yes |
| creator | string | Name of the part which emmited this event. | Yes |
| source | string | Name of the source, algorithm or procedure, which created this event. | Yes |
| payload | array | Payload information specific to the event_type. An array, containing one or more payloads of the structure matching with the event_type. | Yes |
| id | string | Globally unique identifier of the event (UUID version 4 as specified in RFC 4122). | Yes |
| time | string | Time when the payload information was created. | Yes |
| description | string | Free-text description of the event. | No |
Additional properties are allowed.
Schema of the relation payload.
Properties
| Type | Description | Required | |
|---|---|---|---|
| relation_publication_date | string | Date of the relation publishing. | No |
| relation_provider | object (organization) |
Provider of the relation. | No |
| relationship_type | object (relationship) |
Type of the relation. | No |
| license_url | string | URL to a license of the relation (recommended CC0) | Yes |
| source | object (object) |
First object in the relation. | Yes |
| target | object (object) |
Second object in the relation. | Yes |
Additional properties are allowed.
Schema of the object payload.
Properties
| Type | Description | Required | |
|---|---|---|---|
| object_publication_date | string | Date when the information on this object was first published. | Yes |
| object_provider | object (organization) |
Entity providing the object event information. | Yes |
| object | object (object) |
Information on the object . | Yes |
| metadata | object | Metadata that is associated with this object | No |
| metadata_schema | string | Example: DataCite, Zenodo | No |
| metadata_schema_url | string | Example: https://zenodo.org/schemas/records/record-v1.0.0.json | No |
Additional properties are allowed.
Schemas of smaller structured objects used within other payload.
Available definitions
| Type | Description | Required | |
|---|---|---|---|
| name | string | Name of the organization, which can be an event payload information provider, object publisher etc. | No |
| identifier | object (identifier) |
No |
| Type | Description | Required | |
|---|---|---|---|
| scholix_relationship | string | Currently-supported Scholix relations. | No |
| original_relationship_name | string | All other relationship names. Supporting all metadata types of DataCite Metadata Schema 4.1 | No |
| original_relationship_schema | string | Schema of the relation type. Currently DataCite only. | No |
| Type | Description | Required | |
|---|---|---|---|
| id | string | E.g.: 10.5281/zenodo.123 | Yes |
| id_schema | string | E.g.: DOI | Yes |
| id_url | string | E.g.: http://doi.org | No |
| Type | Description | Required | |
|---|---|---|---|
| name | string | No | |
| sub_type | string | No | |
| sub_type_schema | string | No |
| Type | Description | Required | |
|---|---|---|---|
| identifier | object (identifier) |
No | |
| type | object (object_type) |
No | |
| publisher | object (organization) |
No | |
| publication_date | string | Object (PID) first publication date. Type dc:date. | No |