Skip to content

docs: Add output schema support to actor.json documentation#2420

Open
jancurn wants to merge 1 commit intomasterfrom
claude/add-output-reference-AJFyJ
Open

docs: Add output schema support to actor.json documentation#2420
jancurn wants to merge 1 commit intomasterfrom
claude/add-output-reference-AJFyJ

Conversation

@jancurn
Copy link
Copy Markdown
Member

@jancurn jancurn commented Apr 10, 2026

Summary

This PR updates the actor definition documentation to include support for output schemas in the actor.json configuration file, bringing feature parity with input schema handling.

Key Changes

  • Added output field example to the actor.json sample configuration, showing the path to output_schema.json
  • Documented the new output field in the configuration reference table with:
    • Description of embedding output schema objects directly or providing a path to a custom schema
    • Link to output schema documentation
    • Note about the outputSchema alias for interchangeable use
  • Updated the input field documentation to mention the inputSchema alias for consistency

Implementation Details

The changes follow the same pattern established for input schemas, allowing developers to:

  • Embed output schema objects directly in actor.json
  • Reference external output schema files via path
  • Use either output or outputSchema field names interchangeably

This maintains consistency with the existing input schema functionality and provides clear guidance for Actor developers on defining output schemas.

https://claude.ai/code/session_018BErCouxp98K9bfkGAvCUw

…tor.json docs

The actor.json reference table was missing an entry for the `output` property
linking to the output schema page. Also documents that `inputSchema` and
`outputSchema` can be used interchangeably with `input` and `output`.

https://claude.ai/code/session_018BErCouxp98K9bfkGAvCUw
@jancurn jancurn requested a review from TC-MO as a code owner April 10, 2026 22:43
@jancurn jancurn changed the title Add output schema support to actor.json documentation docs: Add output schema support to actor.json documentation Apr 10, 2026
@apify-service-account
Copy link
Copy Markdown

Preview for this PR was built for commit 0f50dac and is ready at https://pr-2420.preview.docs.apify.com!

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.

3 participants