app-system/appActionEndpointSchema.json at master · shopwareArchive/app-system · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "source": {
            "type": "object",
            "properties": {
                "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "Shop url"
                },
                "appVersion": {
                    "type": "string",
                    "pattern": "^[0-9]+\\.[0-9]\\.[0-9]+$",
                    "description": "App version of the shop"
                },
                "shopId": {
                    "type": "string",
                    "description": "The unique identifier of the shop triggering the action"
                }
            },
            "required": ["url","appVersion", "shopId"]
        },
        "data": {
            "type": "object",
            "properties": {
                "ids" : {
                    "type": "array",
                    "minItems": 0,
                    "items": {
                        "$ref": "#/definitions/uuidv4"
                    },
                    "description": "The ids selected by the user"
                },
                "entity": {
                    "type": "string",
                    "description": "The name of the affected entity"
                },
                "action": {
                    "type": "string",
                    "description": "The technical action name"
                }
            },
            "required": ["ids", "entity", "action"]
        },
        "meta": {
            "type": "object",
            "properties": {
                "timestamp": {
                    "type": "integer",
                    "description": "The moment the action was sent"
                },
                "reference": {
                    "type": "string",
                    "description": "A reference id to track and debug actions"
                },
                "language": {
                    "type": "string",
                    "$ref": "#/definitions/uuidv4",
                    "description": "The languageId that should be used to fetch and write data"
                }
            },
            "required": ["timestamp", "reference"]
        }
    },
    "required": ["source","data","meta"],
    "definitions": {
        "uuidv4": {
            "type": "string",
            "maxLength": 32,
            "minLength": 32,
            "pattern": "^[0-9a-f]{32}$"
        }
    }
}