Skip to content

Commit c101e7d

Browse files
Update eligibility-signposting-api.yaml
Reverting to use a separate field for urlLabel (as requested by VitA) and updating some descriptions to confirm that GFM Markdown can be used
1 parent 7ae0448 commit c101e7d

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

specification/eligibility-signposting-api.yaml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ paths:
191191
description: Machine readable code signifying a rule that amended the status of the suggestion
192192
ruleText:
193193
type: string
194-
description: Human readable (render-able) text describing a rule that amended the status of the suggestion
194+
description: Human readable (render-able) text describing a rule that amended the status of the suggestion (optionally GFM Markdown)
195195
actions:
196196
type: array
197197
description: List of actions to be shown to the person.
@@ -206,11 +206,15 @@ paths:
206206
description: Code representing the action to be taken
207207
description:
208208
type: string
209-
description: A brief description of the step.
209+
description: Human readable (render-able) text describing the suggested action (optionally GFM Markdown)
210210
urlLink:
211211
type: string
212-
description: Label and URL to invoke if action selected (bar delimited).
213-
example: "My Link Label|https://mylink.mydomain.tld"
212+
description: URL to invoke if action selected.
213+
example: "https://mylink.mydomain.tld"
214+
urlLabel:
215+
type: string
216+
description: Lable to use for the URL (or button) used to display the link
217+
example: "My Link Label"
214218
examples:
215219
example_50000000001:
216220
summary: RSV - Actionable due to membership of an Age Cohort including suggested national booking action (actions requested)
@@ -230,7 +234,8 @@ paths:
230234
- actionType: "ButtonAuthLink"
231235
actionCode: "BookNBS"
232236
description: ""
233-
urlLink: "Continue to booking|http://www.nhs.uk/book-rsv"
237+
urlLink: "http://www.nhs.uk/book-rsv"
238+
urlLabel: "Continue to booking"
234239
example_50000000002:
235240
summary: RSV - Actionable due to membership of an Age Cohort including suggested action (not national booking)
236241
value:
@@ -282,7 +287,8 @@ paths:
282287
- actionType: "CardWithAuthButton"
283288
actionCode: "AmendNBS"
284289
description: "##You have an RSV vaccination appointment\nYou can view, change or cancel your appointment below."
285-
urlLink: "Manage your appointment|http://www.nhs.uk/book-rsv"
290+
urlLink: "http://www.nhs.uk/book-rsv"
291+
urlLabel: "Manage your appointment"
286292
example_50000000005:
287293
summary: RSV - Actionable due to membership of an Age Cohort including suggested actions (with future local booking)
288294
value:

0 commit comments

Comments
 (0)