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

integration.create

Create a new integration.

  • Type: operation (command)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.integration-hub
  • Tags: integration, create
  • File: packages/examples/integration-hub/src/integration/integration.operations.ts
    • field.key.label
    integration.create
    field.version.label
    1.0.0
    field.type.label
    operation (command)
    field.title.label
    integration.create
    field.description.label

    Create a new integration.

  • Type: operation (command)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.integration-hub
  • Tags: integration, create
  • File: packages/examples/integration-hub/src/integration/integration.operations.ts
    • field.tags.label
    integration,create
    field.owners.label
    @example.integration-hub
    field.stability.label
    stable

    Create a new integration.

    Goal

    Allow users to set up integrations with external systems.

    Context

    Integration setup.

    Emitted Events

    •

    `integration.created` (v1.0.0)

    Source Definition

    import { defineCommand } from '@lssm-tech/lib.contracts-spec/operations';
import {
	CreateIntegrationInputModel,
	IntegrationModel,
} from './integration.schema';

export const CreateIntegrationContract = defineCommand({
	meta: {
		key: 'integration.create',
		version: '1.0.0',
		stability: 'stable',
		owners: ['@example.integration-hub'],
		tags: ['integration', 'create'],
		description: 'Create a new integration.',
		goal: 'Allow users to set up integrations with external systems.',
		context: 'Integration setup.',
	},
	io: { input: CreateIntegrationInputModel, output: IntegrationModel },
	policy: { auth: 'user' },
	sideEffects: {
		emits: [
			{
				key: 'integration.created',
				version: '1.0.0',
				when: 'Integration created',
				payload: IntegrationModel,
			},
		],
		audit: ['integration.created'],
	},
	acceptance: {
		scenarios: [
			{
				key: 'create-integration-happy-path',
				given: ['User is admin'],
				when: ['User defines new integration type'],
				then: [
					'Integration definition is created',
					'IntegrationCreated event is emitted',
				],
			},
		],
		examples: [
			{
				key: 'create-slack',
				input: { name: 'Slack', category: 'communication', authType: 'oauth2' },
				output: { id: 'slack', status: 'active' },
			},
		],
	},
});