DeletionConsequence

A request or response body; the type column links to the schemas it refers to.

Field	Type	Required	Description
key	string	yes	Stable identifier of the consequence, e.g. `awards` or `attendance_records`.
count	integer	yes	How many rows of this kind the deletion removes or alters. minimum 0
description	string	yes	What happens to those rows, phrased for the person confirming.

Field

Type

Required

Description

key

string

yes

Stable identifier of the consequence, e.g. `awards` or `attendance_records`.

count

integer

yes

How many rows of this kind the deletion removes or alters.

minimum 0

description

string

yes

What happens to those rows, phrased for the person confirming.

jsonExample

{
  "key": "awards",
  "count": 12,
  "description": "12 certification awards held by 7 people will be deleted for good."
}