Skip to content

Conversation

@ShivaReddyVanja
Copy link
Contributor

@ShivaReddyVanja ShivaReddyVanja commented Jan 14, 2026

Fixed documentation examples to use correct 'data' field instead of 'output' for the waitpoint token completion endpoint.

The API schema expects 'data' in the request body, but all code examples (curl, Python, Ruby, Go) incorrectly showed 'output', causing waitpoints to complete with empty/undefined output when users followed the docs.

Fixes #2872

Closes #

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the code works

Testing

[Describe the steps you took to test this change]
This is simple doc fix

Changelog

[Short description of what has changed]
Documentation example for the specific api route had a wrong field, fixed that to have correct field


Screenshots

[Screenshots]
Screenshot 2026-01-14 at 10 49 50 PM
The above image shows the correct request format, but docs previously had incorrect payload.
Screenshot 2026-01-14 at 11 24 01 PM
This is the exact wrong field in docs, that was fixed https://trigger.dev/docs/wait-for-token#from-another-language

💯

Fixed documentation examples to use correct 'data' field instead of
'output' for the waitpoint token completion endpoint.

The API schema expects 'data' in the request body, but all code examples
(curl, Python, Ruby, Go) incorrectly showed 'output', causing waitpoints
to complete with empty/undefined output when users followed the docs.

Fixes triggerdotdev#2872
@changeset-bot
Copy link

changeset-bot bot commented Jan 14, 2026

⚠️ No Changeset found

Latest commit: 4d36d20

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 14, 2026

Walkthrough

This pull request updates documentation examples in a single file by changing HTTP payload field names from "output" to "data" across multiple language code samples. The modifications appear consistently in curl, Python requests, Ruby, Go, and JavaScript/TypeScript examples. The change affects only the documented payload structure with no alterations to control flow, logic, or higher-level behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: fixing documentation examples to use the correct 'data' field instead of 'output' for the waitpoint token completion endpoint.
Linked Issues check ✅ Passed The PR directly addresses issue #2872 by fixing all code examples (curl, Python, Ruby, Go) to use the correct 'data' field as specified in the API schema, resolving the reported documentation error.
Out of Scope Changes check ✅ Passed All changes are strictly within scope: only documentation examples in docs/wait-for-token.mdx were updated to correct the field name, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description follows the template structure with all major sections completed including issue reference, checklist items marked, testing notes, changelog, and screenshots demonstrating the fix.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ShivaReddyVanja
Copy link
Contributor Author

@ericallam can you look into this really quick.

@nicktrn nicktrn merged commit 4dc504d into triggerdotdev:main Jan 14, 2026
1 check passed
@vibe-kanban-cloud
Copy link

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug: Documentation error: API endpoint uses data field, not output for completing waitpoint tokens

3 participants