OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

analytics.dashboard.list

List dashboards.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.analytics-dashboard
  • Tags: analytics, dashboard, list
  • File: packages/examples/analytics-dashboard/src/dashboard/dashboard.operation.ts
  • field.key.label
    analytics.dashboard.list
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    analytics.dashboard.list
    field.description.label

    List dashboards.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.analytics-dashboard
  • Tags: analytics, dashboard, list
  • File: packages/examples/analytics-dashboard/src/dashboard/dashboard.operation.ts
  • field.tags.label
    analytics,dashboard,list
    field.owners.label
    @example.analytics-dashboard
    field.stability.label
    stable

    List dashboards.

    Goal

    Browse available dashboards.

    Context

    Dashboard listing.

    Source Definition

    import {
    	defineCommand,
    	defineQuery,
    } from '@lssm-tech/lib.contracts-spec/operations';
    import {
    	AddWidgetInputModel,
    	CreateDashboardInputModel,
    	DashboardModel,
    	GetDashboardInputModel,
    	ListDashboardsInputModel,
    	ListDashboardsOutputModel,
    	WidgetModel,
    } from './dashboard.schema';
    
    export const ListDashboardsContract = defineQuery({
    	meta: {
    		key: 'analytics.dashboard.list',
    		version: '1.0.0',
    		stability: 'stable',
    		owners: ['@example.analytics-dashboard'],
    		tags: ['analytics', 'dashboard', 'list'],
    		description: 'List dashboards.',
    		goal: 'Browse available dashboards.',
    		context: 'Dashboard listing.',
    	},
    	io: { input: ListDashboardsInputModel, output: ListDashboardsOutputModel },
    	policy: { auth: 'user' },
    	acceptance: {
    		scenarios: [
    			{
    				key: 'list-dashboards-happy-path',
    				given: ['User has dashboards'],
    				when: ['User lists dashboards'],
    				then: ['Paginated list of dashboards is returned'],
    			},
    		],
    		examples: [
    			{
    				key: 'list-basic',
    				input: { limit: 10, offset: 0 },
    				output: { items: [], total: 0, hasMore: false },
    			},
    		],
    	},
    });