It was unclear what name was doing when it was part of the "match" object and it made it difficult to add other fields to the object to match against.
urls doesn't lend itself to extending with more fields to match against. It also doesn't represent what it is doing, whereas matches is a helpful verb that makes it clearer to the user/reader of the API what its impact is.
By moving the name field one level up, and renaming urls to matches, we can now read this API:
What?
This change does two things:
name
field to the level above.urls
field tomatches
.So from:
to:
Why?
It was unclear what
name
was doing when it was part of the "match
" object and it made it difficult to add other fields to the object to match against.urls
doesn't lend itself to extending with more fields to match against. It also doesn't represent what it is doing, whereasmatches
is a helpful verb that makes it clearer to the user/reader of the API what its impact is.By moving the
name
field one level up, and renamingurls
tomatches
, we can now read this API:as:
Checklist
Related PR(s)/Issue(s)
Updates: https://github.com/grafana/xk6-browser/issues/1487