Skip to content

Commit

Permalink
connector and name to API yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
royendo committed Nov 6, 2024
1 parent 9fbaec5 commit 603f3e7
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/docs/reference/project-files/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,13 @@ See comprehensive documentation on how to define and use [custom APIs](/integrat

_**`type`**_ — Refers to the resource type and must be `api` _(required)_.

_**`name`**_ — Refers to the name of the API. _(optional)_.


Either one of the following:

- _**`sql`**_ — General SQL query referring a [model](/build/models/models.md) _(required)_.

- _**`metrics_sql`**_ — SQL query referring metrics definition and dimensions defined in the [metrics view](/build/dashboards/dashboards.md) _(required)_.
- _**`metrics_sql`**_ — SQL query referring metrics definition and dimensions defined in the [metrics view](/build/dashboards/dashboards.md) _(required)_.

_**`connector`**_ — Refers to the OLAP engine, if you are not using DuckDB, IE: [ClickHouse OLAP engine](../olap-engines/multiple-olap.md). _(optional)_.

0 comments on commit 603f3e7

Please sign in to comment.