canvas

Interaction Canvas

Define interactions, workflows, inputs, outputs, commands, queries, events, and expected responses to ensure a consistent consumer experience.

Outcomes

  • Defined interaction model for the selected capability
  • Inputs, outputs, commands, queries, events, and responses clarified
  • Validation rules and interaction expectations agreed

How it works

  1. Map interactions to user, consumer, or system tasks
  2. Define access points, operations, commands, queries, or events for each interaction
  3. Document inputs and outputs for each interaction.
  4. Specify validation rules and constraints
  5. Create interaction models for CRUD, query-driven, command-driven, and event-driven interactions

Work with this canvas

Use the purpose, outcomes, and instructions above as your static reference while capturing evidence in the interactive workspace.

Local canvas workspace

Interaction Canvas

What kinds of interactions should this capability support before choosing a protocol-specific design? Identify which interaction styles are actually needed for this capability, and which are out of scope. Use this canvas to clarify intent before mapping the result to REST, events, GraphQL, or another selected implementation style.

Active section: CRUD Interactions. Select a section with a pointer, or focus it and press Enter or Space.

CRUD Interactions

Are CRUD (Create, Read, Update, Delete) interactions needed here?

CRUD Input & Output Models

What are the input and output models for the CRUD interactions, if this style is needed?

CRUD Processing & Validation

What are the processing and validation rules for the CRUD interactions, if this style is needed?

Query-Driven Interactions

What read or query interactions are needed to answer consumer questions?

Query-Driven Input & Output Models

What are the input and output models for the query-driven interactions?

Query-Driven Processing & Validation

What are the processing and validation rules for the query-driven interactions?

Command-Driven Interactions

What state-changing commands are needed, if any?

Command-Driven Input & Output Models

What are the input and output models for the command-driven interactions, if this style is needed?

Command-Driven Processing & Validation

What are the processing and validation rules for the command-driven interactions, if this style is needed?

Event-Driven Interactions

What events need to be published or consumed, if any?

Event-Driven Input & Output Models

What are the input and output models for the event-driven interactions, if this style is needed?

Event-Driven Processing & Validation

What are the processing and validation rules for the event-driven interactions, if this style is needed?

Canvas metadata

APIOps Cycles · CC-BY-SA 4.0 · Osaango Ltd

Related stations