Skip to content

ClassificationContributionDto

Endpoints · All schemas

FieldRequiredDescription
albumIdYesstring
albumNameYesstring
archivedYesTrue when this rule archived the item
decisionYesSee definition below
ruleIdYesstring
scoreYesnumber
tagYesThe tag this rule added, when it added one

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: ClassificationMatchDecision, ClassificationTagDto

{
  "properties": {
    "albumId": {
      "type": "string"
    },
    "albumName": {
      "type": "string"
    },
    "archived": {
      "description": "True when this rule archived the item",
      "type": "boolean"
    },
    "decision": {
      "$ref": "#/components/schemas/ClassificationMatchDecision"
    },
    "ruleId": {
      "type": "string"
    },
    "score": {
      "format": "double",
      "nullable": true,
      "type": "number"
    },
    "tag": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClassificationTagDto"
        }
      ],
      "description": "The tag this rule added, when it added one",
      "nullable": true
    }
  },
  "required": [
    "albumId",
    "albumName",
    "archived",
    "decision",
    "ruleId",
    "score",
    "tag"
  ],
  "type": "object"
}