Get scout metadata

v1.0.0

Return the project's scout metadata: whether it is enrolled, the current announcement banner (e.g. an alpha run-limit notice, or null when unset), and the enforced run limits with current usage. Limits reflect what the coordinator actually applies at dispatch, so a user can see the real throttle rather than what they assume they set. All values come from the signals-scout flag payload, so the banner and caps can change with no deploy.

Input

{
  "type": "object",
  "properties": {
    "project_id": {
      "type": "string"
    }
  },
  "required": [
    "project_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Team-scoped scout metadata for the inbox / Code-app UIs: enrollment, the alpha banner, and\nthe enforced limits. Sourced from the `signals-scout` flag payload so the banner and caps can\nchange without a deploy to either app.",
  "required": [
    "banner_message",
    "enrolled",
    "limits"
  ],
  "properties": {
    "banner_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Free-form announcement banner to show above the scout UI (e.g. alpha run-limit notice), or null when unset."
    },
    "enrolled": {
      "type": "boolean",
      "description": "Whether this project runs scouts. True when the project is in the signals-scout flag's enrollment set — either listed explicitly in guaranteed_team_ids or covered by the \"*\" wildcard (every project that turns scouts on) — and not in skip_team_ids."
    },
    "limits": {
      "description": "The team's enforced scout run caps and current usage.",
      "type": "object"
    }
  }
}