eedm.default-settings.v1.0.0.default-settings.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Default Settings",
  "description" : "The details for values to be used as defaults for Ethos.",
  "version" : "1.0.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the default setting.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "title" : {
      "title" : "Title",
      "description" : "The full name of the default setting.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "The description of the default setting.",
      "type" : "string"
    },
    "ethos" : {
      "title" : "Ethos",
      "description" : "The Ethos resource (and property) names to which the default settings pertain.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "resource" : {
            "title" : "Resource",
            "description" : "The Ethos resource name to which the default settings pertain.",
            "type" : "string",
            "minLength" : 1
          },
          "propertyName" : {
            "title" : "Property Name",
            "description" : "The Ethos property name to which the default settings pertain.",
            "type" : "string"
          }
        },
        "additionalProperties" : false,
        "required" : [ "resource" ]
      }
    },
    "source" : {
      "title" : "Source",
      "description" : "The source values to be used as a default.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "title" : {
            "title" : "Title",
            "description" : "The source title to be used as a default.",
            "type" : "string"
          },
          "value" : {
            "title" : "Value",
            "description" : "The source value to be used as a default.",
            "type" : "string",
            "minLength" : 1
          }
        },
        "additionalProperties" : false,
        "required" : [ "value" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "advancedSearch" : {
      "title" : "Advanced Search",
      "description" : "The advanced search details for large datasets.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "type" : {
            "title" : "Type",
            "description" : "The type of advanced search (advancedSearchAvailable or advancedSearchRequired).",
            "enum" : [ "advancedSearchAvailable", "advancedSearchRequired" ],
            "type" : "string"
          },
          "minSearchLength" : {
            "title" : "Min Search Length",
            "description" : "The minimum number of provided characters required to perform a search.",
            "type" : "number"
          }
        },
        "additionalProperties" : false,
        "required" : [ "type", "minSearchLength" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    }
  },
  "required" : [ "id", "title", "ethos" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/default-settings?criteria={\"ethos\":{\"resource\":$resource}}",
    "title" : "Ethos Resource",
    "description" : "The Ethos resource name to which the default settings pertain.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "ethos" : {
          "type" : "object",
          "properties" : {
            "resource" : {
              "type" : "string"
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "default-settings.json#"
    }
  }, {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/default-settings?criteria={\"ethos\":{\"propertyName\":$propertyName}}",
    "title" : "Ethos Property Name",
    "description" : "The Ethos property name to which the default settings pertain.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "ethos" : {
          "type" : "object",
          "properties" : {
            "propertyName" : {
              "type" : "string"
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "default-settings.json#"
    }
  } ]
}