Skip to content

PATCH: Refactor codelist declarations #435

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.

Sign up for GitHub

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

Open
mrshll1001 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

PATCH: Refactor codelist declarations #435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 109 additions & 49 deletions schema/360-giving-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@
"format": "date-time"
},
{
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
}
],
"type": "string",
Expand Down Expand Up @@ -454,7 +454,7 @@
],
"description": "A name for this location.",
"title": "Name"
},
},
"countryCode": {
"type": [
"string",
Expand Down Expand Up @@ -854,19 +854,19 @@
"type": "object",
"required": [
"id",
"name"
"name"
],
"properties": {
"id": {
"type": "string",
"description": "A unique identifier which identifies the person in the dataset",
"title": "Identifier"
},
"name": {
"type": "string",
"description": "The Person's full name or a generic name such as \"Individual Recipient\" ",
"title": "Name"
}
"type": "string",
"description": "A unique identifier which identifies the person in the dataset",
"title": "Identifier"
},
"name": {
"type": "string",
"description": "The Person's full name or a generic name such as \"Individual Recipient\" ",
"title": "Name"
}
}
},
"Organization": {
Expand Down Expand Up @@ -997,7 +997,7 @@
"format": "date-time"
},
{
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
},
{
"pattern": "^[0-9]{4}(-(0[1-9]|1[012]))?$"
Expand All @@ -1013,7 +1013,7 @@
"format": "date-time"
},
{
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
},
{
"pattern": "^[0-9]{4}(-(0[1-9]|1[012]))?$"
Expand Down Expand Up @@ -1049,7 +1049,7 @@
"id",
"title",
"description",
"currency",
"currency",
"amountAwarded",
"awardDate",
"recipientOrganization",
Expand Down Expand Up @@ -1090,17 +1090,17 @@
},
"amountAppliedFor": {
"type": "number",
"description": "Total amount applied for in numbers (do not include commas or currency symbols such as \u00a3). If you have provided detailed transaction information on a separate table, this should equal the sum of all the application transactions for this grant.",
"description": "Total amount applied for in numbers (do not include commas or currency symbols such as £). If you have provided detailed transaction information on a separate table, this should equal the sum of all the application transactions for this grant.",
"title": "Amount Applied For"
},
"amountAwarded": {
"type": "number",
"description": "Total amount awarded in numbers (do not include commas or currency symbols such as \u00a3). If you have provided detailed transaction information on a separate table, this should equal the sum of all the award transactions for this grant.",
"description": "Total amount awarded in numbers (do not include commas or currency symbols such as £). If you have provided detailed transaction information on a separate table, this should equal the sum of all the award transactions for this grant.",
"title": "Amount Awarded"
},
"amountDisbursed": {
"type": "number",
"description": "Total amount disbursed (paid) to this grantee when this record was last updated (in numbers: do not include commas or currency symbols such as \u00a3)). If you have provided detailed transaction information on a separate table, this should equal the sum of all the disbursement transactions for this grant.",
"description": "Total amount disbursed (paid) to this grantee when this record was last updated (in numbers: do not include commas or currency symbols such as £)). If you have provided detailed transaction information on a separate table, this should equal the sum of all the disbursement transactions for this grant.",
"title": "Amount Disbursed"
},
"awardDate": {
Expand All @@ -1109,7 +1109,7 @@
"format": "date-time"
},
{
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
"pattern": "^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
}
],
"type": "string",
Expand Down Expand Up @@ -1153,29 +1153,73 @@
"title": "To Individuals Details",
"properties": {
"primaryGrantReason": {
"type": "string",
"title": "Primary Grant Reason",
"description": "A code referring to the reason(s) for a grant to an individual. The value for this field should be drawn from the Grant to Individuals Reason codelist",
"codelist": "grantToIndividualsReason.csv",
"openCodelist": false
},
"secondaryGrantReason": {
"type": "string",
"title": "Secondary Grant Reason",
"description": "A code referring to the reason(s) for a grant to an individual. The value for this field should be drawn from the Grant to Individuals Reason codelist",
"codelist": "grantToIndividualsReason.csv",
"openCodelist": false
},
"grantPurpose": {
"type": "array",
"title": "Grant Purpose",
"description": "A code referring to the purpose(s) for a grant to an individual. The value(s) for this field should be drawn from the Grant to Individuals Purpose codelist",
"items": {
"type": "string",
"codelist": "grantToIndividualsPurpose.csv",
"openCodelist": false
}
}
"type": "string",
"title": "Primary Grant Reason",
"description": "A code referring to the reason(s) for a grant to an individual. The value for this field should be drawn from the Grant to Individuals Reason codelist",
"enum": [
"GTIR010",
"GTIR020",
"GTIR030",
"GTIR040",
"GTIR050",
"GTIR060",
"GTIR070",
"GTIR080",
"GTIR090",
"GTIR100",
"GTIR110",
"GTIR120"
],
"codelist": "grantToIndividualsReason.csv"
},
"secondaryGrantReason": {
"type": "string",
"title": "Secondary Grant Reason",
"description": "A code referring to the reason(s) for a grant to an individual. The value for this field should be drawn from the Grant to Individuals Reason codelist",
"enum": [
"GTIR010",
"GTIR020",
"GTIR030",
"GTIR040",
"GTIR050",
"GTIR060",
"GTIR070",
"GTIR080",
"GTIR090",
"GTIR100",
"GTIR110",
"GTIR120"
],
"codelist": "grantToIndividualsReason.csv"
},
"grantPurpose": {
"type": "array",
"title": "Grant Purpose",
"description": "A code referring to the purpose(s) for a grant to an individual. The value(s) for this field should be drawn from the Grant to Individuals Purpose codelist",
"items": {
"type": "string",
"enum": [
"GTIP010",
"GTIP020",
"GTIP030",
"GTIP040",
"GTIP050",
"GTIP060",
"GTIP070",
"GTIP080",
"GTIP090",
"GTIP100",
"GTIP110",
"GTIP120",
"GTIP130",
"GTIP140",
"GTIP150",
"GTIP160",
"GTIP170"
],
"codelist": "grantToIndividualsPurpose.csv"
}
}
}
},
"recipientOrganization": {
Expand Down Expand Up @@ -1324,15 +1368,31 @@
"title": "For Regrant Type",
"description": "A code referring to the type of regranting process that this grant represents. The value for this field should be drawn from the Regrant Type codelist",
"type": "string",
"codelist": "regrantType.csv",
"openCodelist": false
"enum": [
"FRG010",
"FRG020",
"FRG030",
"FRG040",
"FRG050",
"FRG060",
"FRG070"
],
"codelist": "regrantType.csv"
},
"locationScope": {
"type": "string",
"title": "Location Scope",
"description": "A code referring to the location scope applicable to this grant. The value for this field should be drawn from the Location Scope codelist.",
"codelist": "locationScope.csv",
"openCodelist": false
"type": "string",
"title": "Location Scope",
"description": "A code referring to the location scope applicable to this grant. The value for this field should be drawn from the Location Scope codelist.",
"enum": [
"GLS010",
"GLS020",
"GLS030",
"GLS040",
"GLS050",
"GLS060",
"GLS099"
],
"codelist": "locationScope.csv"
}
}
}