CreateScorecard
objectThe human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
One OfSelector 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"}}
One OfEntity selector that includes all entities of the given type within the catalog.
Show Child Parameters
>= 1 items
Show Child Parameters
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
UpdateScorecard
objectThe human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
One OfSelector 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"}}
One OfEntity selector that includes all entities of the given type within the catalog.
Show Child Parameters
One Of>= 1 items
Show Child Parameters
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
ScheduleResourceIngestion
objectA 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.
ServiceDocument
objectdocument slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
The service document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
ServiceDocumentTree
objectdocument slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
The service document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z