docs: add missing title and description properties to DatasetSchema object definition #2691#2703
Open
askoldts wants to merge 2 commits into
Open
docs: add missing title and description properties to DatasetSchema object definition #2691#2703askoldts wants to merge 2 commits into
askoldts wants to merge 2 commits into
Conversation
…bject definition Fixes apify#2691 The DatasetSchema object definition table was missing the `title` and `description` properties that are used in examples (e.g., Academy tutorial with Zappos Scraper). These properties are valid and supported, but were not documented in the reference table. Added: - `title` (string, optional): Human-readable title for the dataset - `description` (string, optional): Description providing additional context These properties appear in the Output tab UI and API responses. Co-authored-by: Cursor <cursoragent@cursor.com>
…ions Remove redundant information about UI and API display locations from property descriptions. Co-authored-by: Cursor <cursoragent@cursor.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
2 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.
Summary
Fixes #2691
Adds the missing
titleanddescriptionproperties to the DatasetSchema object definition table.Changes
title(string, optional): Human-readable title for the datasetdescription(string, optional): Description providing additional contextThese properties were being used in examples (e.g., Academy tutorial with Zappos Scraper) but were not documented in the reference table.
Testing
Tested with a live Actor deployment to verify both properties are: