Pinned Rule API Configurations

"id": {
  "type": "string",
  "title": "ID",
  "description": "The ID for this Rule. Used in the API to reference this query rewrite rule. Allowed characters: a-z, A-Z, 0-9, dash (-) and underscore (_)",
  "maxLength": 128,
  "pattern": "^[A-Za-z0-9_\\-]+$"
}

"source": {
  "type": "string",
  "title": "Source",
  "description": "The source for this query rewrite rule, such as a Spark Job.",
  "hints": [
    "hidden"
  ]
}

"sourceType": {
  "type": "string",
  "title": "Source Type",
  "description": "Source type",
  "hints": [
    "hidden"
  ]
}

"createdOn": {
  "type": "string",
  "title": "Created Date/Time",
  "description": "Date/Time this rule was created.",
  "format": "date-time"
}

"updatedOn": {
  "type": "string",
  "title": "Updated Date/Time",
  "description": "Date/Time this rule was last updated.",
  "format": "date-time"
}

"reviewer": {
  "type": "string",
  "title": "Reviewer",
  "description": "Who reviewed this rewrite rule.",
  "hints": [
    "hidden"
  ]
}

"reviewedOn": {
  "type": "string",
  "title": "Reviewed Date/Time",
  "description": "Date/Time this rule was last reviewed.",
  "hints": [
    "hidden"
  ],
  "format": "date-time"
}

"review": {
  "type": "string",
  "title": "Review",
  "enum": [
    "approved",
    "denied"
  ],
  "default": "approved",
  "hints": [
    "readonly"
  ]
}

"deployed": {
  "type": "boolean",
  "title": "Deployed Flag",
  "description": "Flag to indicate if this rewrite rule has been deployed.",
  "hints": [
    "hidden"
  ]
}

"tags": {
  "type": "array",
  "title": "Tags",
  "description": "Conditional tags to restrict the triggering of this query rewrite rule.",
  "items": {
    "type": "string"
  }
}

"name": {
  "type": "string",
  "title": "Name",
  "description": "User-friendly name for this rule."
}

"description": {
  "type": "string",
  "title": "Description",
  "description": "Short description of what this rule does."
}

"enabled": {
  "type": "boolean",
  "title": "Enabled",
  "description": "Set to false to disable this rule.",
  "default": true
}

"matching": {
  "type": "string",
  "title": "Match Query Using",
  "description": "Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. 'keywords' means the query must match the keywords of the search terms value exactly. 'phrase' means the search query must contain one of the search terms values as a subphrase. 'text' means that at least one of the search terms values must match the query, but unlike 'phrase', the query only needs to match part of the value.",
  "enum": [
    "keywords",
    "text",
    "phrase"
  ],
  "default": "keywords"
}

"groups": {
  "type": "string",
  "title": "Rule Group",
  "description": "Group for this rule."
}

"effective_range": {
  "type": "array",
  "title": "Effective Range",
  "description": "Time range when this rule is in effect.",
  "items": {
    "type": "string"
  }
}

"priority": {
  "type": "integer",
  "title": "Precedence",
  "description": "Used when multiple rules could take effect for a given query - higher number means higher precedence. For example, a rule with precedence of 10 will take effect before a rule with precedence of 3. Ties on precedence are broken based on creation time - the more recently created rule will take effect before the older rule."
}

"search_terms": {
  "type": "array",
  "title": "Search Terms",
  "description": "Search terms that trigger this rule.",
  "items": {
    "type": "string"
  }
}

"query_profile_id_ss": {
  "type": "array",
  "title": "Query Profile ID",
  "description": "Query Profile that triggers this rule",
  "items": {
    "type": "string"
  }
}

"field_name": {
  "type": "string",
  "title": "Field Name",
  "description": "Set the field name used by this rule to match the specified values.",
  "default": "id"
}

"field_values": {
  "type": "array",
  "title": "Field Values",
  "description": "List of values for the specified field.",
  "hints": [
    "hidden"
  ],
  "minItems": 1,
  "items": {
    "type": "string"
  }
}

"use_qec": {
  "type": "boolean",
  "title": "Use Query Elevation Component",
  "description": "Set true to use Solr's QEC to force-elevate documents to the top. QEC only supports elevation through \"id\" field. Failed to config QEC in Solr correctly while having this box checked will cause this rule to stop working.",
  "default": false
}

"type": {
  "type": "string",
  "title": "Type",
  "enum": [
    "pinned"
  ],
  "default": "pinned",
  "hints": [
    "readonly"
  ]
}

"doc_type": {
  "type": "string",
  "title": "Doc Type",
  "enum": [
    "rule"
  ],
  "default": "rule",
  "hints": [
    "readonly"
  ]
}

"display_type": {
  "type": "string",
  "title": "Display Type",
  "enum": [
    "Pinned"
  ],
  "default": "Pinned",
  "hints": [
    "readonly"
  ]
}

"additionalProperties": true