From af86a792f0e1fbe4cc0935f22fcf39bd0a49237c Mon Sep 17 00:00:00 2001 From: eveleighoj <35256612+eveleighoj@users.noreply.github.com> Date: Mon, 4 Nov 2024 21:29:27 +0000 Subject: [PATCH] add expect and expectations --- content/dataset/expect.md | 37 +++++++++++++++++++++++++++++++++ content/dataset/expectation.md | 38 ++++++++++++++++++++++++++++++++++ content/field/datasets.md | 2 +- content/field/operation.md | 17 +++++++++++++++ content/field/organisations.md | 2 +- content/field/parameters.md | 2 +- 6 files changed, 95 insertions(+), 3 deletions(-) create mode 100644 content/dataset/expect.md create mode 100644 content/dataset/expectation.md create mode 100644 content/field/operation.md diff --git a/content/dataset/expect.md b/content/dataset/expect.md new file mode 100644 index 000000000..9ffcf66d5 --- /dev/null +++ b/content/dataset/expect.md @@ -0,0 +1,37 @@ +--- +attribution: crown-copyright +collection: '' +consideration: '' +dataset: expect +description: A set of rules which can be turned into an expectation of a dataset +end-date: '' +entry-date: '' +fields: +- field: datasets +- field: organisations +- field: operation +- field: parameters +- field: name +- field: description +- field: notes +- field: severity +- field: responsibility +- field: end-date +- field: entry-date +- field: start-date +licence: ogl3 +name: expectation rule +paint-options: '' +phase: alpha +plural: expectation rules +prefix: '' +realm: configuration +replacement-dataset: '' +start-date: '' +themes: +- pipeline +typology: pipeline +version: 1.0 +wikidata: '' +wikipedia: '' +--- diff --git a/content/dataset/expectation.md b/content/dataset/expectation.md new file mode 100644 index 000000000..05f0a0741 --- /dev/null +++ b/content/dataset/expectation.md @@ -0,0 +1,38 @@ +--- +attribution: crown-copyright +collection: '' +consideration: '' +dataset: expect +description: The output of running expectations based on the rules defined in the expect dataset +end-date: '' +entry-date: '' +fields: +- field: dataset +- field: organisation +- field: operation +- field: parameters +- field: name +- field: description +- field: passed +- field: message +- field: severity +- field: responsibility +- field: end-date +- field: entry-date +- field: start-date +licence: ogl3 +name: expectation rule +paint-options: '' +phase: alpha +plural: expectation rules +prefix: '' +realm: log +replacement-dataset: '' +start-date: '' +themes: +- pipeline +typology: pipeline +version: 1.0 +wikidata: '' +wikipedia: '' +--- diff --git a/content/field/datasets.md b/content/field/datasets.md index dcee380dc..0083c43c9 100644 --- a/content/field/datasets.md +++ b/content/field/datasets.md @@ -1,7 +1,7 @@ --- cardinality: n datatype: string -description: '' +description: 'a semicolon separate list of datasets, these should be found on our platform' end-date: '' entry-date: '' field: datasets diff --git a/content/field/operation.md b/content/field/operation.md new file mode 100644 index 000000000..fb59605ed --- /dev/null +++ b/content/field/operation.md @@ -0,0 +1,17 @@ +--- +cardinality: n +datatype: string +description: 'a text string referencing an operation to be performed' +end-date: '' +entry-date: '' +field: organisations +guidance: '' +hint: '' +name: Organisations +parent-field: organisation +replacement-field: '' +start-date: '' +typology: organisation +uri-template: '' +wikidata-property: '' +--- \ No newline at end of file diff --git a/content/field/organisations.md b/content/field/organisations.md index cac3e2c3a..da20946e9 100644 --- a/content/field/organisations.md +++ b/content/field/organisations.md @@ -1,7 +1,7 @@ --- cardinality: n datatype: string -description: '' +description: 'a semicolon separate list of organisations identified using their CURIEs, these should be found on our platform in datasets with the organisation typology' end-date: '' entry-date: '' field: organisations diff --git a/content/field/parameters.md b/content/field/parameters.md index dea11e7e0..b2a474741 100644 --- a/content/field/parameters.md +++ b/content/field/parameters.md @@ -1,7 +1,7 @@ --- cardinality: n datatype: string -description: '' +description: 'a json string field containing key value pairs' end-date: '' entry-date: '' field: parameters