Skip to content

Migration‐Guide‐ignoreHeader‐to‐withHeaders‐notice

Ignatios Stylianos Sarantidis edited this page Apr 15, 2026 · 2 revisions

Migration Guide: ignoreHeader --> withHeaders

Affects: Parameterized CSV scenarios | Deprecated in: v1.4.0 | Removed in: v1.4.1


What's changing and why

ignoreHeader had confusing double-negative logic (ignoreHeader: false to enable headers and ignoreHeader: true to skip the first line if the headers didn't have pipes | | ).
The new withHeaders field says exactly what it does, so easy to interpret and use.
To keep things clean, we've also added support for standard (non-piped) headers. The legacy piped syntax | | is now deprecated and will be removed in a future release.


Migration Steps

Step 1 — Search your scenario files (.json / .yaml) for ignoreHeader.

Step 2 — Replace using this mapping:

Remove Replace with If
"ignoreHeader": false "withHeaders": false First CSV row is data
"ignoreHeader": false "withHeaders": true First CSV row is a header with piped syntax | |
"ignoreHeader": true "withHeaders": true First CSV row is header without piped syntax | |

Step 3 — Verify your scenarios run as before.

No other changes needed for existing index-based params (${0}, ${1} etc.) — they are unaffected.


Using Named Parameters (new in v1.4.0)

Once migrated, you can reference external CSV columns by name instead of index:

"parameterized": {
    "withHeaders": true,
    "csvSource": "test-data/users.csv"
}

Then in your steps:

"url": "/users/${PARAM.username}",
"assertions": {
    "name": "${PARAM.fullname}",
    "id":   "(int)${PARAM.userid}"
}

Timeline

Version Status
v1.3.46 and below ignoreHeader only
v1.4.0 withHeaders introduced — ignoreHeader removed — migrate before upgrading - Piped syntax for headers deprecated (still works, logs a warning)
v1.4.1+ Piped syntax for headers removed — migrate before upgrading

Examples

❌ ignoreHeader will NOT work in v1.4.0+:

"parameterized": {
    "ignoreHeader": true, 
    "csvSource":[
        "USERID,     USERNAME,    ADDRESS,       USERNO,        ISADMIN",
        "octocat,    The Octocat, San Francisco, 583231,        false"
    ]
}

⚠️ The piped | | syntax will be deprecated in v1.4.0 and will ΝΟΤ work in v1.4.1+:

"parameterized": {
    "withHeaders": true, 
    "csvSource":[
        "|USERID|,   |USERNAME|,  |ADDRESS|,     |USERNO|,      |ISADMIN|",
        "octocat,    The Octocat, San Francisco, 583231,        false"
    ]
}

✅ The New Standard:

"parameterized": {
    "withHeaders": true, 
    "csvSource":[
        "USERID,     USERNAME,    ADDRESS,       USERNO,        ISADMIN",
        "octocat,    The Octocat, San Francisco, 583231,        false"
    ]
}

Notes:

  1. The same applies if the CSV is external.
  2. All users should set "withHeaders": true in their scenarios if the CSV has headers (whether the headers have pipes | | or not)

Need help?

Open an issue or start a Discussion if you run into any migration problems.

Blogs

Clone this wiki locally