[SDPAP-7155] webform validation

[vincent-gao]

Jira

https://digital-vic.atlassian.net/browse/SDPAP-7155

Motivation

default webform JSONAPI endpoints don't support any validations, and it also doesn't support HTTP Unprocessable Content response with details of why the data validation failed.

Drupal JSONAPI also limits us from modifying the response structure or adding custom validations.

so we need a custom endpoint to handle data validation and return a reasonable response.

Change

1. defined a custom endpoint
   • api/v1/webform/tide_webform_content_rating/add
2. headers:
   • Content-Type: application/vnd.api+json
3. body example

       {
         "data": {
           "type": "webform_submission--tide_webform_content_rating",
           "attributes": {
             "remote_addr": "1.2.3.4",
             "data": "url: '/home'\nwas_this_page_helpful: 'Yes'\nemail_addr: 'asdfacom'\nphone_number: '045123'"
           }
         }
       }
   

4. support list
   • It supports verifying:
     • email
     • phone number
   • it supports verifying empty or unset fields that are required.
   • It supports Pattern

All form validations below will be reflected in JSONAPI webform endpoints, including Required message and Pattern message, but we don't support unique as we don't keep submissions in most cases.

Response

{
    "jsonapi": {
        "version": "1.0",
        "meta": {
            "links": {
                "self": {
                    "href": "http://jsonapi.org/format/1.0/"
                }
            }
        }
    },
    "errors": [
        {
            "title": "Unprocessable Entity",
            "status": "422",
            "detail": "email_addr|Field email_addr is required.",
            "links": {
                "via": {
                    "href": "http://content-sdp.docker.internal:8888/api/v1/webform/tide_webform_content_rating/add?XDEBUG_SESSION=PHPSTORM"
                }
            }
        },
        {
            "title": "Unprocessable Entity",
            "status": "422",
            "detail": "phone_number|Please provide a valid Phone number.",
            "links": {
                "via": {
                    "href": "http://content-sdp.docker.internal:8888/api/v1/webform/tide_webform_content_rating/add?XDEBUG_SESSION=PHPSTORM"
                }
            }
        }
    ]
}

[anthony-malkoun]

@vincent-gao for my understanding, this means validation is only supported for the was this page helpful webform? There's not a more generic way to get it into all forms or we have to write code each time?

[vincent-gao]

for my understanding, this means validation is only supported for the was this page helpful webform? There's not a more generic way to get it into all forms or we have to write code each time?

hey @anthony-malkoun , it supports all webforms. please take a look into https://github.com/dpc-sdp/tide_webform/pull/77/files#diff-c3e4a54bf03798e28f32ae99b7aa80077275b1e6e1a45cb049ebef34d3918513R2
, users can change {webform} with a webform_id