Skip to content

Commit 2d338aa

Browse files
committed
CCM-14740: update answeroptions spec
1 parent 46966b3 commit 2d338aa

7 files changed

Lines changed: 2158 additions & 1069 deletions

File tree

package-lock.json

Lines changed: 2132 additions & 1020 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"devDependencies": {
2828
"@babel/core": "^7.25.2",
2929
"@babel/eslint-parser": "^7.25.1",
30-
"@redocly/cli": "^2.14.4",
30+
"@redocly/cli": "1.34.15",
3131
"eslint": "^8.57.1",
3232
"eslint-config-airbnb-base": "^15.0.0",
3333
"eslint-config-prettier": "^8.5.0",
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
type: object
2+
title: AnswerOption
3+
properties:
4+
code:
5+
type: string
6+
example: "Yes"
7+
description: |-
8+
This is the code that will be sent back to you in the callback when a recipient selects this option. It is for your reference to understand which option the recipient has selected. It is also the display value shown to the recipient.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
type: object
2+
optional: true
3+
description: |-
4+
The answer options for this message. These are channel specific.
5+
6+
If you provide answer options, then they will be presented to the receipient for reply options. These will then be sent back via the two-way messaging callback mechanism.
7+
8+
This feature needs to be enabled on your account and is subject to the relevant callback integration being completed.
9+
properties:
10+
NHSAPP:
11+
type: array
12+
minItems: 1
13+
maxItems: 6
14+
items:
15+
$ref: ./AnswerOption.yaml

specification/schemas/components/Message.yaml

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,7 @@ properties:
1616
type: object
1717
description: The personalisation keys and values for this message. These are linked to the routingPlanId provided and are agreed upon during [onboarding](#overview--onboarding).
1818
answerOptions:
19-
type: object
20-
optional: true
21-
description: |-
22-
The answer options for this message. These are channel specific.
23-
24-
If you provide answer options, then they will be presented to the receipient for reply options. These will then be sent back via the two-way messaging callback mechanism.
25-
26-
This feature needs to be enabled on your account and is subject to the relevant callback integration being completed.
27-
properties:
28-
type:
29-
$ref: ../enums/EnumAnswerOptionsType.yaml
30-
options:
31-
type: array
32-
items:
33-
type: object
34-
properties:
35-
code:
36-
description: |-
37-
This is the code that will be sent back to you in the callback when a recipient selects this option. It is for your reference to understand which option the recipient has selected. It is also the display value shown to the recipient.
38-
type: string
39-
example: Yes
19+
$ref: ./AnswerOptions.yaml
4020
required:
4121
- messageReference
4222
- recipient

specification/schemas/enums/EnumAnswerOptionsType.yaml

Lines changed: 0 additions & 6 deletions
This file was deleted.

specification/schemas/requests/CreateMessage.yaml

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,7 @@ properties:
4040
type: object
4141
description: "The personalisation keys and values for this message. These are linked to the routingPlanId provided and are agreed upon during [onboarding](#overview--onboarding)."
4242
answerOptions:
43-
type: object
44-
optional: true
45-
description: |-
46-
The answer options for this message. These are channel specific.
47-
48-
If you provide answer options, then they will be presented to the receipient for reply options. These will then be sent back via the two-way messaging callback mechanism.
49-
50-
This feature needs to be enabled on your account and is subject to the relevant callback integration being completed.
51-
properties:
52-
type:
53-
$ref: ../enums/EnumAnswerOptionsType.yaml
54-
options:
55-
type: array
56-
items:
57-
type: object
58-
properties:
59-
code:
60-
description: |-
61-
This is the code that will be sent back to you in the callback when a recipient selects this option. It is for your reference to understand which option the recipient has selected. It is also the display value shown to the recipient.
62-
type: string
63-
example: Yes
43+
$ref: ../components/AnswerOptions.yaml
6444
required:
6545
- type
6646
- attributes

0 commit comments

Comments
 (0)