UNPKG

@alexa/ask-expressions-spec

Version:

The JSON Schema specification for the Alexa Skills Kit Intermediate Representation (ASKIR).

125 lines (70 loc) • 4.61 kB
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# Untitled object in TypeDeclaration Schema ```txt https://amazonalexa.com/ask/2020/12/TypeDeclaration#/properties/properties/items ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------- | | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [TypeDeclaration.json\*](../../schemas/TypeDeclaration.json "open original schema") | ## items Type `object` ([Details](typedeclaration-properties-properties-items.md)) # items Properties | Property | Type | Required | Nullable | Defined by | | :-------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [name](#name) | `string` | Required | cannot be null | [TypeDeclaration](genericargumentsdeclaration-items-properties-name.md "https://amazonalexa.com/ask/2020/12/Name#/properties/properties/items/properties/name") | | [type](#type) | `object` | Required | cannot be null | [TypeDeclaration](actiondeclaration-properties-typereference.md "https://amazonalexa.com/ask/2020/12/TypeReference#/properties/properties/items/properties/type") | | [optional](#optional) | `boolean` | Optional | cannot be null | [TypeDeclaration](typedeclaration-properties-properties-items-properties-optional.md "https://amazonalexa.com/ask/2020/12/TypeDeclaration#/properties/properties/items/properties/optional") | | [annotations](#annotations) | `array` | Optional | cannot be null | [TypeDeclaration](typedeclaration-properties-properties-items-properties-annotations.md "https://amazonalexa.com/ask/2020/12/TypeDeclaration#/properties/properties/items/properties/annotations") | ## name A name. `name` * is required * Type: `string` ([Name](genericargumentsdeclaration-items-properties-name.md)) * cannot be null * defined in: [TypeDeclaration](genericargumentsdeclaration-items-properties-name.md "https://amazonalexa.com/ask/2020/12/Name#/properties/properties/items/properties/name") ### name Type `string` ([Name](genericargumentsdeclaration-items-properties-name.md)) ### name Constraints **pattern**: the string must match the following regular expression:  ```regexp ^[a-zA-Z_][a-zA-Z0-9_]*$ ``` [try pattern](https://regexr.com/?expression=%5E%5Ba-zA-Z_%5D%5Ba-zA-Z0-9_%5D*%24 "try regular expression with regexr.com") ### name Examples ```json "foo" ``` ```json "bar" ``` ```json "person" ``` ```json "foo1" ``` ## type The representation of a reference to a type declaration. `type` * is required * Type: `object` ([TypeReference](actiondeclaration-properties-typereference.md)) * cannot be null * defined in: [TypeDeclaration](actiondeclaration-properties-typereference.md "https://amazonalexa.com/ask/2020/12/TypeReference#/properties/properties/items/properties/type") ### type Type `object` ([TypeReference](actiondeclaration-properties-typereference.md)) ## optional Indicates whether the property is required in expressions of this type. `optional` * is optional * Type: `boolean` * cannot be null * defined in: [TypeDeclaration](typedeclaration-properties-properties-items-properties-optional.md "https://amazonalexa.com/ask/2020/12/TypeDeclaration#/properties/properties/items/properties/optional") ### optional Type `boolean` ## annotations `annotations` * is optional * Type: `object[]` ([Call](actiondeclaration-properties-annotations-call.md)) * cannot be null * defined in: [TypeDeclaration](typedeclaration-properties-properties-items-properties-annotations.md "https://amazonalexa.com/ask/2020/12/TypeDeclaration#/properties/properties/items/properties/annotations") ### annotations Type `object[]` ([Call](actiondeclaration-properties-annotations-call.md))