Search
K
Konnect Service Catalog

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
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
criteriaOne Of
arrayrequired

>= 1 items

UpdateScorecardCriteriaobject
* 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

ScheduleResourceIngestion

object
* Additional properties are NOT allowed.
ingest_fromstring(date-time)

A timestamp indicating when to start ingestion from.
RFC-3339 format is used with a “T” character separating date from time within the field value.
Omitting this property indicates ingestion will be triggered from the beginning of time until the present.

Example

ServiceDocument

object
* Additional properties are NOT allowed.
slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestringrequired

Document title

parent_document_idstring(uuid)

parent document id

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

idstring(uuid)required

The service document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

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

ServiceDocumentTree

object
* Additional properties are NOT allowed.
slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestringrequired

Document title

parent_document_idstring(uuid)

parent document id

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

idstring(uuid)required

The service document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

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

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

CreateServiceDocumentPayload

object
* Additional properties are NOT allowed.
slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestringrequired

Document title

parent_document_idstring(uuid)

parent document id

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

contentstringrequired

Markdown content.

Example