Search
K
Konnect Service Catalog

CatalogServiceScorecard

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

criteriaarray[object]required
Show Child Parameters
Example

ScorecardEntitySelector

One Of
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
Example

ScorecardScore

object

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.

valuestringrequired

The human-readable score value coverted to the Scorecard’s assigned grading system.

Example:88%

raw_valuenumberrequired

The raw, numeric score calculated during evaluation of the scorecard.
Rounded to 3 decimal places.

>= 0<= 100

Example:87.5

Example

ScorecardServiceFilterParameters

id
name
display_name
custom_fields
labels
Example

ScorecardService

idstring(uuid)requiredread-only

The service ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The machine name of the Service that uniquely identifies it within the catalog.

Match pattern:^[0-9a-z.-]+$

>= 1 characters<= 120 characters

Example:user-svc

display_namestringrequired

The display name of the Service.

>= 1 characters<= 120 characters

Example:User Service

descriptionstringrequired

Optionally provide a description of the Service.

<= 2048 characters

custom_fieldsobjectrequired

Map of customizable, catalog-defined fields providing information about a service.

Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}

labelsrequired
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
Example