Skip to content

docs: fix json schema definitions #140

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
georgeRobertson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix json schema definitions #140

Show file tree
Hide file tree
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
10 changes: 0 additions & 10 deletions docs/advanced_guidance/json_schemas/contract/components/field_specification.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,16 +184,6 @@
}
}
},
{
"properties": {
"callable": {
"const": "postcode"
},
"constraints": {
"$ref": "type_constraints/postcode.schema.json"
}
}
},
{
"properties": {
"callable": {
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced_guidance/json_schemas/contract/components/readable_entity.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
"type": "object",
"properties": {
"reader": {
"const": "DuckDBXMLReader"
"const": "DuckDBXMLStreamReader"
},
"kwargs": {
"$ref": "reader_constraints/ddb_xml_reader.schema.json"
Expand Down
8 changes: 6 additions & 2 deletions ...ce/json_schemas/contract/components/reader_constraints/global_csv_reader_args.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@
"type": "object",
"properties": {
"field_check": {
"type": "boolean",
"description": "Enable to check for additional or missing fields."
"type": "string",
"description": "Enable to check for additional or missing fields.",
"enum": [
"true",
"false"
]
},
"field_check_error_code": {
"type": "string",
Expand Down
54 changes: 31 additions & 23 deletions docs/advanced_guidance/json_schemas/contract/components/type_name.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,35 @@
"$id": "data-ingest:contract/components/type_name.schema.json",
"title": "type_name",
"description": "The name of an allowed type within data ingest. This should be a Python type",
"type": "string",
"enum": [
"str",
"int",
"float",
"date",
"datetime",
"constr",
"conint",
"condate",
"condecimal",
"postcode",
"nhsnumber",
"permissivenhsno",
"alphanumeric",
"identifier",
"orgid",
"formatteddatetime",
"formattedtime",
"conformatteddate",
"reportingperiodstart",
"reportingperiodend"
]
"oneOf": [
{
"enum": [
"str",
"int",
"float",
"date",
"datetime",
"constr",
"conint",
"condate",
"condecimal",
"postcode",
"nhsnumber",
"permissivenhsno",
"alphanumeric",
"identifier",
"orgid",
"formatteddatetime",
"formattedtime",
"conformatteddate",
"reportingperiodstart",
"reportingperiodend"
]
},
{
"type": "string",
"pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
}
],
"minLength": 1
}
Loading