Type Alias: UpdateCardInput

type UpdateCardInput = {
  assignees: {
     id: string;
     name: string;
    }[];
  column: string;
  description: string;
  labels: string[];
  title: string;
};

Input required to update an existing roadmap card in the external provider.

Type declaration

Remarks

This interface supports partial updates - only provided fields are changed in the provider. Omitted fields remain unchanged, allowing targeted edits without fetching and resending all card data.

Provider-specific considerations:

• All fields are optional; at least one field should be provided for a meaningful update
• Column names must match one of the columns returned by the provider's getColumns() method
• Assignee IDs must be valid user identifiers in the provider's system
• Labels completely replace existing labels; provide the full desired set
• Some providers may have limitations (e.g., Jira supports only one assignee)

Example

import type { UpdateCardInput } from '@robojs/roadmap';

// Update only the title
const input1: UpdateCardInput = {
  title: 'Updated title'
};

// Update multiple fields
const input2: UpdateCardInput = {
  title: 'Add dark mode support',
  description: 'Implement dark mode theme across the application',
  column: 'In Progress',
  labels: ['enhancement', 'ui', 'wip']
};