Skip to content

Configuration reference

General settings

ckanext.openapi.endpoints

List of OpenAPI endpoints. Each endpoint should be a dictionary with the following keys:

  • url, str: URL or relative path of the OpenAPI file, accepted formats are JSON and YAML, e.g. https://raw.githubusercontent.com/mjanez/ckanext-openapi/refs/heads/develop/ckanext/openapi/public/static/openapi/ckan.yaml or /static/openapi/sample.json
  • name, str: Path of the OpenAPI in CKAN Open Data portal, e.g. ckan
  • title, dict: Title for the endpoint in different languages, e.g. {'en': 'CKAN OpenAPI', 'es': 'Punto final OpenAPI de CKAN'}
  • description, dict: Description for the endpoint in different languages, e.g. {'en': 'CKAN OpenAPI description.', 'es': 'Descripción de OpenAPI CKAN.'} JSON List example: [{"url":"https://raw.githubusercontent.com/mjanez/ckanext-openapi/refs/heads/develop/ckanext/openapi/public/static/openapi/ckan.yaml","name":"ckan","title":{"en":"CKAN OpenAPI","es":"Punto final OpenAPI de CKAN"},"description":{"en":"CKAN OpenAPI description.","es":"Descripción de OpenAPI CKAN."}}]