From 36472af5646a9583ae8480d80da943802bc1f0c9 Mon Sep 17 00:00:00 2001 From: georgeRobertson <50412379+georgeRobertson@users.noreply.github.com> Date: Fri, 14 Aug 2026 11:36:08 +0100 Subject: [PATCH] docs: fix json schema definitions --- .../field_specification.schema.json | 10 ---- .../components/readable_entity.schema.json | 2 +- .../global_csv_reader_args.schema.json | 8 ++- .../contract/components/type_name.schema.json | 54 +++++++++++-------- 4 files changed, 38 insertions(+), 36 deletions(-) diff --git a/docs/advanced_guidance/json_schemas/contract/components/field_specification.schema.json b/docs/advanced_guidance/json_schemas/contract/components/field_specification.schema.json index 5564e18..94e90ff 100644 --- a/docs/advanced_guidance/json_schemas/contract/components/field_specification.schema.json +++ b/docs/advanced_guidance/json_schemas/contract/components/field_specification.schema.json @@ -184,16 +184,6 @@ } } }, - { - "properties": { - "callable": { - "const": "postcode" - }, - "constraints": { - "$ref": "type_constraints/postcode.schema.json" - } - } - }, { "properties": { "callable": { diff --git a/docs/advanced_guidance/json_schemas/contract/components/readable_entity.schema.json b/docs/advanced_guidance/json_schemas/contract/components/readable_entity.schema.json index fdf2565..f79e27b 100644 --- a/docs/advanced_guidance/json_schemas/contract/components/readable_entity.schema.json +++ b/docs/advanced_guidance/json_schemas/contract/components/readable_entity.schema.json @@ -120,7 +120,7 @@ "type": "object", "properties": { "reader": { - "const": "DuckDBXMLReader" + "const": "DuckDBXMLStreamReader" }, "kwargs": { "$ref": "reader_constraints/ddb_xml_reader.schema.json" diff --git a/docs/advanced_guidance/json_schemas/contract/components/reader_constraints/global_csv_reader_args.schema.json b/docs/advanced_guidance/json_schemas/contract/components/reader_constraints/global_csv_reader_args.schema.json index 4ea82ec..56e2acc 100644 --- a/docs/advanced_guidance/json_schemas/contract/components/reader_constraints/global_csv_reader_args.schema.json +++ b/docs/advanced_guidance/json_schemas/contract/components/reader_constraints/global_csv_reader_args.schema.json @@ -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", diff --git a/docs/advanced_guidance/json_schemas/contract/components/type_name.schema.json b/docs/advanced_guidance/json_schemas/contract/components/type_name.schema.json index 660a910..0efa287 100644 --- a/docs/advanced_guidance/json_schemas/contract/components/type_name.schema.json +++ b/docs/advanced_guidance/json_schemas/contract/components/type_name.schema.json @@ -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 } \ No newline at end of file