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

2791object.json 6.57 KB
Newer Older
1
    "$schema": "http://json-schema.org/draft-07/schema#",
2
    "$id": "https://w3id.org/2791/schemas/2791object.json",
3
    "type": "object",
4
5
    "title": "Base type for all IEEE-2791 Objects",
    "description": "All IEEE-2791 object types must adhear to this type in order to be compliant with IEEE-2791 standard",
6
    "required": [
7
8
        "ieee2791_id",
        "ieee2791_spec_version",
Charles King's avatar
ETag    
Charles King committed
9
        "etag",
10
11
12
13
        "provenance_domain",
        "usability_domain",
        "description_domain",
        "execution_domain",
14
        "io_domain"
15
16
    ],
    "definitions": {
17
        "ieee2791_id": {
18
            "type": "string",
19
            "description": "A unique identifier that should be applied to each IEEE-2791 Object instance, generated and assigned by a IEEE-2791 database engine. IDs should never be reused",
20
            "examples": [
21
                "https://w3id.org/2791/examples/HCV1a.json"
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
            ]
        },
        "uri": {
            "type": "object",
            "description": "A Uniform Resource Identifer",
            "additionalProperties": false,
            "required": [
                "uri"
            ],
            "properties": {
                "filename": {
                    "type": "string"
                },
                "uri": {
                    "type": "string",
                    "format": "uri"
                },
                "access_time": {
                    "type": "string",
                    "format": "date-time"
                },
43
                "sha1_checksum": {
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
                    "type": "string",
                    "description": "hash function that produces a message digest",
                    "pattern": "[A-Za-z0-9]+"
                }
            }
        }, 
        "contributor": {
            "type": "object",
            "description": "Contributor identifier and type of contribution (determined according to PAV ontology) is required",
            "required": [
                "contribution",
                "name"
            ],
            "additionalProperties": false,
            "properties": {
                "name": {
                    "type": "string",
                    "description": "Name of contributor",
                    "examples": [
                        "Charles Hadley King"
                    ]
                },
                "affiliation": {
                    "type": "string",
                    "description": "Organization the particular contributor is affiliated with",
                    "examples": [
                        "George Washington University"
                    ]
                },
                "email": {
                    "type": "string",
                    "description": "electronic means for identification and communication purposes",
                    "examples": [
                        "hadley_king@gwu.edu"
                    ],
                    "format": "email"
                },
                "contribution": {
                    "type": "array",
                    "description": "type of contribution determined according to PAV ontology",
                    "reference": "https://doi.org/10.1186/2041-1480-4-37",
                    "items": {
                        "type": "string",
                        "enum": [
                            "authoredBy",
                            "contributedBy",
                            "createdAt",
                            "createdBy",
                            "createdWith",
                            "curatedBy",
                            "derivedFrom",
                            "importedBy",
                            "importedFrom",
                            "providedBy",
                            "retrievedBy",
                            "retrievedFrom",
                            "sourceAccessedBy"
                        ]
                    }
                },
                "orcid": {
                    "type": "string",
                    "description": "Field to record author information. ORCID identifiers allow for the author to curate their information after submission. ORCID identifiers must be valid and must have the prefix ‘https://orcid.org/’",
                    "examples": [
                        "https://orcid.org/0000-0003-1409-4549"
                    ],
                    "format": "uri"
                }
            }
        }
    },
    "additionalProperties": false,
    "properties": {
117
118
        "ieee2791_id": {
            "$ref": "#/definitions/ieee2791_id",
119
120
            "readOnly": true
        },
121
        "ieee2791_spec_version": {
122
            "type": "string",
123
            "description": "Version of the IEEE-2791 specification used to define this document",
124
            "examples": [
125
                "https://w3id.org/2791/v1.2"
126
127
128
129
            ],
            "readOnly": true,
            "format": "uri"
        },
Charles King's avatar
ETag    
Charles King committed
130
        "etag": {
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
            "type": "string",
            "description": "A string-type, read-only value, protecting the object from internal or external alterations without proper validation generated with a SHA-256 hash function.",
            "examples": [
                "5986B05969341343E77A95B4023600FC8FEF48B7E79F355E58B0B404A4F50995"
            ],
            "readOnly": true,
            "pattern": "^([A-Za-z0-9]+)$"
        },
        "provenance_domain": {
            "$ref": "provenance_domain.json"
        },
        "usability_domain": {
            "$ref": "usability_domain.json"
        },
        "extension_domain": {
146
            "type": "array",
147
            "description": "points to internal or external references to a script object that was used to perform computations for this IEEE-2791 Object instance.",
148
149
150
151
152
153
154
155
156
157
158
159
160
161
            "items":{
                "required":[
                    "extension_schema"
                ],
                "additionalProperties": true,
                "properties": {
                    "extension_schema":{
                        "title": "Extension Schema",
                        "description": "resolving this URI should provide this extension's JSON Schema",
                        "type": "string",
                        "format": "uri"
                    }
                }
            }
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
        },
        "description_domain": {
            "$ref": "description_domain.json"
        },
        "execution_domain": {
            "$ref": "execution_domain.json"
        },
        "parametric_domain": {
            "$ref": "parametric_domain.json"
        },
        "io_domain": {
            "$ref": "io_domain.json"
        },
        "error_domain": {
            "$ref": "error_domain.json"
        }
    }
179
}