-
Notifications
You must be signed in to change notification settings - Fork 2
/
release-schema.json
155 lines (155 loc) · 8.28 KB
/
release-schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
{
"definitions": {
"Implementation": {
"properties": {
"financialProgress": {
"title": "Financial progress",
"description": "The financial progress section allows high-level and detailed information on amounts committed or spent to date for this particular contract. This may be used alongside the transactions section, which allows for details of each individual payment to be recorded.",
"type": "object",
"properties": {
"totalSpend": {
"title": "Total spend",
"description": "The total spend on this contract at the date of last update. Note that the exact fiscal measure this number represents may vary between data publishers (e.g. amount invoiced vs. amount transferred to the bank account of the supplier).",
"$ref": "#/definitions/Value"
},
"measures": {
"title": "Measures",
"description": "This measures section reports aggregated financial progress figures for this contract (i.e. without breakdown by budget classifications). Measures must be provided as a set of key-value pairs, where the key should be the name of the measure used within a related Fiscal Data Package dataset or other budget and spending dataset. The value is the value of this measure when last updated, and must be provided as a number in the same default currency as any aggregate reported budget or spending figures.",
"type": "object",
"patternProperties": {
"[A-Za-z0-9._-]": {
"type": [
"number",
"null"
]
}
},
"minProperties": 1
},
"breakdown": {
"title": "Financial progress breakdown",
"description": "This section contains a breakdown of financial progress, allowing various measures (amount invoiced, amount accrued, amount paid etc.) to be disaggregated by source, period and budget classification",
"type": "array",
"items": {
"$ref": "#/definitions/FinancialProgressBreakdown"
},
"uniqueItems": true,
"minItems": 1
}
},
"minProperties": 1
}
}
},
"FinancialProgressBreakdown": {
"title": "Financial progress breakdown",
"description": "This section allows a detailed breakdown of financial progress to be provided, each covering a particular periods, or allocating financial progress against particular funding sources and fiscal classifications.",
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"title": "Identifier",
"description": "An identifier for this particular financial progress breakdown entry.",
"type": [
"string",
"integer"
],
"minLength": 1
},
"description": {
"title": "Description",
"description": "A short free text description of this financial progress breakdown. This may be displayed in user interfaces to help users interpret this entry. This may be automatically generated from structured data or may be manually entered.",
"type": [
"string",
"null"
],
"minLength": 1
},
"period": {
"title": "Budget period",
"description": "The period covered by this financial progress breakdown entry. This information may also be duplicated using classifications where relevant.",
"$ref": "#/definitions/Period"
},
"classifications": {
"title": "Budget classifications",
"description": "Budget classifications must be provided as a set of key-value pairs, where the key is a dimension (or the label of a dimension) used in budget classification, and the value is the value of that dimension for this contracting process or specific contract (depending on the point within an OCDS file at which the classification is provided).",
"type": "object",
"patternProperties": {
"[A-Za-z0-9._-]": {
"type": [
"string",
"number",
"null"
],
"minLength": 1
}
},
"minProperties": 1
},
"measures": {
"title": "measures",
"description": "Measures must be provided as a set of key-value pairs, where the key should be the name of the measure used within a related Fiscal Data Package dataset or other budget and spending dataset. The value is the value of this measure when last updated, and must be provided as a number in the same default currency as any aggregate reported budget or spending figures.",
"type": "object",
"patternProperties": {
"[A-Za-z0-9._-]": {
"type": [
"number",
"null"
]
}
},
"minProperties": 1
},
"fiscalBreakdownFieldMapping": {
"$ref": "#/definitions/FiscalBreakdownFieldMapping"
}
},
"minProperties": 1
},
"BudgetBreakdown": {
"properties": {
"classifications": {
"title": "Budget classifications",
"description": "Budget classifications must be provided as a set of key-value pairs, where the key is a dimension (or the label of a dimension) used in budget classification, and the value is the value of that dimension for this contracting process or specific contract (depending on the point within an OCDS file at which the classification is provided).",
"type": "object",
"patternProperties": {
"[A-Za-z0-9._-]": {
"type": [
"string",
"number",
"null"
],
"minLength": 1
}
},
"minProperties": 1
},
"measures": {
"title": "measures",
"description": "Measures must be provided as a set of key-value pairs, where the key should be the name of the measure used within a related Fiscal Data Package dataset or other budget and spending dataset. The value is the value of this measure when last updated, and must be provided as a number in the same default currency as any aggregate reported budget or spending figures.",
"type": "object",
"patternProperties": {
"[A-Za-z0-9._-]": {
"type": [
"number",
"null"
]
}
},
"minProperties": 1
},
"fiscalBreakdownFieldMapping": {
"$ref": "#/definitions/FiscalBreakdownFieldMapping"
}
}
},
"FiscalBreakdownFieldMapping": {
"title": "Fiscal Breakdown Field Mapping",
"description": "OCDS defers to the Fiscal Data Package to provide detailed definitions of budget classifications and measures, including providing labels for each property and describing the relationship between each classification or measure and established fiscal concepts. A Fiscal Data Package may also contain budget and spend data, using the same classifications and measures as the OCDS file, and thereby allowing comparison between 'contract level' budget allocations and spend, and allocations and spending at the level of a particular budget line. When used, this field must contain a dereferenceable URI pointing to a [Fiscal Data Package (FDP)](https://frictionlessdata.io/specs/fiscal-data-package/) datapackage.json file (version 1.0 or above), or a file that, when decompressed, contains a datapackage.json file. The URI should include a fragment identifier with the `name` value of a particular resource within that file in order to identify the particular budget or spending data file to which contract level budget allocations and spending measures can be compared, and the particular column definitions to use. The referenced resource should contain `field` or `extraField` properties with their `name` property matching each of the budget/financial progress breakdown `classification` or `measure` fields in the OCDS data, and at minimum providing labels for these.",
"type": "string",
"format": "uri"
}
}
}