Skip to content

pdfshift: Update HttpState data property docs - #1352

Merged
josephjclark merged 3 commits into
release/nextfrom
fix/1343-pdfshift-state
Aug 29, 2025
Merged

josephjclark merged 3 commits into
release/nextfrom
fix/1343-pdfshift-state

Conversation

@hunterachieng

@hunterachieng hunterachieng commented Aug 28, 2025 •

Copy link
Copy Markdown
Contributor

Summary

Update HttpState data property docs

Fixes #1343

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

  • Code generation (copilot but not intellisense)
  • Learning or fact checking
  • Strategy / design
  • Optimisation / refactoring
  • Translation / spellchecking / doc gen
  • Other
  • I have not used AI

You can read more details in our
Responsible AI Policy

Review Checklist

Before merging, the reviewer should check the following items:

  • Does the PR do what it claims to do?
  • If this is a new adaptor, added the adaptor on marketing website ?
  • If this PR includes breaking changes, do we need to update any jobs in
    production? Is it safe to release?
  • Are there any unit tests?
  • Is there a changeset associated with this PR? Should there be? Note that
    dev only changes don't need a changeset.
  • Have you ticked a box under AI Usage?

Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Comment thread packages/pdfshift/src/Adaptor.js Outdated
* @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.

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

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?

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

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.

Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
@josephjclark
josephjclark changed the base branch from main to release/next August 29, 2025 15:59
@josephjclark
josephjclark merged commit 7e22767 into release/next Aug 29, 2025
1 of 2 checks passed
@josephjclark
josephjclark deleted the fix/1343-pdfshift-state branch August 29, 2025 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Closed

Development

Successfully merging this pull request may close these issues.

pdfShift: update state docs for data response

3 participants