Skip to content

Commit 37554c4

Browse files
committed
Improve the field description of the Budget object
Budget, Budget.id, Budget.description, Budget.amount #701
1 parent c8708df commit 37554c4

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

schema/dereferenced-release-schema.json

+9-9
Original file line numberDiff line numberDiff line change
@@ -600,11 +600,11 @@
600600
"budget": {
601601
"type": "object",
602602
"title": "Budget information",
603-
"description": "This section contains information about the budget line, and associated projects, through which this contracting process is funded. It draws upon the data model of the [Fiscal Data Package](https://frictionlessdata.io/specs/fiscal-data-package/), and should be used to cross-reference to more detailed information held using a Budget Data Package, or, where no linked Budget Data Package is available, to provide enough information to allow a user to manually or automatically cross-reference with another published source of budget and project information.",
603+
"description": "This section contains basic information about the budget estimated for, or allocated to, this contracting process at the present time. Further documentation and data about how budgets have been allocated to a contracting process should be published outside of OCDS data, according to the best available standards.",
604604
"properties": {
605605
"id": {
606606
"title": "ID",
607-
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against the provided data source. Although an integer is allowed, it is recommended to use a string.",
607+
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against formal budget documents.",
608608
"type": [
609609
"string",
610610
"integer",
@@ -613,7 +613,7 @@
613613
},
614614
"description": {
615615
"title": "Budget Source",
616-
"description": "A short free text description of the budget source. May be used to provide the title of the budget line, or the programme used to fund this project.",
616+
"description": "A short free-text description of the budget allocation for this contracting process. This may be used to provide human-readable information on the budget category allocated to this contracting process, and/or, information about the nature and source of the allocation (e.g. conditional, confirmed; any official authorizations given to the budget allocation).",
617617
"type": [
618618
"string",
619619
"null"
@@ -8994,11 +8994,11 @@
89948994
"budget": {
89958995
"type": "object",
89968996
"title": "Budget information",
8997-
"description": "This section contains information about the budget line, and associated projects, through which this contracting process is funded. It draws upon the data model of the [Fiscal Data Package](https://frictionlessdata.io/specs/fiscal-data-package/), and should be used to cross-reference to more detailed information held using a Budget Data Package, or, where no linked Budget Data Package is available, to provide enough information to allow a user to manually or automatically cross-reference with another published source of budget and project information.",
8997+
"description": "This section contains basic information about the budget estimated for, or allocated to, this contracting process at the present time. Further documentation and data about how budgets have been allocated to a contracting process should be published outside of OCDS data, according to the best available standards.",
89988998
"properties": {
89998999
"id": {
90009000
"title": "ID",
9001-
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against the provided data source. Although an integer is allowed, it is recommended to use a string.",
9001+
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against formal budget documents.",
90029002
"type": [
90039003
"string",
90049004
"integer",
@@ -9007,7 +9007,7 @@
90079007
},
90089008
"description": {
90099009
"title": "Budget Source",
9010-
"description": "A short free text description of the budget source. May be used to provide the title of the budget line, or the programme used to fund this project.",
9010+
"description": "A short free-text description of the budget allocation for this contracting process. This may be used to provide human-readable information on the budget category allocated to this contracting process, and/or, information about the nature and source of the allocation (e.g. conditional, confirmed; any official authorizations given to the budget allocation).",
90119011
"type": [
90129012
"string",
90139013
"null"
@@ -19252,11 +19252,11 @@
1925219252
"Budget": {
1925319253
"type": "object",
1925419254
"title": "Budget information",
19255-
"description": "This section contains information about the budget line, and associated projects, through which this contracting process is funded. It draws upon the data model of the [Fiscal Data Package](https://frictionlessdata.io/specs/fiscal-data-package/), and should be used to cross-reference to more detailed information held using a Budget Data Package, or, where no linked Budget Data Package is available, to provide enough information to allow a user to manually or automatically cross-reference with another published source of budget and project information.",
19255+
"description": "This section contains basic information about the budget estimated for, or allocated to, this contracting process at the present time. Further documentation and data about how budgets have been allocated to a contracting process should be published outside of OCDS data, according to the best available standards.",
1925619256
"properties": {
1925719257
"id": {
1925819258
"title": "ID",
19259-
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against the provided data source. Although an integer is allowed, it is recommended to use a string.",
19259+
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against formal budget documents.",
1926019260
"type": [
1926119261
"string",
1926219262
"integer",
@@ -19265,7 +19265,7 @@
1926519265
},
1926619266
"description": {
1926719267
"title": "Budget Source",
19268-
"description": "A short free text description of the budget source. May be used to provide the title of the budget line, or the programme used to fund this project.",
19268+
"description": "A short free-text description of the budget allocation for this contracting process. This may be used to provide human-readable information on the budget category allocated to this contracting process, and/or, information about the nature and source of the allocation (e.g. conditional, confirmed; any official authorizations given to the budget allocation).",
1926919269
"type": [
1927019270
"string",
1927119271
"null"

schema/release-schema.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1029,11 +1029,11 @@
10291029
"Budget": {
10301030
"type": "object",
10311031
"title": "Budget information",
1032-
"description": "This section contains information about the budget line, and associated projects, through which this contracting process is funded. It draws upon the data model of the [Fiscal Data Package](https://frictionlessdata.io/specs/fiscal-data-package/), and should be used to cross-reference to more detailed information held using a Budget Data Package, or, where no linked Budget Data Package is available, to provide enough information to allow a user to manually or automatically cross-reference with another published source of budget and project information.",
1032+
"description": "This section contains basic information about the budget estimated for, or allocated to, this contracting process at the present time. Further documentation and data about how budgets have been allocated to a contracting process should be published outside of OCDS data, according to the best available standards.",
10331033
"properties": {
10341034
"id": {
10351035
"title": "ID",
1036-
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against the provided data source. Although an integer is allowed, it is recommended to use a string.",
1036+
"description": "An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against formal budget documents.",
10371037
"type": [
10381038
"string",
10391039
"integer",
@@ -1042,15 +1042,15 @@
10421042
},
10431043
"description": {
10441044
"title": "Budget Source",
1045-
"description": "A short free text description of the budget source. May be used to provide the title of the budget line, or the programme used to fund this project.",
1045+
"description": "A short free-text description of the budget allocation for this contracting process. This may be used to provide human-readable information on the budget category allocated to this contracting process, and/or, information about the nature and source of the allocation (e.g. conditional, confirmed; any official authorizations given to the budget allocation).",
10461046
"type": [
10471047
"string",
10481048
"null"
10491049
]
10501050
},
10511051
"amount": {
10521052
"title": "Amount",
1053-
"description": "The value reserved in the budget for this contracting process. A negative value indicates anticipated income to the budget as a result of this contracting process, rather than expenditure. Where the budget is drawn from multiple sources, the budget breakdown extension can be used.",
1053+
"description": "The value reserved in the budget for this contracting process. A negative value indicates anticipated income to the budget as a result of this contracting process, rather than expenditure. Where the budget is drawn from multiple sources, the budget breakdown extension can be used. This field should not be used to report the total value of the budget line funding this contracting process.",
10541054
"$ref": "#/definitions/Value"
10551055
},
10561056
"project": {

0 commit comments

Comments
 (0)