Search
K
Konnect Service Catalog

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.

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

* Additional properties are allowed.
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
required
Variant 1One Of
AllEntitiesSelectorobject

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

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
criteriaarray[object]required

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters
scorecard_templatestring

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

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example

UpdateScorecard

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
required
Variant 1One Of
AllEntitiesSelectorobject

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

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

Show Child Parameters
criteriaOne Of
arrayrequired

>= 1 items

UpdateScorecardCriteriaobject
* Additional properties are NOT allowed.
Example

ScorecardFilterParameters

object

Scorecard

object

Representation of a scorecard.

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

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

scoreobjectrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
required
Variant 1One Of
AllEntitiesSelectorobject

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

Example:{"type":"label","parameters":{"label_key":"product_area","operator":"equals","value":"cloud_platform"}}

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