docs: fix Actor definition and storage schema inconsistencies - #2868
Open
TC-MO wants to merge 3 commits into
Open
docs: fix Actor definition and storage schema inconsistencies#2868TC-MO wants to merge 3 commits into
TC-MO wants to merge 3 commits into
Conversation
TC-MO
added
documentation
Contributor
|
✅ Preview for this PR (commit |
TC-MO
marked this pull request as ready for review
August 12, 2026 06:54
szaganek
approved these changes
Aug 12, 2026
| | `changelog` | Optional | The path to the CHANGELOG file displayed in the Information tab of the Actor in Apify Console next to Readme. If not provided, the CHANGELOG at `.actor/CHANGELOG.md` or `CHANGELOG.md` is used, in this order of preference. Your Actor doesn't need to have a CHANGELOG but it is a good practice to keep it updated for published Actors. | | ||
| | `storages.dataset` | Optional | You can define the schema of the items in your dataset under the `storages.dataset` field. This can be either an embedded object or a path to a JSON schema file. [Read more](/storage/dataset-schema) about Actor dataset schemas. | | ||
| | `storages.datasets` | Optional | You can define multiple datasets for the Actor under the `storages.datasets` field. This can be an object containing embedded objects or paths to a JSON schema files. [Read more](/storage/dataset-schema/multiple-datasets) about multiple dataset schemas. | | ||
| | `storages.keyValueStore` | Optional | You can define key-value store collections under the `storages.keyValueStore` field. This can be either an embedded object or a path to a key-value store schema file. [Read more](/storage/key-value-store-schema) about Actor key-value store schemas. | |
Contributor
There was a problem hiding this comment.
What is this :D we shouldn't use this without a noun
Contributor
Author
There was a problem hiding this comment.
good point, I'll fix this one and the one I modeled it after on LOC89
Contributor
Author
There was a problem hiding this comment.
How about:
Suggested change
| | `storages.keyValueStore` | Optional | You can define key-value store collections under the `storages.keyValueStore` field. This can be either an embedded object or a path to a key-value store schema file. [Read more](/storage/key-value-store-schema) about Actor key-value store schemas. | | |
| | `storages.keyValueStore` | Optional | The `storages.keyValueStore` property defines the schema for the Actor's default key-value store. Set the property to an embedded key-value store schema object or a path to a key-value store schema file. [Read about Actor key-value store schemas](/storage/key-value-store-schema). | |
And similar construction for the storages.dataset & storages.datasets
| storages.dataset | Optional | The storages.dataset property defines the schema for the Actor's default dataset. Set the property to an embedded dataset schema object or a parth to a dataset schema file. Read about Actor dataset schemas. |
| storages.datasets | Optional | The storages.datasets property defines multiple datasets for the Actor. Set the property to an object that maps dataset aliases to embedded dataset schema objects or paths to dataset schema files. Read about multiple dataset schemas. |
Co-authored-by: Edyta <142720610+szaganek@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Correct Actor definition and storage schema references, and replace invalid Actor version examples with the supported
MAJOR.MINORformat.Closes #2688
Closes #2690
Closes #2691
Closes #2740