LivePhotoCandidatesResponseDto

Endpoints · All schemas

Field	Required	Description
candidates	Yes	array
suggestionsEnabled	Yes	Library care suggests Live Photo pairs; when false no pairs are looked for
total	Yes	Total number of candidate pairs found

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: LivePhotoCandidateDto

{
  "properties": {
    "candidates": {
      "items": {
        "$ref": "#/components/schemas/LivePhotoCandidateDto"
      },
      "type": "array"
    },
    "suggestionsEnabled": {
      "description": "Library care suggests Live Photo pairs; when false no pairs are looked for",
      "type": "boolean"
    },
    "total": {
      "description": "Total number of candidate pairs found",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "candidates",
    "suggestionsEnabled",
    "total"
  ],
  "type": "object"
}