Extension Validation API


Extension Basics

Title
Validation API
Name
ckanext-validationapi
Type
Public extension
Description
Provides a public API as a wrapper around the internal validator functions of CKAN. Part of Berlin's open data portal daten.berlin.de.
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-12-20 08:45:16)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-validationapi

This plugin belongs to a set of plugins for the Datenregister – the non-public CKAN instance that is part of Berlin’s open data portal daten.berlin.de.

ckanext-validationapi provides an API as a public wrapper around the internal validator functions of CKAN.

The plugin implements the following CKAN interfaces: - IBlueprint - IConfigurer

Requirements

This plugin has been tested with CKAN 2.9 (which requires Python 3).

Using the API

All validator functions that are available through ckan.plugins.toolkit.get_validator() can be used. The API is accessible via $CKAN_URL/api/validation; currently its only method is validate.

Only POST requests with content type application/json are accepted.

The expected payload to validate is a JSON object with two attributes: - validator: The name of the validator - value: The value we want to submit for validation

The response includes: validator, value, success, and either result or message.

License

AGPL v3.0, copyright BerlinOnline GmbH.

Version
0.2.3
Version release date
2024-12-20
Contact name
BerlinOnline GmbH
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Tested with CKAN 2.9 (Python 3). Provides API endpoint at /api/validation/validate.

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