architecture · Wiki · Validata / Validata Core

Validata Architecture

graph TD

subgraph Validata
    UI["validata-ui"]
    API["validata-api"]
    core["validata-core"]
    UI-config(Configuration)
end

    schema[Schemas]
    catalog[Schema Catalog]
    ODS-py[opendataschema-python]
    TS[Table Schema<br>Specification]
    schema-catalog[Schema Catalog<br>Specification]
    
    UI -- calls --> API
    API -- uses --> core
    UI === UI-config
    UI-config -- references --> catalog
    catalog -- references --> schema
    UI -- uses --> ODS-py
    ODS-py -- to interact with --> catalog
    catalog -- defined by --> schema-catalog

    schema -- defined by --> TS
    core -- uses --> Goodtables

subgraph FD[Frictionless Data]
    Goodtables -- uses --> TS
end
    
    click UI "https://git.opendatafrance.net/validata/validata-ui"
    click API "https://git.opendatafrance.net/validata/validata-api/"
    click core "https://git.opendatafrance.net/validata/validata-core/"
    click UI-config "https://git.opendatafrance.net/validata/validata-ui/blob/master/homepage_config.json.example"
    click ODS-py "https://framagit.org/opendataschema/opendataschema-python"
    click TS2M "https://framagit.org/opendataschema/table-schema-to-markdown"
    click Goodtables "https://github.com/frictionlessdata/goodtables-py/"
    click TS "https://frictionlessdata.io/specs/table-schema/"
   click schema-catalog "https://framagit.org/opendataschema/catalog/blob/master/schema-catalog.json"

Current implementations of Validata

OpenDataFrance
- Validata instance (official) : https://go.validata.fr/
- Schema Catalog : Socle commun des données locales (SCDL) (catalog file)
Etalab
- Validata instance : https://validata.etalab.studio/
- Schema Catalog : schema.data.gouv.fr (catalog file)

SCDL Documentation Architecture

graph TD

subgraph Documentation[SCDL Documentation]

    siteSCDL[scdl.opendatafrance.net]
    doc[SCDL/documentation]
    Markdown[Documentation Markdown Files]
end

    catalog[SCDL Schema Catalog]
    schema[SCDL Schemas]
    TS2M[table-schema-to-markdown]
    ODS-py[opendataschema-python]
    
    siteSCDL -- is powered by --> doc
    doc -- uses --> ODS-py
    ODS-py -- to interact with --> catalog  
    doc -- contains --> Markdown
    doc -- uses --> Gitbook
    Markdown -- generated by --> TS2M
    TS2M -- from --> schema

    catalog -- references --> schema

    click siteSCDL "https://scdl.opendatafrance.net/"
    click catalog "https://git.opendatafrance.net/scdl/catalog"
    click doc "https://git.opendatafrance.net/scdl/documentation"
    click ODS-py "https://framagit.org/opendataschema/opendataschema-python"
    click TS2M "https://framagit.org/opendataschema/table-schema-to-markdown"

Simple version:

graph TD

siteSCDL[scdl.opendatafrance.net]
md[Markdown Files]
doc[SCDL Documentation]
TS2M[table-schema-to-markdown]
ODS-py[opendataschema-python]

catalog[SCDL Schema Catalog]
schemas[SCDL Schemas]

doc -- uses --> ODS-py
ODS-py -- to access --> catalog

catalog -- which references --> schemas
schemas -- used by --> TS2M
TS2M -- to generate --> md
md -- Gitbook --> siteSCDL

click doc "https://git.opendatafrance.net/scdl/documentation"
click ODS-py "https://framagit.org/opendataschema/opendataschema-python"
click catalog "https://git.opendatafrance.net/scdl/catalog"
click TS2M "https://framagit.org/opendataschema/table-schema-to-markdown"
click md "https://git.opendatafrance.net/scdl/documentation"
click siteSCDL "https://scdl.opendatafrance.net/"