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.

workflow.approval.decide

Submit an approval decision (approve/reject).

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

    Submit an approval decision (approve/reject).

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

    Submit an approval decision (approve/reject).

    Goal

    Allow approvers to make decisions on requests.

    Context

    Approval inbox, workflow detail.

    Emitted Events

    `workflow.approval.decided` (v1.0.0)

    Source Definition

    import {
    	defineCommand,
    	defineQuery,
    } from '@lssm-tech/lib.contracts-spec/operations';
    import { defineSchemaModel, ScalarTypeEnum } from '@lssm-tech/lib.schema';
    import { ApprovalDecisionEnum, ApprovalStatusEnum } from './approval.enum';
    import { ApprovalCommentModel, ApprovalRequestModel } from './approval.schema';
    
    export const SubmitDecisionContract = defineCommand({
    	meta: {
    		key: 'workflow.approval.decide',
    		version: '1.0.0',
    		stability: 'stable',
    		owners: ['@example.workflow-system'],
    		tags: ['workflow', 'approval', 'decision'],
    		description: 'Submit an approval decision (approve/reject).',
    		goal: 'Allow approvers to make decisions on requests.',
    		context: 'Approval inbox, workflow detail.',
    	},
    	io: {
    		input: defineSchemaModel({
    			name: 'ApproveRejectInput',
    			fields: {
    				requestId: {
    					type: ScalarTypeEnum.String_unsecure(),
    					isOptional: false,
    				},
    				decision: { type: ApprovalDecisionEnum, isOptional: false },
    				comment: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
    				data: { type: ScalarTypeEnum.JSON(), isOptional: true },
    			},
    		}),
    		output: ApprovalRequestModel,
    	},
    	policy: { auth: 'user' },
    	sideEffects: {
    		emits: [
    			{
    				key: 'workflow.approval.decided',
    				version: '1.0.0',
    				when: 'Decision is made',
    				payload: ApprovalRequestModel,
    			},
    		],
    		audit: ['workflow.approval.decided'],
    	},
    	acceptance: {
    		scenarios: [
    			{
    				key: 'approve-request-happy-path',
    				given: ['Approval request is pending', 'User is assignee'],
    				when: ['User approves request'],
    				then: ['Request is approved', 'ApprovalDecided event is emitted'],
    			},
    		],
    		examples: [
    			{
    				key: 'approve-basic',
    				input: {
    					requestId: 'req-123',
    					decision: 'approve',
    					comment: 'Looks good',
    				},
    				output: { id: 'req-123', status: 'approved' },
    			},
    		],
    	},
    });