Skip to content
GitmoapAPIBeta
Schema

UpdateScorecardRequest

A partial update. checks and levels, when given, replace the whole list rather than being merged into it.

Shape

  • applies_toServiceSelector or nulloptional
    • The ServiceSelector schema
    • annotationsobjectoptionalAnnotations a service must carry, as key–value pairs. Every entry must match; a service with extra annotations still matches.
    • kindsarray of ServiceKind: one of service | library | website | job | datastore | api | ml_model | otheroptional
    • lifecyclesarray of ServiceLifecycle: one of experimental | production | deprecated | retiredoptional
  • campaign_activeboolean or nulloptionalSwitches the campaign on or off. Unlike every other field here, changing it requires the Owner role, because switching it on can file work items across every covered service.
  • campaign_max_itemsinteger · int32 or nulloptional0–∞
  • checksarray of ScorecardCheck or nulloptional
    • The ScorecardCheck schema
    • keyCheckKey (string)The built-in check's key for a derived check; your own name for the check otherwise.
    • ruleCheckRule
    • configobjectoptionalThe check's own parameters, such as {"days": 90} for released_within. An unknown parameter is refused with a 400 rather than ignored.
    • creates_work_itembooleanoptionalWhether a failure opens a work item in the owning group's backlog. Off by default, and it takes effect only while the scorecard's campaign is active.
  • descriptionstring or nulloptional
  • enabledboolean or nulloptional
  • levelsarray of ScorecardLevel or nulloptional
  • namestring or nulloptional
  • slugScorecardSlug (string) or nulloptional
  • versioninteger · int64 or nulloptionalThe version you last read. When given and the scorecard has changed since, the update is refused with a 409.

Example

Synthesized example
{
"applies_to": {
"annotations": {},
"kinds": [
"service"
],
"lifecycles": [
"experimental"
]
},
"campaign_active": false,
"campaign_max_items": 85,
"checks": [
{
"key": "key-1471",
"rule": {
"type": "derived"
}
},
{
"key": "key-b1b1",
"rule": {
"type": "derived"
}
}
],
"description": "Renders each region as density contours of its operations.",
"enabled": true,
"levels": [
{
"name": "payments-api",
"required_check_keys": []
}
],
"name": "payments-api",
"slug": "slug-e359",
"version": 53
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 1 operation
Returned by 0 operations

No operation returns it directly.