Skip to content
GitmoapAPIBeta
Schema

CreateScorecardRequest

Shape

  • slugScorecardSlug (string)
  • applies_toServiceSelectoroptional
    • 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_activebooleanoptionalWhether to switch the campaign on from the start. Setting it to true requires the Owner role.
  • campaign_max_itemsinteger · int32 or nulloptional0–∞How many work items the campaign may file each time it is switched on. Defaults to 200; at most 1,000.
  • checksarray of ScorecardCheckoptional
    • 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
  • enabledbooleanoptional
  • levelsarray of ScorecardLeveloptional
  • namestring or nulloptionalDefaults to the slug.

Example

Synthesized example
{
"slug": "slug-cd8b",
"applies_to": {
"annotations": {},
"kinds": [
"service"
],
"lifecycles": [
"experimental",
"experimental"
]
},
"campaign_active": false,
"campaign_max_items": 31,
"checks": [
{
"key": "key-0975",
"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"
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 1 operation
Returned by 0 operations

No operation returns it directly.