Extension Jsonschema


Extension Basics

Title
Jsonschema
Name
ckanext-jsonschema
Type
Public extension
Description
The `ckanext-jsonschema` extension enhances CKAN (version 2.8 and later) by introducing JSON Schema
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-01-25 14:18:47)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

What is ckanext-jsonschema

This plugin provide a quite extensive set of functionalities to introduce jsonschema based metadata types into CKAN (>=2.8) metadata.

It also provide an User Interface (UI) based on the json-editor library to properly edit and validate complex json fields. The UI can also be customized in terms of components and autocompletion capabilities via javascript modules.

Provide an iso19139 implementation and a simplified profile and several types already implemented.

Provide several extension points to introduce new dataset and resource formats in other (json based) formats (f.e. STAC).

How it works

Leveraging on the extra fields capabilities of CKAN, the jsonschema plugin is defining three extra predefined and fixed custom fields.

These will be used extensively to add json and jsonschema capabilities to CKAN.

The goal is to simplify the way a metadata mapping is performed in CKAN.

These fields could be attached to the dataset, resource or view objects of CKAN.

Basic functionalities :

Registry :

This functionality drives the behaviours of jsonschema plugin. Each plugin can define its own registry to define its own types with configurations.

In case you need more details please reference the Registry section in development documentation

Validator :

This functionality of jsonschema plugin makes it possible to dynamically validate user inputs.

In case you need more details please reference the Validator section in development documentation

View Configurations :

This functionality allows each plugin to have multiple view types.

In case you need more details please reference the View Configurations section in development documentation

ADDITIONAL FUNCTIONALITIES

Json addition is just a way to store JSON’s in CKAN providing an

Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

and Administration

The jsonschema plugin comes with several plugins. To add their functionalities, these must be configured in the ckan.plugins property.

The plugin which depend on jsonschema can be of two types; they can implement metadata (and resource) functionalities or view functionalities.

Plugins to configure (ckan.ini)
jsonschema
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions