Skip to content

fix: Output schema (fix copy-paste mistakes) #2034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 22, 2025
Merged

fix: Output schema (fix copy-paste mistakes) #2034

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1d5b59
fix: Output schema (fix copy-paste mistakes) and containerUrl to cont…
jirispilka Oct 22, 2025
f88f485
fix: change `containerRunUrl` back to `containerUrl` and replace `lin…
jirispilka Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions sources/platform/actors/development/actor_definition/output_schema/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can organize the files using one of these structures:

## Definitions

The key-value store schema defines the collections of keys and their properties. It allows you to organize and validate data stored by the Actor, making it easier to manage and retrieve specific records.
The output schema defines the collections of keys and their properties. It allows you to organize and validate data stored by the Actor, making it easier to manage and retrieve specific records.

### Output schema object definition

Expand Down Expand Up @@ -139,7 +139,7 @@ Then to specify that output is stored in the default dataset, create `.actor/out
}
```

To show, that the output is stored in the default key-value store, the schema defines a property called `results`.
To show that the output is stored in the default dataset, the schema defines a property called `results`.

The `title` is a human-readable name for the output, shown in the Apify Console.

Expand Down Expand Up @@ -206,7 +206,7 @@ Then to specify that output is stored in the key-value store, update `.actor/out
}
```

To show, that the output is stored in the default key-value store, the schema defines a property called `files`.
To show that the output is stored in the default key-value store, the schema defines a property called `files`.

The `template` uses a variable `{{links.apiDefaultKeyValueStoreUrl}}`, which is replaced with the URL of the default key-value store API endpoints when the Actor run finishes.

Expand Down Expand Up @@ -297,7 +297,7 @@ The conversation history is then stored in the dataset.
"clientUrl": {
"type": "string",
"title": "Chat client",
"template": "{{run.containerUrl}}"
"template": "{{run.containerRunUrl}}"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Template Variable References Incorrect Object

The template variable {{run.containerRunUrl}} references an incorrect object. Documentation shows {{links.containerRunUrl}} for container URLs, and the run object only contains defaultDatasetId and defaultKeyValueStoreId. This could prevent the template from resolving as expected.

Fix in Cursor Fix in Web

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ops, now looking at it again, I'm not sure what is the correct property, @gippy please correct me here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use either run.containerUrl or links.containerRunUrl.
Both are mentioned in the docs and I think it's confusing, we should unify it.

The links.containerRunUrl is mentioned in the available variables here which is what Cursor picked up here I think.
The run.containerUrl is on the other hand mentioned in the example here

Copy link
Member

@gippy gippy Oct 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mulled it over a little bit. I think best option is to use run.containerUrl here, remove the links.containerRunUrl from the available template variables section and add the run.containerUrl there instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, fixed

},
"chatHistory": {
"type": "string",
Expand Down