model-usage.schema.json

{
    "meta:license": [
        "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$schema": "http://json-schema.org/draft-06/schema#",
    "$id": "https://ns.adobe.com/experience/offer-management/model-usage",
    "meta:abstract": false,
    "meta:extensible": true,
    "type": "object",
    "title": "Used XDM Models and Properties from those Models (deprecated)",
    "description": "ModelUsage is a type that is used as part of the EligibilityRules schema. It serves the purpose of extracting all usages of XDM models and their properties (fields in XDM language) from an expression stored in an Eligibility Rule. \nThose expressions are a JSON formatted representation of a Profile Query Language (PQL) expression. A Schema for the JSON serialization of a PQL expression is provided in https://ns.adobe.com/experience/offer-management/filter-expression \nThe information is factored out so that clients that cannot or don't want to parse and reason about the PQL/json syntax can still process aspects of the EligibilityRule. For instance, a client that wants to know what XDM data or objects are used as input values can quickly assemble that information or aggregare it over a number of Eligibility Rules that are applied at once.\n",
    "definitions": {
        "model-usage": {
            "type": "object",
            "title": "Model and Used Properties",
            "description": "A key-value pair whose key is reference to the model, i.e. the model's $id property. The value is an array of strings, each string representing a fully qualified path to an XDM field with dots used as the path delimiter.",
            "properties": {
                "xdm:modelReference": {
                    "type": "string",
                    "format": "uri",
                    "description": "Reference to the model, i.e. its schema $id property. ",
                    "meta:descriptionId": "model-usage##xdm:modelReference##description##88601"
                },
                "xdm:modelPropertyPaths": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "description": "A fully qualified JSON path to an XDM field with dots used as the path delimiter.",
                        "meta:descriptionId": "model-usage##items##description##40101"
                    }
                }
            },
            "meta:titleId": "model-usage##model-usage##title##6691",
            "meta:descriptionId": "model-usage##model-usage##description##21901"
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/model-usage"
        },
        {
            "required": [
                "xdm:modelReference",
                "xdm:modelPropertyPaths"
            ]
        }
    ],
    "meta:status": "deprecated",
    "meta:titleId": "model-usage##title##61161",
    "meta:descriptionId": "model-usage##description##37971"
}