Skip to content

Commit cad5934

Browse files
committed
Updated documentation to reflect data type schema change
1 parent 27c11a1 commit cad5934

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ Each semantic data type YAML file objects have following structure.
2424
- **doc** - English documentation/short description of this entity.
2525
- **langs** - list of languages
2626
- **is_pii** - true if this data is Personal identifiable information and false if not. PII could be detected also from contexts
27-
- **links** - list of associated links with **type** as link type and **url** as url. Supported link types: wikipedia, other
27+
- **links** - list of associated links with **type** as link type and **url** as url. Supported link types: wikipedia, wikidata, other
28+
- **regexp** - regular expression that match this data type
29+
- **wikidata_property** - property in Wikidata if applicable
30+
- **examples** - list of examples with **value** and **description** for each one
2831
- **parent_type** - name of the parent semantic type
2932
- **translations** - name and doc translated to selected language.
3033

@@ -41,6 +44,9 @@ Each entity YAML file objects have following structure.
4144
- **country** - list of countries where this identifier used
4245
- **langs** - list of languages
4346
- **links** - list of associated links with **type** as link type and **url** as url. Supported link types: wikipedia, other
47+
- **regexp** - regular expression that match this data type
48+
- **wikidata_property** - property in Wikidata if applicable
49+
- **examples** - list of examples with **value** and **description** for each one
4450

4551
## Identification rules
4652

@@ -53,7 +59,7 @@ Identification rules are regex, other pattern matching algorithms and code that
5359
# Code
5460

5561
* scripts/ - list of scripts to convert and process data types and related registry data
56-
* src/ - minimalistic server side code to run metadata server
62+
* src/ - minimalistic server side code to run metadata server/
5763

5864
# Build registry
5965

@@ -67,6 +73,10 @@ Current data update procedure:
6773

6874
TODO: Add github actions for automatic registry build, version control, release and validation.
6975

76+
# Run server
77+
Server uses data/datatypes_latest.jsonl file to produce HTML for datatypes list
78+
1. Go to "src" directory
79+
2. Run "python registry.py"
7080

7181
# Contacts
7282

0 commit comments

Comments
 (0)