Skip to content

Update the auto YAML Generation #7725

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.

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

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
1df036d
some changes for connector YAML
royendo Aug 4, 2025
3ff888e
remove
royendo Aug 4, 2025
a381593
separated YAML schema
royendo Aug 4, 2025
b6b987f
nit
royendo Aug 4, 2025
d7d4b11
link fixes
royendo Aug 4, 2025
a3784a0
Update generate_project.go
royendo Aug 4, 2025
f2ed2c4
add sec warning
royendo Aug 4, 2025
d57d430
motherduck live connector
royendo Aug 4, 2025
e5434ee
remove local file from connector
royendo Aug 4, 2025
cd0c819
nit
royendo Aug 4, 2025
d3396eb
matching file names
royendo Aug 4, 2025
16c99c6
reordered files and added sources YAML and model SQL
royendo Aug 4, 2025
6ba0dcd
nit, fix links
royendo Aug 4, 2025
4363fff
comparing with current YAML changes
royendo Aug 5, 2025
64677e0
Merge branch 'main' into docs/auto-gen-YAML
royendo Aug 5, 2025
77f0ca9
adding annotatons back
royendo Aug 5, 2025
7c35559
gofmt, golint
royendo Aug 5, 2025
0ff11e2
fix
royendo Aug 5, 2025
11b2710
first pass fix, need to review a few other items
royendo Aug 6, 2025
db75a6b
remove toplevel driver
royendo Aug 6, 2025
95ca49a
single project file
royendo Aug 6, 2025
98baf56
Update generate_project.go
royendo Aug 6, 2025
7065bcc
good old cursor wiped my functoni
royendo Aug 6, 2025
dba395a
missing parameters
royendo Aug 6, 2025
6e32ddd
midding parameters and inline examples
royendo Aug 6, 2025
c55eff3
god so many false positives from asking cursor to merge files
royendo Aug 6, 2025
6ffe7f8
adding links
royendo Aug 6, 2025
f69c89a
fixed oneOf
royendo Aug 6, 2025
3b6517e
split data properties to have api excamples
royendo Aug 6, 2025
e67f159
gonig through files
royendo Aug 7, 2025
df54d71
returning original format
royendo Aug 7, 2025
f94396e
?
royendo Aug 7, 2025
c58c634
Merge remote-tracking branch 'origin/main' into docs/auto-gen-YAML
royendo Aug 8, 2025
e8c04e9
fixing urls,
royendo Aug 8, 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
Prev Previous commit
Next Next commit
adding links
  • Loading branch information
royendo committed Aug 6, 2025
commit 6ffe7f88f17df796e18be7fcac2f0630e73b6d6b
21 changes: 1 addition & 20 deletions docs/docs/hidden/yaml/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ _[object]_ - OpenAPI specification for the API endpoint

### `security`

_[object]_ - Defines security rules and access control policies for resources
_[object]_ - Defines [security rules and access control policies](/manage/security) for resources

- **`access`** - _[oneOf]_ - Expression indicating if the user should be granted access to the dashboard. If not defined, it will resolve to false and the dashboard won't be accessible to anyone. Needs to be a valid SQL expression that evaluates to a boolean.

Expand Down Expand Up @@ -162,22 +162,3 @@ _[object]_ - Based on resource status _(required)_
resource_status:
where_error: true
```


## Common Properties

### `name`

_[string]_ - Name is usually inferred from the filename, but can be specified manually.

### `refs`

_[array of string]_ - List of resource references

### `dev`

_[object]_ - Overrides any properties in development environment.

### `prod`

_[object]_ - Overrides any properties in production environment.
2 changes: 1 addition & 1 deletion docs/docs/hidden/yaml/canvas-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ _[object]_ - Indicates if filters should be enabled for the canvas.

### `security`

_[object]_ - Defines security rules and access control policies for dashboards (without row filtering)
_[object]_ - Defines [security rules and access control policies](/manage/security) for dashboards (without row filtering)

- **`access`** - _[oneOf]_ - Expression indicating if the user should be granted access to the dashboard. If not defined, it will resolve to false and the dashboard won't be accessible to anyone. Needs to be a valid SQL expression that evaluates to a boolean.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hidden/yaml/explore-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ _[object]_ - Configuration options for embedded dashboard views

### `security`

_[object]_ - Defines security rules and access control policies for dashboards (without row filtering)
_[object]_ - Defines [security rules and access control policies](/manage/security) for dashboards (without row filtering)

- **`access`** - _[oneOf]_ - Expression indicating if the user should be granted access to the dashboard. If not defined, it will resolve to false and the dashboard won't be accessible to anyone. Needs to be a valid SQL expression that evaluates to a boolean.

Expand Down
10 changes: 7 additions & 3 deletions docs/docs/hidden/yaml/metrics-views.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ _[string]_ - The version of the metrics view schema

_[string]_ - Refers to the resource type and must be `metrics_view` _(required)_

### `connector`

_[string]_ - Refers to the connector type for the metrics view, see [OLAP engines](/build/olap) for more information

### `display_name`

_[string]_ - Refers to the display name for the metrics view
Expand All @@ -26,7 +30,7 @@ _[string]_ - Refers to the description for the metrics view

### `ai_instructions`

_[string]_ - Extra instructions for AI agents. Used to guide natural language question answering and routing.
_[string]_ - Extra instructions for [AI agents](/explore/mcp). Used to guide natural language question answering and routing.

### `model`

Expand Down Expand Up @@ -136,7 +140,7 @@ _[array of object]_ - Used to define the numeric aggregates of columns from your

- **`time_grain`** - _[string]_ - Time grain for time-based dimensions.

- **`requires`** - _[anyOf]_ - using an available measure or dimension in your metrics view to set a required parameter, cannot be used with simple measures
- **`requires`** - _[anyOf]_ - using an available measure or dimension in your metrics view to set a required parameter, cannot be used with simple measures. See [referencing measures](/build/metrics-view/advanced-expressions/referencing) for more information.

- **option 1** - _[string]_ - Simple field name as a string.

Expand Down Expand Up @@ -212,7 +216,7 @@ _[array of object]_ - Used to define annotations that can be displayed on charts

### `security`

_[object]_ - Defines security rules and access control policies for resources
_[object]_ - Defines [security rules and access control policies](/manage/security) for resources

- **`access`** - _[oneOf]_ - Expression indicating if the user should be granted access to the dashboard. If not defined, it will resolve to false and the dashboard won't be accessible to anyone. Needs to be a valid SQL expression that evaluates to a boolean.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/hidden/yaml/rillyaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ _[object]_ - Optional feature flags. Can be specified as a map of feature names

### `ai_instructions`

_[string]_ - Extra instructions for LLM/AI features. Used to guide natural language question answering and routing.
_[string]_ - Extra instructions for [AI agents](/explore/mcp). Used to guide natural language question answering and routing.

## Configuring the default OLAP Engine

Expand All @@ -38,7 +38,7 @@ Please see our reference documentation on [OLAP Engines](/docs/reference/olap-en

### `olap_connector`

_[string]_ - Specifies the default OLAP engine for the project. Defaults to duckdb if not set.
_[string]_ - Specifies the [default OLAP engine](/build/olap) for the project. Defaults to duckdb if not set.

```yaml
olap_connector: clickhouse
Expand Down
17 changes: 10 additions & 7 deletions runtime/parser/schema/project.schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,9 @@ oneOf:
type: string
const: metrics_view
description: Refers to the resource type and must be `metrics_view`
connector:
type: string
description: Refers to the connector type for the metrics view, see [OLAP engines](/build/olap) for more information
display_name:
type: string
description: Refers to the display name for the metrics view
Expand All @@ -429,7 +432,7 @@ oneOf:
description: Refers to the description for the metrics view
ai_instructions:
type: string
description: Extra instructions for AI agents. Used to guide natural language question answering and routing.
description: Extra instructions for [AI agents](/explore/mcp). Used to guide natural language question answering and routing.
model:
type: string
description: Refers to the model powering the dashboard (either model or table is required)
Expand Down Expand Up @@ -543,7 +546,7 @@ oneOf:
description: for per dimensions
requires:
$ref: '#/definitions/field_selectors_properties'
description: using an available measure or dimension in your metrics view to set a required parameter, cannot be used with simple measures
description: using an available measure or dimension in your metrics view to set a required parameter, cannot be used with simple measures. See [referencing measures](/build/metrics-view/advanced-expressions/referencing) for more information.
valid_percent_of_total:
type: boolean
description: a boolean indicating whether percent-of-total values should be rendered for this measure
Expand Down Expand Up @@ -1117,7 +1120,7 @@ oneOf:
required:
- type
- $ref: '#/definitions/data_properties'
- $ref: '#/definitions/common_properties'
# - $ref: '#/definitions/common_properties'

# Themes
- title: Theme YAML
Expand Down Expand Up @@ -1176,7 +1179,7 @@ oneOf:
description: Optional feature flags. Can be specified as a map of feature names to booleans.
ai_instructions:
type: string
description: Extra instructions for LLM/AI features. Used to guide natural language question answering and routing.
description: Extra instructions for [AI agents](/explore/mcp). Used to guide natural language question answering and routing.
- title: Configuring the default OLAP Engine
description: |
Rill allows you to specify the default OLAP engine to use in your project via `rill.yaml`.
Expand All @@ -1187,7 +1190,7 @@ oneOf:
properties:
olap_connector:
type: string
description: Specifies the default OLAP engine for the project. Defaults to duckdb if not set.
description: Specifies the [default OLAP engine](/build/olap) for the project. Defaults to duckdb if not set.
examples:
- olap_connector: clickhouse
- title: Project-wide defaults
Expand Down Expand Up @@ -1592,7 +1595,7 @@ definitions:
description: 'If true, allows the schedule to run in development mode.'
security_policy_properties:
type: object
description: Defines security rules and access control policies for resources
description: Defines [security rules and access control policies](/manage/security) for resources
properties:
access:
oneOf:
Expand Down Expand Up @@ -1689,7 +1692,7 @@ definitions:

dashboard_security_policy_properties:
type: object
description: Defines security rules and access control policies for dashboards (without row filtering)
description: Defines [security rules and access control policies](/manage/security) for dashboards (without row filtering)
properties:
access:
oneOf:
Expand Down