Skip to content

pdfshift: Update HttpState data property docs #1352

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
josephjclark merged 3 commits into from
Aug 29, 2025
+7 −2
Merged

pdfshift: Update HttpState data property docs #1352

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6433b63
feat: update state docs
hunterachieng Aug 28, 2025
1b125e8
feat: add changeset
hunterachieng Aug 28, 2025
0571bc0
fix: update return state docs
hunterachieng Aug 29, 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
5 changes: 5 additions & 0 deletions .changeset/good-mugs-invite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@openfn/language-pdfshift': patch
---

Update `HttpState` data property docs
8 changes: 4 additions & 4 deletions packages/pdfshift/src/Adaptor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { expandReferences, encode } from '@openfn/language-common/util';
import { expandReferences } from '@openfn/language-common/util';
import * as util from './Utils';

/**
* State object
* @typedef {Object} HttpState
* @property data - the parsed response body
* @property response - the response from the HTTP server, including headers, statusCode, body, etc
* @property references - an array of all previous data objects used in the Job
* @property data - The parsed response body when `filename` is provided, otherwise a base64-encoded string.

@josephjclark josephjclark Aug 29, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs to go just on the generatePDF docs - not the general state docs. Because it doesn't really make sense on the generic request helper

@hunterachieng hunterachieng Aug 29, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@josephjclark In the docs repo?

@josephjclark josephjclark Aug 29, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, here. Do it on the function as an override

@hunterachieng hunterachieng Aug 29, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@josephjclark done

* @property response - The response from the HTTP server, including headers, statusCode, body, etc
* @property references - An array of all previous data objects used in the Job
**/

/**
Expand Down