qwc-map-viewer.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/qwc-services/qwc-map-viewer/v2/schemas/qwc-map-viewer.json",
  "title": "QWC Map Viewer",
  "type": "object",
  "properties": {
    "$schema": {
      "title": "JSON Schema",
      "description": "Reference to JSON schema of this config",
      "type": "string",
      "format": "uri",
      "default": "https://raw.githubusercontent.com/qwc-services/qwc-map-viewer/v2/schemas/qwc-map-viewer.json"
    },
    "service": {
      "title": "Service name",
      "type": "string",
      "const": "map-viewer"
    },
    "config": {
      "title": "Config options",
      "type": "object",
      "properties": {
        "db_url": {
          "description": "DB connection URL (for user_info_fields). Can be set to an empty string if running without DB.",
          "type": "string"
        },
        "qwc_config_schema": {
          "description": "The name of the DB schema which stores the qwc config. Default: qwc_config",
          "type": "string"
        },
        "qwc2_path": {
          "description": "Path to QWC2 files",
          "type": "string"
        },
        "auth_service_url": {
          "description": "QWC Auth Service URL",
          "type": "string"
        },
        "ccc_config_service_url": {
          "description": "CCC Service URL",
          "type": "string"
        },
        "data_service_url": {
          "description": "QWC Data Service URL",
          "type": "string"
        },
        "dataproduct_service_url": {
          "description": "DataProduct Service URL",
          "type": "string"
        },
        "document_service_url": {
          "description": "Document Service URL",
          "type": "string"
        },
        "elevation_service_url": {
          "description": "QWC Elevation Service URL",
          "type": "string"
        },
        "info_service_url": {
          "description": "QWC FeatureInfo Service URL",
          "type": "string"
        },
        "landreg_service_url": {
          "description": "Land Register Extract Service URL",
          "type": "string"
        },
        "legend_service_url": {
          "description": "QWC Legend Service URL",
          "type": "string"
        },
        "mapinfo_service_url": {
          "description": "MapInfo Service URL",
          "type": "string"
        },
        "ogc_service_url": {
          "description": "QWC OGC Service URL",
          "type": "string"
        },
        "permalink_service_url": {
          "description": "QWC Permalink Service URL",
          "type": "string"
        },
        "internal_permalink_service_url": {
          "description": "Internal QWC Permalink Service URL",
          "type": "string"
        },
        "plotinfo_service_url": {
          "description": "PlotInfo Service URL",
          "type": "string"
        },
        "print_service_url": {
          "description": "QWC Print Service URL",
          "type": "string"
        },
        "proxy_service_url": {
          "description": "Proxy Service URL",
          "type": "string"
        },
        "search_data_service_url": {
          "description": "QWC Search Result Service URL",
          "type": "string"
        },
        "search_service_url": {
          "description": "QWC Search Service URL",
          "type": "string"
        },
        "show_restricted_themes": {
          "description": "Whether to insert placeholder items for restricted themes in themes.json",
          "type": "boolean"
        },
        "show_restricted_themes_whitelist": {
          "description": "Whitelist of restricted theme names to include in themes.json. If empty, all restricted themes are shown.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "redirect_restricted_themes_to_auth": {
          "description": "Whether to redirect to login on auth service if requesting a restricted theme in URL params",
          "type": "boolean"
        },
        "redirect_to_auth_if_no_permitted_themes": {
          "description": "Whether to redirect to login on auth service if no themes are permitted",
          "type": "boolean"
        },
        "user_info_fields": {
          "description": "List of user info fields to read from JWT identity",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "display_user_info_field": {
          "description": "User info field to display instead of username",
          "type": "string"
        },
        "auth_required": {
          "description": "Whether to enforce authentication before processing requests. Default: false",
          "type": "boolean"
        },
        "public_paths": {
          "description": "Optional: List of paths that will be accessible without a JWT identity, if auth_required is set.",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "qwc2_path",
        "ogc_service_url"
      ]
    },
    "resources": {
      "title": "Resources",
      "type": "object",
      "properties": {
        "qwc2_config": {
          "type": "object",
          "properties": {
            "restricted_viewer_tasks": {
              "description": "Restricted menu items",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "config": {
              "description": "QWC2 application configuration (config.json)",
              "type": "object"
            }
          },
          "required": [
            "config"
          ]
        },
        "qwc2_themes": {
          "description": "QWC2 themes configuration (themes.json)",
          "type": "object",
          "properties": {
            "themes": {
              "type": "object"
            }
          },
          "required": [
            "themes"
          ]
        }
      },
      "required": [
        "qwc2_config",
        "qwc2_themes"
      ]
    }
  },
  "required": [
    "service",
    "config",
    "resources"
  ]
}