Skip to content

docs: refactored and updated the json schemas to be more accurate and… #131

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: docs/gr-update_several_docs_for_v09
Choose a base branch
from
Open

docs: refactored and updated the json schemas to be more accurate and… #131

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
9 changes: 6 additions & 3 deletions docs/advanced_guidance/json_schemas/contract/components/base_entity.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "data-ingest:contract/components/base_entity.schema.json",
"title": "base_entity",
"description": "A complete entity specification within data ingest",
Expand All @@ -10,7 +10,8 @@
"description": "A mapping of field names to their Python types. These will either be strings representing Python types (if there are no argumements to the type), and field specification objects otherwise",
"additionalProperties": {
"$ref": "field.schema.json"
}
},
"minProperties": 1
},
"aliases": {
"description": "A mapping of field name to allowed field alias",
Expand All @@ -26,5 +27,7 @@
"type": "string"
}
}
}
},

"required": ["fields"]
}
2 changes: 1 addition & 1 deletion docs/advanced_guidance/json_schemas/contract/components/contact_error_details.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "data-ingest:contract/components/contract_error_details.schema.json",
"title": "base_entity",
"description": "A mapping of field names to the custom error code and message required if these fields were to fail validation during the data contract phase. For nested fields, these should be specified using struct '.' notation (eg. fieldA.fieldB.fieldC)",
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced_guidance/json_schemas/contract/components/entity.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "data-ingest:contract/components/entity.schema.json",
"title": "entity",
"description": "A concrete entity specification within data ingest",
Expand Down
6 changes: 5 additions & 1 deletion docs/advanced_guidance/json_schemas/contract/components/field.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "data-ingest:contract/components/field.schema.json",
"title": "field",
"description": "The type of a field, specified as a bare Python type if there are no argumements, and as an object otherwise. This can also be a reference to a type defined in the dataset",
Expand All @@ -9,6 +9,10 @@
},
{
"$ref": "field_specification.schema.json"
},
{
"type": "string",
"minLength": 1
}
]
}
2 changes: 1 addition & 1 deletion docs/advanced_guidance/json_schemas/contract/components/field_error_detail.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "data-ingest:contract/components/field_error_detail.schema.json",
"title": "field_error_detail",
"description": "The custom details to be used for a field when a validation error is raised during the data contract phase",
Expand Down
21 changes: 0 additions & 21 deletions docs/advanced_guidance/json_schemas/contract/components/field_error_type.schema copy.json
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/advanced_guidance/json_schemas/contract/components/field_error_type.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "data-ingest:contract/components/field_error_type.schema.json",
"title": "field_error_detail",
"description": "The error type for a field when a validation error is raised during the data contract phase",
Expand Down
Loading
Loading