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.

AI index

marketplace.payout.list

List payouts for a store.

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

    List payouts for a store.

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

    List payouts for a store.

    Goal

    View payout history.

    Context

    Seller dashboard.

    Source Definition

    import { defineQuery } from '@lssm-tech/lib.contracts-spec/operations';
import { ListPayoutsInputModel, ListPayoutsOutputModel } from './payout.schema';

export const ListPayoutsContract = defineQuery({
	meta: {
		key: 'marketplace.payout.list',
		version: '1.0.0',
		stability: 'stable',
		owners: ['@example.marketplace'],
		tags: ['marketplace', 'payout', 'list'],
		description: 'List payouts for a store.',
		goal: 'View payout history.',
		context: 'Seller dashboard.',
	},
	io: { input: ListPayoutsInputModel, output: ListPayoutsOutputModel },
	policy: { auth: 'user' },
	acceptance: {
		scenarios: [
			{
				key: 'list-payouts-happy-path',
				given: ['Store has payout history'],
				when: ['Seller lists payouts'],
				then: ['List of payouts is returned'],
			},
		],
		examples: [
			{
				key: 'list-recent',
				input: { limit: 10, offset: 0 },
				output: { items: [], total: 5, hasMore: false },
			},
		],
	},
});