Search
K
Konnect Service Catalog

CriteriaTemplateFilterParameters

object
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
display_nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
installedboolean

Filter by a boolean value (true/false).

integration_nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
Example

CriteriaTemplate

object

Representation of a criteria template.

namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

display_namestringrequired

The human-readable display name of the template.

categorystringrequired

Categorical tag for the functionality the template relates to.

Allowed values:Source Code ManagementIncident ManagementObservabilityCode QualityIssue TrackingCommunicationsFeature ManagementSecurity / VulnerabilityDocumentationCatalog ManagementGateway Configuration

Example:Source Code Management

template_stringstringrequired

Liquid template string used to render the criteria interpolated by parameters.

integration_namestringrequired

The catalog integration who registered the given criteria template.
This will be null when a template is always available independent of connected integrations.

installedbooleanrequired

Whether the template is available given the current state of the catalog.
For example, this will be false when the template is provided by an integrastion
that is not currently connected.

schemaAny Of
required
EmptySchemaobject
required_integration_capabilitystringrequired

Required capability from connected integrations to use this criteria template.
Applicable for templates that are not provided by a given integration (functional
across integrations).

Allowed values:on_call_providerincident_providerpull_request_providerworkflow_provider

Example

CriteriaTemplateSchema

Any Of

ScorecardTemplateFilterParameters

object
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
display_nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
Example

ScorecardTemplate

object

Representation of a scorecard template.

namestringrequired

Well-known name of the template. Uniquely identifies the template.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

display_namestringrequired

Example:Kong Best Practices

descriptionstringrequired

Example:Best practices that we encourage users to follow when using other Konnect applications.

criteriaarray[object]required

Example:{"template_name":"gateway_manager_error_rate","template_parameters":{"relative_window":"30d"},"integration":"gateway_manager","section_name":"Gateway Observability"}{"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","relative_window":"30d"},"integration":"gateway_manager","section_name":"Gateway Observability"}{"template_name":"gateway_manager_has_plugin","template_parameters":{},"integration":"gateway_manager","section_name":"Plugin Management"}

Show Child Parameters
Example