oxy-data-apps

Oxy Data Apps

A Data App is one YAML file, <name>.app.yml, in an Oxy workspace. Its tasks fetch data; its displays render that data as tables, charts and markdown; optional controls let a viewer filter it live. Oxy renders the file directly — there is no build step and no front-end code.

Data app or custom app?

Code-first React apps are a different product — see the oxy-custom-apps skill.

The file

title: Sales Overview            # shown in listings; falls back to the filename
description: |
  Revenue KPIs and the monthly trend.
published: true                  # default false = hidden from the sidebar

tasks:                           # required, at least one
  - name: monthly_revenue
    type: execute_sql
    database: warehouse          # a database name from config.yml
    sql_query: |
      SELECT DATE_TRUNC('month', order_date) AS month,
             SUM(amount) AS revenue
      FROM orders
      GROUP BY 1
      ORDER BY 1

display:                         # required, at least one
  - type: line_chart
    title: Revenue by month
    data: monthly_revenue        # a task name
    x: month
    y: revenue
    y_format: currency

• Top-level keys are fixed: title, description, controls, tasks, display, published. Anything else is rejected.
• Leave name: out. The app's name is its filename (sales.app.yml → sales). The server tolerates a name: key, but the published schema does not list it, so oxyc validate reports it as an unknown field.
• Where it can live: any **/*.app.yml in the workspace, except under a dot-prefixed directory or one named target, node_modules, dist or build, and never with .test. in the filename. Those paths are skipped, so the app silently does not exist.