Search
K
Konnect Service Catalog

SuggestionRule

Contains information about the suggestion rule.

idstring(uuid)requiredread-only

The suggestion rule ID.

Example:22f72bd1-2897-473e-9471-302de3ccf38b

namestringrequired

The display name of the suggestion rule.

>= 1 characters<= 120 characters

descriptionstringrequired

The description of the suggestion rule

Default:null

>= 1 characters<= 2048 characters

Example:Suggestion rule description

bindingstringrequired

The integration binding object name

Example:pagerduty_service

activebooleanrequired

Determines if this suggestion rule should be evaluated when generating suggested actions.

auto_acceptbooleanrequired

Determines if the suggested action should be applied automatically.

  • true: Suggested action will be applied automatically
  • false: Suggested action will not be automatically applied, user input required
actionOne Of
required
ArchiveActionPayloadobject

The action configuration for this system suggestion rule.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

discovery_selectorstringrequired

A boolean string or JQ expression that must evaluate to a boolean value.
Supports JQ expressions syntax on discovered entity’s integration_record property.

Example:.gateway_service.tags | contains(["_KonnectDeployment:"])

Example

TestSuggestionRule

object

Contains evaluation results of a suggestion rule configuration against an integration record.

* Additional properties are NOT allowed.
evaluationobjectrequired

Evaluation result of suggesetion rule configuration against given integration record.

* Additional properties are NOT allowed.
Show Child Parameters
errorsarray[object]required

List of errors that occured when evaluating suggestion rule configuration against given integration record.

Show Child Parameters
Example

SuggestionRuleError

Represents any errors which occured when evaluating a suggestion rule

idstring

The id of the suggestion rule error

Example:e4698717-7f0b-434d-aa16-a472089c2504

resource_idstring

The id of the related resource which generated this error

Example:qLgnGlFp4iveGUFl

suggestion_rule_idstringrequired

The id of the suggestion rule which generated this error

Example:fd109d4a-e183-4488-98f2-10eab0964155

detailsarray[object]required

Details of the error generated from the related suggested rule when evaluated

Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

SuggestedRuleActionEvaluated

One Of
typestringrequired

Allowed values:archive

Example

SuggestionRuleErrorDetail

object
typestringrequired

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
fieldstringrequired

The field from the payload given which is responsible for this error.

expressionstringrequired

Represents the resolved or unresolved JQ expression which failed validation

messagestringrequired

Details of the error which occured when evaluating suggestion rule configuration against given integration record.

Example