Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Event message model #5

Open
krzysztof opened this issue Oct 11, 2017 · 1 comment
Open

Event message model #5

krzysztof opened this issue Oct 11, 2017 · 1 comment

Comments

@krzysztof
Copy link
Member

This is the description of the top-level event model (not specific to any payload).

Terms:

Type Description Required
event_type string Controlled vocabulary: "relation_created", "relation_removed" Yes
creator string "Zenodo", "ADS" Yes
source string "Zenodo.Curation", "Zenodo.System", "ADS.Discovery" Yes
payload object Object specific to the event_type. Yes
id string Global identifier of the event (UUID) Yes
time string describing the time of the event creation. This is the date at which the event was created on the participating systems, e.g. for Zenodo it would be the time at which the record was published on Zenodo, NOT when the event was sent or received Yes
@krzysztof
Copy link
Member Author

Some suggestions:
creator and source could be merged into one structured field, e.g.: "source": {"creator": "Zenodo", "type": "SystemEvent"}. The necessity of this field is up for discussion. The reason for this field is to describe how given event was created, as to allow for better interpretation by third parties, e.g.: events of type "ADS.Discovery" might come from a heuristic algorithm, while "Zenodo.Curation" might come from the user-updated metadata. Those might have different levels of "trust" or accuracy.

@krzysztof krzysztof changed the title Event message model. Event message model Oct 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant