@viewdo/dxp-story-cli
Version:
DXP Story Management CLI
65 lines (63 loc) • 2.11 kB
JSON
{
"$schema": "http://json-schema.org/draft-07/schema#",
"defaultProperties": [],
"definitions": {
"Record<string,any>": {
"defaultProperties": [],
"type": "object"
}
},
"description": "DXP PREVIEW CONFIG:\n-----------------------------------------------------\nThis file defines configurable experience settings while previewing this story.",
"properties": {
"apiVersion": {
"default": "xapi.view.do/v1",
"description": "API version, model location (read-only)",
"type": "string"
},
"childEntityKey": {
"default": null,
"description": "Change the child-entity type here to render specific entities.",
"type": "string"
},
"data": {
"$ref": "#/definitions/Record<string,any>",
"description": "This is the data that will be used while previewing this experience."
},
"events": {
"description": "You can add pre-fired events here, to see how the experience can look different after fired.",
"items": {
"type": "string"
},
"type": "array"
},
"key": {
"default": "fake-xid",
"description": "The pretend key for this model in the DXP platform",
"pattern": "^[A-Za-z0-9-$]{1,16}$",
"type": "string"
},
"kind": {
"default": "Experience",
"description": "DXP model-type (read-only)",
"type": "string"
},
"milestone": {
"description": "To see an experience after a milestone has already been reached.",
"type": "string"
},
"progress": {
"type": "string"
},
"user": {
"$ref": "#/definitions/Record<string,any>",
"description": "The user model, if we need to preview user data rendering."
}
},
"required": [
"apiVersion",
"data",
"key",
"kind"
],
"type": "object"
}