Skip to content

docs(dataset-schema): distinguish top-level fields from views.*.transformation.fields #2733

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

Draft
DaveHanns wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs(dataset-schema): distinguish top-level fields from views.*.transformation.fields #2733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions sources/platform/actors/development/actor_definition/dataset_schema/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,17 @@
}
```

### The two `fields` keys

The schema uses two different keys named `fields`. They live in different places and do different jobs — populate both.

Check failure on line 40 in sources/platform/actors/development/actor_definition/dataset_schema/index.md

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.

Raw Output:
{"message": "[Microsoft.Dashes] Remove the spaces around ' — '.", "location": {"path": "sources/platform/actors/development/actor_definition/dataset_schema/index.md", "range": {"start": {"line": 40, "column": 103}}}, "severity": "ERROR"}

| Location | Type | Purpose |
| --- | --- | --- |
| Top-level `fields` | [JSON Schema](https://json-schema.org/) object keyed by field name (under `properties`) | Describes each item's structure. Drives server-side validation, MCP schema discovery for AI agents, and the documented API contract. |
| `views.<viewId>.transformation.fields` | Flat array of field name strings | Selects which columns appear in the Console Output tab and their order. Display-only. |

A common mistake is to populate only `views.overview.transformation.fields` and leave the top-level `fields` empty. Console still renders the selected columns, but validation and the MCP / API schema have nothing to work from. The example under [Schema components](#schema-components) above shows both keys populated together; see [Fields](#fields) below for the full field-metadata example.

## File structure

Place the dataset schema in the `.actor` folder in your Actor's root directory. You can organize it in two ways:
Expand Down
Loading