eedm.collection-configuration-settings.v1.0.0.collection-configuration-settings.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Collection Configuration Settings",
  "description" : "The details for collection configuration values used for Ethos integration.",
  "version" : "1.0.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the collection configuration 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 collection configuration setting.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "The description of the collection configuration setting.",
      "type" : "string"
    },
    "ethos" : {
      "title" : "Ethos",
      "description" : "The Ethos property and resource(s) to which the collection configuration applies.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "resource" : {
            "title" : "Resource",
            "description" : "The Ethos resource to which the collection configuration applies.",
            "type" : "string",
            "minLength" : 1
          },
          "propertyName" : {
            "title" : "Property Name",
            "description" : "The Ethos property to which the collection configuration applies.",
            "type" : "string"
          }
        },
        "additionalProperties" : false,
        "required" : [ "resource" ]
      }
    },
    "sourceSettings" : {
      "title" : "Source Settings",
      "description" : "The source values for the configuration.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "title" : {
            "title" : "Title",
            "description" : "The source title for the configuration.",
            "type" : "string"
          },
          "value" : {
            "title" : "Value",
            "description" : "The source value for the configuration.",
            "type" : "string",
            "minLength" : 1
          }
        },
        "additionalProperties" : false,
        "required" : [ "value" ]
      }
    }
  },
  "required" : [ "id", "title", "ethos" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/collection-configuration-settings?criteria={\"ethos\":[{\"resource\":{$resource}}]}",
    "title" : "Ethos Resource",
    "description" : "The Ethos resource(s) to which the collection configuration applies.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "ethos" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "properties" : {
              "resource" : {
                "type" : "string"
              }
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "collection-configuration-settings.json#"
    }
  }, {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/collection-configuration-settings?criteria={\"ethos\":[{\"propertyName\":{$propertyName}}]}",
    "title" : "Ethos Property Name",
    "description" : "The Ethos property to which the collection configuration applies.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "ethos" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "properties" : {
              "propertyName" : {
                "type" : "string"
              }
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "collection-configuration-settings.json#"
    }
  } ]
}