Skip to content

Commit 931fb52

Browse files
gippyTC-MO
andauthored
fix: improved documentation for how to use datasets in output schema (#2215)
We have changed how the output schema is rendered so I have updated the documentation to make it clear and replaced the screenshot with a better one. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only changes that adjust examples and wording; no runtime or API behavior changes. > > **Overview** > Updates the output-schema docs to reflect the new Console rendering of dataset outputs: the dataset example now links to the full dataset (`/items`) instead of separate per-view URLs, and clarifies that adding a `view` query param only sets the default selected view. > > Simplifies the combined dataset/collection example (removing multiple dataset outputs/emojis), tweaks wording, and refreshes the referenced Output-tab screenshot. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 37153f0. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
1 parent 01e3995 commit 931fb52

2 files changed

Lines changed: 6 additions & 23 deletions

File tree

-12.7 KB
Loading

sources/platform/actors/development/actor_definition/output_schema/index.md

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -237,28 +237,8 @@ After you define `views` and `collections` in `dataset_schema.json` and `key_val
237237
"properties": {
238238
"overview": {
239239
"type": "string",
240-
"title": "Overview 🔎",
241-
"template": "{{links.apiDefaultDatasetUrl}}/items?view=overview"
242-
},
243-
"posts": {
244-
"type": "string",
245-
"title": "Posts ✉️",
246-
"template": "{{links.apiDefaultDatasetUrl}}/items?view=posts"
247-
},
248-
"author": {
249-
"type": "string",
250-
"title": "Authors 🧑‍🎤",
251-
"template": "{{links.apiDefaultDatasetUrl}}/items?view=author"
252-
},
253-
"music": {
254-
"type": "string",
255-
"title": "Music 🎶",
256-
"template": "{{links.apiDefaultDatasetUrl}}/items?view=music"
257-
},
258-
"video": {
259-
"type": "string",
260-
"title": "Video 🎞️",
261-
"template": "{{links.apiDefaultDatasetUrl}}/items?view=video"
240+
"title": "Results",
241+
"template": "{{links.apiDefaultDatasetUrl}}/items"
262242
},
263243
"subtitleFiles": {
264244
"type": "string",
@@ -274,7 +254,10 @@ After you define `views` and `collections` in `dataset_schema.json` and `key_val
274254
}
275255
```
276256

277-
The schema above defines five dataset outputs and two key-value store outputs. The dataset outputs link to views, and the key-value store output link to collections, both defined in their respective schema files.
257+
The schema above defines one dataset output and two key-value store outputs. The dataset output links to the entire dataset. In Apify Console, this displays as a table with a selector that lets users switch between views defined in the dataset schema. The key-value store outputs link to collections defined in
258+
the key-value store schema.
259+
260+
If you add a `view` parameter to the dataset URL template, users still see the entire dataset in Apify Console, but the specified view is selected by default.
278261

279262
When a user runs the Actor in the Console, the UI will look like this:
280263

0 commit comments

Comments
 (0)