IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

provenance_domain.json 6.13 KB
Newer Older
1
2
{
    "$schema": "http://json-schema.org/draft-07/schema#",
Charles King's avatar
Charles King committed
3
    "$id": "https://w3id.org/2791/provenance_domain.json",
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
    "type": "object",
    "title": "Provenance Domain",
    "description": "Structured field for tracking data through transformations, including contributors, reviewers, and versioning.",
    "required": [
        "name",
        "version",
        "created",
        "modified",
        "contributors",
        "license"
    ],
    "additionalProperties": false,
    "properties": {
        "name": {
            "type": "string",
19
            "description": "Public searchable name for IEEE-2791 Object. This public field should take free text value using common biological research terminology supporting the terminology used in the usability_domain, external references (xref), and keywords sections.",
20
21
22
23
24
25
            "examples": [
                "HCV1a ledipasvir resistance SNP detection"
            ]
        },
        "version": {
            "type": "string",
26
27
            "description": "Records the versioning of this IEEE-2791 Object instance. IEEE-2791 Object Version should adhere to semantic versioning as recommended by Semantic Versioning 2.0.0.",
            "reference": "https://semver.org/spec/v2.0.0.html",
28
29
30
31
32
33
            "examples": [
                "2.9"
            ]
        },
        "review": {
            "type": "array",
34
            "description": "Description of the current verification status of an object in the review process. The unreviewed flag indicates that the object has been submitted, but no further evaluation or verification has occurred. The in-review flag indicates that verification is underway. The approved flag indicates that the IEEE-2791 Object has been verified and reviewed. The suspended flag indicates an object that was once valid is no longer considered valid. The rejected flag indicates that an error or inconsistency was detected in the IEEE-2791 Object, and it has been removed or rejected. The fields from the contributor object (described in section 2.1.10) is inherited to populate the reviewer section.",
35
36
37
38
39
40
41
42
43
44
45
46
47
            "items": {
                "type": "object",
                "required": [
                    "status",
                    "reviewer"
                ],
                "additionalProperties": false,
                "properties": {
                    "date": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "reviewer": {
48
49
                        "$ref": "2791object.json#/definitions/contributor",
                        "description": "Contributer that assigns IEEE-2791 review status."
50
51
52
53
54
                    },
                    "reviewer_comment": {
                        "type": "string",
                        "description": "Optional free text comment by reviewer",
                        "examples": [
Charles King's avatar
Charles King committed
55
                            "Approved by research institution staff. Waiting for approval from regulator"
56
57
58
59
60
61
62
63
64
65
66
                        ]
                    },
                    "status": {
                        "type": "string",
                        "enum": [
                            "unreviewed",
                            "in-review",
                            "approved",
                            "rejected",
                            "suspended"
                        ],
67
                        "description": "Current verification status of the IEEE-2791 Object",
68
69
70
71
72
73
                        "default": "unreviewed"
                    }
                }
            }
        },
        "derived_from": {
Charles King's avatar
Charles King committed
74
            "description": "value of `ieee2791_id` field of another IEEE-2791 that this object is partially or fully derived from",
Charles King's avatar
Charles King committed
75
            "$ref": "2791object.json#/definitions/object_id"
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
        },
        "obsolete_after": {
            "type": "string",
            "description": "If the object has an expiration date, this optional field will specify that using the ‘datetime’ type described in ISO-8601 format, as clarified by W3C https://www.w3.org/TR/NOTE-datetime.",
            "format": "date-time"
        },
        "embargo": {
            "type": "object",
            "description": "If the object has a period of time during which it shall not be made public, that range can be specified using these optional fields. Using the datetime type, a start and end time are specified for the embargo.",
            "additionalProperties": false,
            "properties": {
                "start_time": {
                    "type": "string",
                    "description": "Beginning date of embargo period.",
                    "format": "date-time"
                },
                "end_time": {
                    "type": "string",
                    "description": "End date of embargo period.",
                    "format": "date-time"
                }
            }
        },
        "created": {
            "type": "string",
101
            "description": "Date and time of the IEEE-2791 Object creation",
102
103
104
105
106
            "readOnly": true,
            "format": "date-time"
        },
        "modified": {
            "type": "string",
107
            "description": "Date and time the IEEE-2791 Object was last modified",
108
109
110
111
112
113
114
            "readOnly": true,
            "format": "date-time"
        },
        "contributors": {
            "type": "array",
            "description": "This is a list to hold contributor identifiers and a description of their type of contribution, including a field for ORCIDs to record author information, as they allow for the author to curate their information after submission. The contribution type is a choice taken from PAV ontology: provenance, authoring and versioning, which also maps to the PROV-O.",
            "items": {
115
                "$ref": "2791object.json#/definitions/contributor"
116
117
118
119
120
121
122
123
124
125
126
            }
        },
        "license": {
            "type": "string",
            "description": "Creative Commons license or other license information (text) space. The default or recommended license can be Attribution 4.0 International as shown in example",
            "examples": [
                "https://spdx.org/licenses/CC-BY-4.0.html"
            ]
        }
    }
}