Skip to content

PersonCorrectionDto

Endpoints · All schemas

FieldRequiredDescription
actionYesSee definition below
createdAtYesWhen the decision was made
evidenceYesThe photo and face, when it may still be shown
evidenceRevokedYesTrue when the decision was about a photo that can no longer be shown (trashed, Locked, hidden)
fromPersonYesWho the face belonged to before
idYesCorrection ID
toPersonYesWho the face belongs to after
undoableYesWhether this kind of decision can be undone and has not been
undoneAtYesWhen the decision was undone

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: PersonCorrectionAction, FaceEvidenceDto, PersonCorrectionPersonDto

{
  "properties": {
    "action": {
      "$ref": "#/components/schemas/PersonCorrectionAction"
    },
    "createdAt": {
      "description": "When the decision was made",
      "format": "date-time",
      "type": "string"
    },
    "evidence": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FaceEvidenceDto"
        }
      ],
      "description": "The photo and face, when it may still be shown",
      "nullable": true
    },
    "evidenceRevoked": {
      "description": "True when the decision was about a photo that can no longer be shown (trashed, Locked, hidden)",
      "type": "boolean"
    },
    "fromPerson": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PersonCorrectionPersonDto"
        }
      ],
      "description": "Who the face belonged to before",
      "nullable": true
    },
    "id": {
      "description": "Correction ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "toPerson": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PersonCorrectionPersonDto"
        }
      ],
      "description": "Who the face belongs to after",
      "nullable": true
    },
    "undoable": {
      "description": "Whether this kind of decision can be undone and has not been",
      "type": "boolean"
    },
    "undoneAt": {
      "description": "When the decision was undone",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "action",
    "createdAt",
    "evidence",
    "evidenceRevoked",
    "fromPerson",
    "id",
    "toPerson",
    "undoable",
    "undoneAt"
  ],
  "type": "object"
}