Extension Validation Schema Generator


Extension Basics

Title
Validation Schema Generator
Name
ckanext-validation-schema-generator
Type
Public extension
Description
Generates table schema for a resource based on its content. Supports tabular data. Uses datastore and background jobs.
CKAN versions
Download-Url (zip)
Last commit
5 months ago (2025-09-26 04:01:48)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-validation-schema-generator

This extension helps to generate table schema for a resource based on its content. Support tabular data. You must define a field for datasets and resources to store a table schema data. Check config options below.

Requirements

This extension has been written to work with python 2 and CKAN 2.9.5. Relies on datastore.

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier not tested
2.7 not tested
2.8 not tested
2.9.5+ yes

Installation

  1. Activate your CKAN virtual environment
  2. Clone the source and install: pip install -e . && pip install -r requirements.txt
  3. Add validation-schema-generator to the ckan.plugins setting in your CKAN config file
  4. Restart CKAN

Config settings

ckanext.validation_schema_generator.job_timeout = 3600
ckanext.validation_schema_generator.pass_api_key = True
ckanext.validation_schema_generator.api_key =
ckanext.validation_schema_generator.resource_schema_field_name = schema
ckanext.validation_schema_generator.package_schema_field_name = default_data_schema
ckanext.validation_schema_generator.allow_edit_generated_schema = False

API endpoints

  • vsg_generate - starts the schema generation process
  • vsg_status - returns status of schema generation for a resource
  • vsg_update - updates a schema generation task data
  • vsg_apply - apply a generated schema for a resource or dataset

License

AGPL

Version
2.0.1
Version release date
2025-09-26
Contact name
Queensland Government
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Relies on datastore. Compatible with CKAN 2.9.5+.

Plugins to configure (ckan.ini)
validation-schema-generator
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions