docs: Custom error messages in the input schema #2121
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
mfori
added
the
t-console
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
marcel-rbro
requested changes
Dec 1, 2025
Contributor
marcel-rbro
left a comment
marcel-rbro
left a comment
There was a problem hiding this comment.
Well written and structured. I like that the beginning of the page is very readable. I am not sure about the last section though.
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Show resolved
Hide resolved
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Outdated
Show resolved
Hide resolved
Comment on lines
103
to
112
| ## Best practices | ||
|
|
||
| While custom error messages can improve the user experience by providing clearer guidance, it's generally better to rely on the default error messages unless there's a specific need for customization. Only use custom error messages when they significantly help users understand the requirements better than the default messages. | ||
|
|
||
| If you do decide to use custom error messages, follow these best practices: | ||
|
|
||
| 1. **Be specific** - Clearly explain what is required or what went wrong | ||
| 2. **Be concise** - Keep messages short and to the point | ||
| 3. **Be helpful** - Provide guidance on how to fix the issue | ||
| 4. **Be consistent** - Use a similar tone and style across all messages |
Contributor
There was a problem hiding this comment.
I am not sure about this entire section. Do we want to be the source of information about how to write error messages? @TC-MO
Contributor
There was a problem hiding this comment.
Good question tbh. It feels like this is better suited for Academy then our Platform docs, let me think a bit on that. Apart from that:
- Bold is for UI elements. (at least for now), so it should be either italics, or no emphasis whatsoever.
- Ordered lists should be done with all 1. since Docusaurus can handle then the numbering while rendering the page and maintenance is much easier
sources/platform/actors/development/actor_definition/input_schema/custom_error_messages.md
Show resolved
Hide resolved
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.
Document custom error messages in the input schema, introduced by apify/apify-shared-js#567 (based on the specification here)
Note
Documents custom validation error messages for input schema and links them from the spec and index.
input_schema/custom_error_messages.mdexplainingerrorMessageusage, supported validation keywords, nesting, and best practices.input_schema/specification.mdto includeerrorMessagein input field properties table with link to the new page.input_schema/index.mdto reference the spec, secrets, and new custom error messages guide.Written by Cursor Bugbot for commit 19d0412. Configure here.