Skip to content

CCM-10077 Relax api contact details validation #940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ian-Hodges merged 19 commits into from
May 30, 2025
Merged

CCM-10077 Relax api contact details validation #940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0273846
Merge pull request #924 from NHSDigital/release
m-salaudeen Apr 11, 2025
4847a42
Merge pull request #933 from NHSDigital/release
Ian-Hodges Apr 24, 2025
cd61bd4
Merge pull request #937 from NHSDigital/release
ClareJonesBJSS May 9, 2025
0a6e2cd
CCM-10077: repoint to de-iaho3 backend
Ian-Hodges May 20, 2025
12f6597
CCM-10077: repoint to de-iaho3 backend
Ian-Hodges May 20, 2025
5cfb9a0
CCM-10077: update sandbox and unit tests
Ian-Hodges May 20, 2025
fe85ade
CCM-10077: update e2e tests
Ian-Hodges May 20, 2025
8608d10
CCM-10077: remove too few address lines test
Ian-Hodges May 21, 2025
1d26214
CCM-10077: put ERROR_TOO_FEW_ITEMS constant back
Ian-Hodges May 21, 2025
a98a594
CCM-10077: revert repoint to de-iaho3 backend
Ian-Hodges May 21, 2025
775b8bc
CCM-10077: update and add tests
Ian-Hodges May 27, 2025
48bdeca
CCM-10077: update specification document
Ian-Hodges May 27, 2025
26a8287
CCM-10077: repoint to de-iaho3 backend
Ian-Hodges May 27, 2025
1e3f40a
CCM-10077: fix tests
Ian-Hodges May 27, 2025
b672521
CCM-10077: revert repoint to de-iaho3 backend
Ian-Hodges May 27, 2025
fd22cd3
CCM-10077: clean up tests
Ian-Hodges May 28, 2025
eefb358
CCM-10077: repoint to de-iaho3 backend
Ian-Hodges May 27, 2025
20cba47
CCM-10077: fix tests
Ian-Hodges May 28, 2025
b1a803f
CCM-10077: revert repoint to de-iaho3 backend
Ian-Hodges May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 43 additions & 43 deletions docs/tests/post_v1_message-batches/validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ Below is a table showing the required attributes and their locations as seen in
| nhsNumber | /data/attributes/messages/0/recipient/nhsNumber |


## Scenario: An API consumer submitting a request with an invalid address postcode receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string array address lines receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { sms: value, email: value, address: { lines: [], postcode: value } }
A valid address lines contact detail must be structured in this format: { address: { lines: Value } } where Value is a string array

**Given** the API consumer provides an message body with an invalid postcode
**Given** the API consumer provides a message body with a non-string array address lines
<br/>
**When** the request is submitted
<br/>
Expand All @@ -48,34 +48,34 @@ A valid contact detail must be structured in this format: { sms: value, email: v
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|-----------|------------------------------------------------|
| LS1 6AECD | Used to ensure only valid postcode is accepted |
| Value | Description |
|---------|--------------------------------------------------------------|
| [1,2] | Used to ensure only a string array address lines is accepted |


## Scenario: An API consumer submitting a request with invalid address lines (too few) receives a 400 ‘Too few items’ response
## Scenario: An API consumer submitting a request with a non-string address postcode receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { address: { lines: [ Value1, Value2 ], postcode: value } }
A valid address postcode contact detail must be structured in this format: { address: { postcode: Value } } where Value is a string

**Given** the API consumer provides an message body with with too few address lines
**Given** the API consumer provides a message body with a non-string address postcode
<br/>
**When** the request is submitted
<br/>
**Then** the response returns a 400 too few items error
**Then** the response returns a 400 invalid value error
<br/>

**Asserts**
- Response returns a 400 ‘Too few items’ error
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|---------|-----------------------------------------------------------|
| [ “1” ] | Used to ensure list of less than 2 values is not accepted |
| [] | Used to ensure only a string address postcode is accepted |


## Scenario: An API consumer submitting a request with invalid address lines (too many) receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { address: { lines: [ Value1, Value2 ], postcode: value } }
A valid contact detail must be structured in this format: { address: { lines: [ Value1, Value2 ], postcode: Value } }

**Given** the API consumer provides an message body with with too many address lines
<br/>
Expand All @@ -93,11 +93,11 @@ A valid contact detail must be structured in this format: { address: { lines: [
| [ “1”, “2”, “3”, “4”, “5”, “6” ] | Used to ensure list of more than 5 values is not accepted |


## Scenario: An API consumer submitting a request with an invalid email receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string email address receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { email: Value }
A valid email contact detail must be structured in this format: { email: Value } where Value is a string

**Given** the API consumer provides an message body with an invalid email address
**Given** the API consumer provides a message body with a non-string email address
<br/>
**When** the request is submitted
<br/>
Expand All @@ -108,16 +108,16 @@ A valid contact detail must be structured in this format: { email: Value }
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|---------------------|------------------------------------------------------|
| invalidEmailAddress | Used to ensure invalid email address is not accepted |
| Value | Description |
|---------|--------------------------------------------------------|
| [] | Used to ensure only a string email address is accepted |


## Scenario: An API consumer submitting a request with an invalid email receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string email address receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { email: Value }
A valid email contact detail must be structured in this format: { email: Value } where Value is a string

**Given** the API consumer provides an message body with an invalid email address
**Given** the API consumer provides a message body with a non-string email address
<br/>
**When** the request is submitted
<br/>
Expand All @@ -128,16 +128,16 @@ A valid contact detail must be structured in this format: { email: Value }
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|---------------------|------------------------------------------------------|
| invalidEmailAddress | Used to ensure invalid email address is not accepted |
| Value | Description |
|---------|--------------------------------------------------------|
| [] | Used to ensure only a string email address is accepted |


## Scenario: An API consumer submitting a request with an invalid sms receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string sms receives a 400 ‘Invalid Value’ response

A valid sms contact detail must be structured in this format: { sms: value }
A valid sms contact detail must be structured in this format: { sms: Value } where Value is a string

**Given** the API consumer provides an message body with an invalid sms
**Given** the API consumer provides a message body with a non-string sms
<br/>
**When** the request is submitted
<br/>
Expand All @@ -148,16 +148,16 @@ A valid sms contact detail must be structured in this format: { sms: value }
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|--------------|-----------------------------------------------------|
| 077009000021 | Used to ensure invalid phone number is not accepted |
| Value | Description |
|---------|-------------------------------------------------------|
| [] | Used to ensure only a string phone number is accepted |


## Scenario: An API consumer submitting a request with an invalid sms receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string sms receives a 400 ‘Invalid Value’ response

A valid sms contact detail must be structured in this format: { sms: value }
A valid sms contact detail must be structured in this format: { sms: Value } where Value is a string

**Given** the API consumer provides an message body with an invalid sms
**Given** the API consumer provides a message body with a non-string sms
<br/>
**When** the request is submitted
<br/>
Expand All @@ -168,9 +168,9 @@ A valid sms contact detail must be structured in this format: { sms: value }
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|--------------|-----------------------------------------------------|
| 077009000021 | Used to ensure invalid phone number is not accepted |
| Value | Description |
|---------|-------------------------------------------------------|
| [] | Used to ensure only a string phone number is accepted |


## Scenario: An API consumer submitting a request with an contact details when not allowed receives a 400 ‘Cannot set contact details’ response
Expand Down Expand Up @@ -281,9 +281,9 @@ An NHS Number is a 10 digit number used to identify patients, for more informati
- Response returns the expected error message body with references to the invalid attribute


## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid value’ response
## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid Value’ response

A valid personalisation must be structured in this format: { parameter: value }
A valid personalisation must be structured in this format: { parameter: Value }

**Given** the API consumer provides a message body with an invalid personalisation
<br/>
Expand All @@ -293,7 +293,7 @@ A valid personalisation must be structured in this format: { parameter: value }
<br/>

**Asserts**
- Response returns a 400 ‘Invalid value’ error
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
Expand Down Expand Up @@ -364,9 +364,9 @@ Below is a table showing the required attributes and their locations as seen in
| nhsNumber | /data/attributes/messages/0/recipient/nhsNumber |


## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid value’ response
## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid Value’ response

A valid personalisation must be structured in this format: { parameter: value }
A valid personalisation must be structured in this format: { parameter: Value }

**Given** the API consumer provides a message body with an invalid personalisation
<br/>
Expand All @@ -376,7 +376,7 @@ A valid personalisation must be structured in this format: { parameter: value }
<br/>

**Asserts**
- Response returns a 400 ‘Invalid value’ error
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
Expand Down
70 changes: 25 additions & 45 deletions docs/tests/post_v1_single-message/validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Validation Tests


## Scenario: An API consumer submitting a request with an invalid address postcode receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string array address lines receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { sms: value, email: value, address: { lines: [], postcode: value } }
A valid address lines contact detail must be structured in this format: { address: { lines: Value } } where Value is a string array

**Given** the API consumer provides an message body with an invalid postcode
**Given** the API consumer provides a message body with a non-string array address lines
<br/>
**When** the request is submitted
<br/>
Expand All @@ -16,34 +16,14 @@ A valid contact detail must be structured in this format: { sms: value, email: v
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|-----------|------------------------------------------------|
| LS1 6AECD | Used to ensure only valid postcode is accepted |


## Scenario: An API consumer submitting a request with invalid address lines (too few) receives a 400 ‘Too few items’ response

A valid contact detail must be structured in this format: { address: { lines: [ Value1, Value2 ], postcode: value } }

**Given** the API consumer provides an message body with with too few address lines
<br/>
**When** the request is submitted
<br/>
**Then** the response returns a 400 too few items error
<br/>

**Asserts**
- Response returns a 400 ‘Too few items’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|---------|-----------------------------------------------------------|
| [ “1” ] | Used to ensure list of less than 2 values is not accepted |
| Value | Description |
|---------|--------------------------------------------------------------|
| [1,2] | Used to ensure only a string array address lines is accepted |


## Scenario: An API consumer submitting a request with invalid address lines (too many) receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { address: { lines: [ Value1, Value2 ], postcode: value } }
A valid contact detail must be structured in this format: { address: { lines: [ Value1, Value2 ], postcode: Value } }

**Given** the API consumer provides an message body with with too many address lines
<br/>
Expand All @@ -61,11 +41,11 @@ A valid contact detail must be structured in this format: { address: { lines: [
| [ “1”, “2”, “3”, “4”, “5”, “6” ] | Used to ensure list of more than 5 values is not accepted |


## Scenario: An API consumer submitting a request with an invalid email receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string email address receives a 400 ‘Invalid Value’ response

A valid contact detail must be structured in this format: { email: Value }
A valid email contact detail must be structured in this format: { email: Value } where Value is a string

**Given** the API consumer provides an message body with an invalid email address
**Given** the API consumer provides a message body with a non-string email address
<br/>
**When** the request is submitted
<br/>
Expand All @@ -76,16 +56,16 @@ A valid contact detail must be structured in this format: { email: Value }
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|---------------------|------------------------------------------------------|
| invalidEmailAddress | Used to ensure invalid email address is not accepted |
| Value | Description |
|---------|--------------------------------------------------------|
| [] | Used to ensure only a string email address is accepted |


## Scenario: An API consumer submitting a request with an invalid sms receives a 400 ‘Invalid Value’ response
## Scenario: An API consumer submitting a request with a non-string sms receives a 400 ‘Invalid Value’ response

A valid sms contact detail must be structured in this format: { sms: value }
A valid sms contact detail must be structured in this format: { sms: Value } where Value is a string

**Given** the API consumer provides an message body with an invalid sms
**Given** the API consumer provides a message body with a non-string sms
<br/>
**When** the request is submitted
<br/>
Expand All @@ -96,9 +76,9 @@ A valid sms contact detail must be structured in this format: { sms: value }
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
|--------------|-----------------------------------------------------|
| 077009000021 | Used to ensure invalid phone number is not accepted |
| Value | Description |
|---------|-------------------------------------------------------|
| [] | Used to ensure only a string phone number is accepted |


## Scenario: An API consumer submitting a request with an contact details when not allowed receives a 400 ‘Cannot set contact details’ response
Expand Down Expand Up @@ -192,9 +172,9 @@ An NHS Number is a 10 digit number used to identify patients, for more informati
- Response returns the expected error message body with references to the invalid attribute


## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid value’ response
## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid Value’ response

A valid personalisation must be structured in this format: { parameter: value }
A valid personalisation must be structured in this format: { parameter: Value }

**Given** the API consumer provides a message body with an invalid personalisation
<br/>
Expand All @@ -204,7 +184,7 @@ A valid personalisation must be structured in this format: { parameter: value }
<br/>

**Asserts**
- Response returns a 400 ‘Invalid value’ error
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
Expand Down Expand Up @@ -259,9 +239,9 @@ Below is a table showing the required attributes and their locations as seen in
| nhsNumber | /data/attributes/recipient/nhsNumber |


## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid value’ response
## Scenario: An API consumer submitting a request with an invalid personalisation receives a 400 ‘Invalid Value’ response

A valid personalisation must be structured in this format: { parameter: value }
A valid personalisation must be structured in this format: { parameter: Value }

**Given** the API consumer provides a message body with an invalid personalisation
<br/>
Expand All @@ -271,7 +251,7 @@ A valid personalisation must be structured in this format: { parameter: value }
<br/>

**Asserts**
- Response returns a 400 ‘Invalid value’ error
- Response returns a 400 ‘Invalid Value’ error
- Response returns the expected error message body with references to the invalid attribute

| Value | Description |
Expand Down
Loading