CkanCatalogGroup.json

{
  "type": "object",
  "defaultProperties": [
    "name",
    "type",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "title": "#URL",
      "description": "The URL of the CKAN server."
    },
    "dataCustodian": {
      "type": "string",
      "title": "#Data custodian",
      "description": "A description of the custodian of the data sources in this group.\nThis property is an HTML string that must be sanitized before display to the user."
    },
    "filterQuery": {
      "type": "array",
      "title": "#Filter query",
      "description": "The filter query to pass to CKAN when querying the available data sources and their groups.  Each string in the\narray is passed to CKAN as an independent search string and the results are concatenated to create the complete list.  The\nsearch string is equivlent to what would be in the parameters segment of the url calling the CKAN search api.\nSee the [Solr documentation](http://wiki.apache.org/solr/CommonQueryParameters#fq) for information about filter queries.\n  To get all the datasets with wms resources the query array would be ['fq=res_format%3awms']\n  To get all the datasets in the Surface Water group it would be ['q=groups%3dSurface%20Water&fq=res_format%3aWMS']\n  And to get both wms and esri-mapService datasets it would be ['q=res_format:WMS', 'q=res_format:%22Esri%20REST%22' ]",
      "format": "tabs",
      "items": {
        "type": "string",
        "title": "Filter"
      }
    },
    "blacklist": {
      "type": "object",
      "title": "#Blacklist",
      "description": "A hash of names of blacklisted groups and data sources.  A group or data source that appears in this hash\nwill not be shown to the user.  In this hash, the keys should be the names of the groups and data sources to blacklist,\nand the values should be \"true\".",
      "additionalProperties": {
        "type": "boolean",
        "format": "checkbox"
      }
    },
    "filterByWmsGetCapabilities": {
      "type": "boolean",
      "title": "#Filter by WMS get capabilities",
      "description": "A value indicating whether the CKAN datasets should be filtered by querying GetCapabilities from each\nreferenced WMS server and excluding datasets not found therein.",
      "format": "checkbox"
    },
    "minimumMaxScaleDenominator": {
      "type": "number",
      "title": "#Minimum max scale denominator",
      "description": "The minimum MaxScaleDenominator that is allowed for a WMS dataset to be included in this CKAN group.\nIf this property is undefined or if {@link CkanCatalogGroup#filterByWmsGetCapabilities} is false, no\nfiltering based on MaxScaleDenominator is performed."
    },
    "wmsParameters": {
      "type": "object",
      "title": "#WMS parameters",
      "description": "Any extra wms parameters that should be added to the wms query urls in this CKAN group.\nIf this property is undefined then no extra parameters are added."
    },
    "groupBy": {
      "type": "string",
      "title": "#Group by",
      "description": "A value indicating how datasets should be grouped.  Valid values are:\n* `none` - Datasets are put in a flat list; they are not grouped at all.\n* `group` - Datasets are grouped according to their CKAN group.  Datasets that are not in any groups are put at the top level.\n* `organization` - Datasets are grouped by their CKAN organization.  Datasets that are not associated with an organization are put at the top level."
    },
    "useResourceName": {
      "type": "boolean",
      "title": "#Use resource name",
      "description": "A value indicating whether each catalog item's name should be populated from\nindividual resources instead of from the CKAN dataset.",
      "format": "checkbox"
    },
    "allowEntireWmsServers": {
      "type": "boolean",
      "title": "#Allow entire WMS servers",
      "description": "True to allow entire WMS servers (that is, WMS resources without a clearly-defined layer) to be\nadded to the catalog; otherwise, false.",
      "format": "checkbox"
    },
    "includeWms": {
      "type": "boolean",
      "title": "#Include WMS",
      "description": "True to allow WMS resources to be added to the catalog; otherwise, false.",
      "format": "checkbox"
    },
    "includeKml": {
      "type": "boolean",
      "title": "#Include KML",
      "description": "True to allow KML resources to be added to the catalog; otherwise, false.",
      "format": "checkbox"
    },
    "includeCsv": {
      "type": "boolean",
      "title": "#Include CSV",
      "description": "True to allow CSV resources to be added to the catalog; otherwise, false.",
      "format": "checkbox"
    },
    "includeEsriMapServer": {
      "type": "boolean",
      "title": "#Include esri map server",
      "description": "True to allow ESRI Map resources to be added to the catalog; otherwise, false.",
      "format": "checkbox"
    },
    "includeGeoJson": {
      "type": "boolean",
      "title": "#Include geo JSON",
      "description": "True to allow GeoJSON resources to be added to the catalog; otherwise, false.",
      "format": "checkbox"
    },
    "includeCzml": {
      "type": "boolean",
      "title": "#Include CZML",
      "description": "True to allow CZML resources to be added to the catalog; otherwise, false.",
      "format": "checkbox"
    },
    "type": {
      "type": "string",
      "enum": [
        "ckan"
      ],
      "options": {
        "hidden": true
      }
    }
  },
  "description": "A {@link CatalogGroup} representing a collection of layers from a [CKAN](http://ckan.org) server.",
  "title": "CKAN Server",
  "allOf": [
    {
      "$ref": "CatalogGroup.json"
    },
    {
      "$ref": "CatalogMember.json"
    }
  ]
}