From 39383ae552595fbc06d5cfe4a20524e4f0aea612 Mon Sep 17 00:00:00 2001 From: kd-ods <35495305+kd-ods@users.noreply.github.com> Date: Wed, 27 Apr 2022 13:18:57 +0100 Subject: [PATCH 1/2] Removing out of date schema editing guidance --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index f89bfa6..036b3d0 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,7 @@ ie. To update the `libcovebods/data/schema-0-2-0.json` file, check out `0.2.0` Run the compile tool, telling it where the codelists directory is and pipe the output to the file for the version you have checked out: - compiletojsonschema -c openownership-data-standard/schema/codelists/ openownership-data-standard/schema/bods-package.json > openownership-lib-cove-bods/libcovebods/data/schema-0-2-0.json - -Due to https://github.com/openownership/data-standard/issues/375 you may have to do some editing by hand. Open the files -in `libcovebods/data`. At the top level there is an `oneOf` with 3 statement types - people, entity, and ownershipOrControl. -In each of these statement types, there is an enum for the `statementType` field. This enum should have one option only - -the value for whatever type of statement it is. (ie The person statement should only have the `personStatement` value) -This tool may have added extra options - if so, remove them by hand. + compiletojsonschema -c openownership-data-standard/schema/codelists/ openownership-data-standard/schema/bods-package.json > openownership-lib-cove-bods/libcovebods/data/schema-0-2-0.json ## Code for use by external users From b8f0ebe5354f22dd14a3845c083eb5f25d8bd5be Mon Sep 17 00:00:00 2001 From: Emma <100690440+Blueskies00@users.noreply.github.com> Date: Wed, 29 Jun 2022 11:54:38 +0100 Subject: [PATCH 2/2] Reverting some changes --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 036b3d0..ededfd7 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ you have checked out: compiletojsonschema -c openownership-data-standard/schema/codelists/ openownership-data-standard/schema/bods-package.json > openownership-lib-cove-bods/libcovebods/data/schema-0-2-0.json +Due to https://github.com/openownership/data-standard/issues/375 you may have to do some editing by hand when using early versions of the schema, pre 0.3. Open the files in `libcovebods/data`. At the top level there is an `oneOf` with 3 statement types - people, entity, and ownershipOrControl. In each of these statement types, there is an enum for the `statementType` field. This enum should have one option only - the value for whatever type of statement it is. (ie The person statement should only have the `personStatement` value). This tool may have added extra options - if so, remove them by hand. + ## Code for use by external users The only code that should be used directly by users is the `libcovebods.config` and `libcovebods.api` modules.