Skip to content

fix(fleetops): assert document responses as documents, not JSON #46

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
roncodes merged 1 commit into from
Aug 12, 2026
Merged

fix(fleetops): assert document responses as documents, not JSON #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 18 additions & 8 deletions postman/collections/Fleetbase API/.resources/definition.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,26 @@ variables:
scripts:
- type: http:afterResponse
code: |
// Check request method and perform appropriate tests
if (pm.request.method === "POST") {
pm.test(`Successful ${pm.info.requestName} request`, function () {
pm.expect(pm.response.code).to.be.oneOf([200, 201, 202]);
pm.expect(pm.response).to.be.withBody;
pm.expect(pm.response).to.be.json;
// Some endpoints answer with a document rather than JSON — Labels/Render Label
// streams a PDF. Asserting `to.be.json` on those fails on the first byte
// ("Unexpected token '%'" is %PDF), which says nothing useful about the endpoint.
//
// Detected by content type rather than by request name, so a new document endpoint
// is covered without another exception, and a JSON endpoint that unexpectedly
// started returning a document would still be caught.
const contentType = pm.response.headers.get('Content-Type') || '';
const isDocument = /^(application\/pdf|image\/|application\/octet-stream|text\/csv)/i.test(contentType);
const expected = pm.request.method === "POST" ? [200, 201, 202] : [200, 201, 202, 204];

if (isDocument) {
// Still asserted, not excused: a document response must carry actual bytes.
pm.test(`Successful ${pm.info.requestName} request returns a document body`, function () {
pm.expect(pm.response.code, `got HTTP ${pm.response.code}`).to.be.oneOf(expected);
pm.expect(pm.response.responseSize, 'document response is empty').to.be.above(0);
});
} else if (pm.request.method != "POST") {
} else {
pm.test(`Successful ${pm.info.requestName} request and response must be valid and have a body`, function () {
pm.expect(pm.response.code, `got HTTP ${pm.response.code}`).to.be.oneOf([200, 201, 202, 204]);
pm.expect(pm.response.code, `got HTTP ${pm.response.code}`).to.be.oneOf(expected);
pm.expect(pm.response).to.be.withBody;
pm.expect(pm.response).to.be.json;
});
Expand Down
Loading