ClassificationHintCreate

Fields

5 fields

category · required

string

enabled

boolean

match_field · required

string

note

string or null

pattern · required

string

Raw schema (JSON)

{
  "additionalProperties": false,
  "properties": {
    "category": {
      "maxLength": 30,
      "title": "Category",
      "type": "string"
    },
    "enabled": {
      "default": true,
      "title": "Enabled",
      "type": "boolean"
    },
    "match_field": {
      "maxLength": 20,
      "title": "Match Field",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Note"
    },
    "pattern": {
      "maxLength": 200,
      "title": "Pattern",
      "type": "string"
    }
  },
  "required": [
    "match_field",
    "pattern",
    "category"
  ],
  "title": "ClassificationHintCreate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/classification-hints — Create Classification Hint

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON