---
title: "SuggestionRuleError"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/SuggestionRuleError"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# SuggestionRuleError

Represents any errors which occured when evaluating a suggestion rule

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    SuggestionRuleErrorDetail:
      type: object
      required:
        - type
        - field
        - expression
        - message
      properties:
        type:
          type: string
          description: >
            The type of error that occured when evaluating suggestion rule
            configuration against given integration record.
              - `error`: represents a generic error.
              - `timeout`: timeout occured when evaluating jq expression
              - `invalid-expression`: jq expression could not be evaluated due to syntax error(s).
              - `result-not-boolean`: jq expression was not evaluated to a boolean
              - `result-not-string`: jq expression was not evaluated to a string
              - `unexpected-result`: jq expression was not evaluated to a result that could not be determined
              - `InvalidLabelKeyInputType`: Indicates the label key is of an invalid type (i.e. number or symbol)
              - `InvalidEmptyLabelKey`: Indicates the label key is empty
              - `InvalidLabelKeyFormat`: Indicates that the format of the label key is invalid, ex: "-bad-format-"
              - `LabelKeyHasReservedPrefix`: Indicates that the label key starts with a Kong-reserved key prefix, ex: "kong-test-key"
              - `MaxLabelKeyCharsExceeded`: Indicates that a label key exceeds the maximum number of allowed characters
              - `InvalidLabelValueInputType`: Indicates the label value is of an invalid type (i.e. number or symbol)
              - `InvalidEmptyLabelValue`: Indicates that the label value is empty
              - `InvalidLabelValueFormat`: Indicates that the format of the label value is invalid, ex: "-bad-format-"
              - `MaxLabelValueCharsExceeded`: Indicates that a label value exceeds the maximum number of allowed characters
              - `InvalidLabelsInputType`: Indicates that a collection of labels is of an invalid type (i.e. array instead of key-value object)
              - `MaxLabelsPerEntityExceeded`: Indicates that a collection of labels exceeds the maximum number of labels allowed for a given entity
              - `ConflictingKeys`: Indicates that labels keys are not unique
              - `InvalidName`: Indicates that the name is invalid
              - `InvalidDisplayName`: Indicates that the display name is invalid
              - `InvalidDescription`: Indicates that the description is invalid
              - `InvalidLabels`: Indicates that the labels are invalid
              - `InvalidMetadata`: Indicates that the metadata is invalid
        field:
          type: string
          description: The field from the payload given which is responsible for this error.
        expression:
          type: string
          description: Represents the resolved or unresolved JQ expression which failed
            validation
        message:
          type: string
          description: Details of the error which occured when evaluating suggestion rule
            configuration against given integration record.
    CreatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity creation date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    UpdatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity update date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    SuggestionRuleError:
      title: SuggestionRuleError
      description: Represents any errors which occured when evaluating a suggestion rule
      allOf:
        - type: object
          nullable: true
          required:
            - suggestion_rule_id
            - details
            - created_at
            - updated_at
          properties:
            id:
              description: |
                The id of the suggestion rule error
              type: string
              example: e4698717-7f0b-434d-aa16-a472089c2504
            resource_id:
              description: |
                The id of the related resource which generated this error
              type: string
              example: qLgnGlFp4iveGUFl
            suggestion_rule_id:
              description: |
                The id of the suggestion rule which generated this error
              type: string
              example: fd109d4a-e183-4488-98f2-10eab0964155
            details:
              description: >
                Details of the error generated from the related suggested rule
                when evaluated
              type: array
              items:
                $ref: "#/components/schemas/SuggestionRuleErrorDetail"
            created_at:
              $ref: "#/components/schemas/CreatedAt"
            updated_at:
              $ref: "#/components/schemas/UpdatedAt"
```