ObjectStackObjectStack

Change Management

Change Management protocol schemas

Change Type Enum

Classification of change requests based on risk and approval requirements.

Follows ITIL change management best practices.

Source: packages/spec/src/system/change-management.zod.ts

TypeScript Usage

import { ChangeImpact, ChangePriority, ChangeRequest, ChangeStatus, ChangeType, RollbackPlan } from '@objectstack/spec/system';
import type { ChangeImpact, ChangePriority, ChangeRequest, ChangeStatus, ChangeType, RollbackPlan } from '@objectstack/spec/system';

// Validate data
const result = ChangeImpact.parse(data);

ChangeImpact

Properties

PropertyTypeRequiredDescription
levelEnum<'low' | 'medium' | 'high' | 'critical'>Impact level
affectedSystemsstring[]Affected systems
affectedUsersnumberoptionalAffected user count
downtimeObjectoptionalDowntime information

ChangePriority

Allowed Values

  • critical
  • high
  • medium
  • low

ChangeRequest

Properties

PropertyTypeRequiredDescription
idstringChange request ID
titlestringChange title
descriptionstringChange description
typeEnum<'standard' | 'normal' | 'emergency' | 'major'>Change type
priorityEnum<'critical' | 'high' | 'medium' | 'low'>Change priority
statusEnum<'draft' | 'submitted' | 'in-review' | 'approved' | 'scheduled' | 'in-progress' | 'completed' | 'failed' | 'rolled-back' | 'cancelled'>Change status
requestedBystringRequester user ID
requestedAtnumberRequest timestamp
impactObjectImpact assessment
implementationObjectImplementation plan
rollbackPlanObjectRollback plan
scheduleObjectoptionalSchedule
securityImpactObjectoptionalSecurity impact assessment per ISO 27001:2022 A.8.32
approvalObjectoptionalApproval workflow
attachmentsObject[]optionalAttachments
metadataRecord<string, any>optionalCustom metadata key-value pairs for extensibility

ChangeStatus

Allowed Values

  • draft
  • submitted
  • in-review
  • approved
  • scheduled
  • in-progress
  • completed
  • failed
  • rolled-back
  • cancelled

ChangeType

Allowed Values

  • standard
  • normal
  • emergency
  • major

RollbackPlan

Properties

PropertyTypeRequiredDescription
descriptionstringRollback description
stepsObject[]Rollback steps
testProcedurestringoptionalTest procedure

On this page