ServiceDocumentContentResponse
objectdocument slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
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
ScorecardFilterParameters
objectOne OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfOne OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfOne OfFilter by a numeric value.
Value strictly equals the given numeric value.
Example:21
Scorecard
objectRepresentation of a scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
The human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
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
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
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
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
ScorecardWithCriteria
objectRepresentation of a scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
The human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
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
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
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
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
Show Child Parameters
CatalogServiceScorecard
objectRepresentation of a scorecard.
Example:f3704e4c-104d-4f21-998a-20d4364c893f
The human-readable name of the scorecard.
Example:Incident Response
Example:Governs key metrics pertaining to teams' incident response practices.
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
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
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
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