docs: Enhance output schema template property documentation #2197
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Improve the documentation for the `template` property in output schemas by expanding the property description and adding a comprehensive "Understanding templates" section that explains template processing, syntax, and where generated URLs appear. Changes: - Enhanced template property description with Mustache syntax details - Added "Understanding templates" section explaining: - How the platform processes templates (interpolation, generation, display) - Template syntax with concrete examples - Where templates appear (Console and API) Addresses feedback from GitHub issue #2165. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Fix bold usage to comply with Apify style guide by: - Remove bold from list items used for emphasis - Apply bold only to UI elements (Output tab) - Fix Apify Console terminology (remove "the") Following APIFY_STANDARDS.md text formatting standards where bold is used exclusively for UI elements, not for emphasis. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Change "Understanding templates" to "Understand templates" to follow Apify style guide requirement for simple present tense headings. Avoid gerund (-ing) forms in headings per APIFY_STANDARDS.md. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
marcel-rbro
commented
Jan 21, 2026
sources/platform/actors/development/actor_definition/output_schema/index.md
Outdated
Show resolved
Hide resolved
marcel-rbro
commented
Jan 21, 2026
sources/platform/actors/development/actor_definition/output_schema/index.md
Outdated
Show resolved
Hide resolved
- Remove "Mustache-style" from template syntax description - Lowercase "API Response" to "API response" for consistency Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
templateproperty description in the output schema documentationChanges
1. Enhanced Property Description
Updated the
templateproperty description in the "Output object definition" table to include:{{variable}}syntax2. New "Understanding Templates" Section
Added a comprehensive section between "Available template variables" and "Examples" that covers:
Context
Addresses feedback from GitHub issue #2165 where users requested better explanation of the
templateproperty.The enhancement maintains brevity while providing essential information that helps users understand template mechanics before seeing practical examples.
Related
templateoutput schema property in the guide #2165Test Plan
🤖 Generated with Claude Code
Note
Improves the output schema docs to better explain how URL templates work.
templateproperty description to note Mustache{{variable}}syntax and where generated URLs surface (Console Output tab and APIoutput)sources/platform/actors/development/actor_definition/output_schema/index.mdWritten by Cursor Bugbot for commit b6ce3dd. Configure here.