Search
K
Konnect Service Catalog

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

ScorecardTemplateName

string

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

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example

ScorecardTemplateCriteria

object
integrationstringrequired

The integration name when it provides the criteria template. Otherwise null.

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.
The available parameters, and its schema, are found on the criteria template definition via
the schema property. Criteria template definitions are determined by the /v1/criteria-templates
endpoint.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
section_namestringrequired

Organizational section that the criteria belongs to within the scorecard template.

Example:Source Code Management

Example

CreateScorecard

object
* Additional properties are NOT allowed.
namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

entity_selectorOne Of
objectrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Show Child Parameters
criteriaarray[object]required

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters
scorecard_templatestringrequired

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

Example