Skip to content

Commit 78139bf

Browse files
committed
docs: Improve prefill documentation
1 parent ef01c35 commit 78139bf

File tree

1 file changed

+2
-2
lines changed
  • sources/platform/actors/development/actor_definition/input_schema

1 file changed

+2
-2
lines changed

sources/platform/actors/development/actor_definition/input_schema/specification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,13 @@ Each field of your input is described under its key in the `inputSchema.properti
132132

133133
Here is a rule of thumb for whether an input field should have a `prefill`, `default`, or be required:
134134

135-
- **Prefill** - Use for fields that don't have a reasonable default. The provided value is prefilled for the user to show them an example of using the field and to make it easy to test the Actor (e.g., search keyword, start URLs). In other words, this field is only used in the user interface but does not affect the Actor functionality and API.
135+
- **Prefill** - Use for fields that don't have a reasonable default. The provided value is prefilled for the user to show them an example of using the field and to make it easy to test the Actor (e.g., search keyword, start URLs). In other words, this field is only used in the user interface but does not affect the Actor functionality and API. Note that if you add a new input option to your Actor, the Prefill value won't be used - the Default will (if specified).
136136
- **Required** - Use for fields that don't have a reasonable default and MUST be entered by the user (e.g., API token, password).
137137
- **Default** - Use for fields that MUST be set for the Actor run to some value, but where you don't need the user to change the default behavior (e.g., max pages to crawl, proxy settings).
138138
If the user omits the value when starting the Actor via any means (API, CLI, scheduler, or user interface), the platform automatically passes the Actor this default value.
139139
- **No particular setting** - Use for purely optional fields where it makes no sense to prefill any value (e.g., flags like debug mode or download files).
140140

141-
In summary, you can use each option independently or use a combination of **Prefill + Required**, but the combinations **Prefill + Default** or **Default + Required** don't make sense to use.
141+
In summary, you can use each option independently or use a combination of **Prefill + Required** or **Prefill + Default** (for example to maintain backward compatibility when introducing a new flag or feature), but the combinations of **Default + Required** doesn't make sense to use.
142142

143143

144144
## Additional properties

0 commit comments

Comments
 (0)