FlakyCoachScope

Fields

What each number in the leaderboard is scoped to.

4 fields

membership: string
note: string or null
release_id: string or null
score: string

Raw schema (JSON)

{
  "description": "What each number in the leaderboard is scoped to.\n\nA filtered list LOOKS release-scoped, and here only half of it is:\nmembership is, the impact score is not. Stated in the payload rather than\nonly in the docs, because the number is what gets read — a reader who takes\na score as \"how flaky during 2.4.0\" would be wrong, and nothing in a bare\nfiltered list would tell them.",
  "properties": {
    "membership": {
      "default": "project",
      "title": "Membership",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Note"
    },
    "release_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Release Id"
    },
    "score": {
      "default": "project_window",
      "title": "Score",
      "type": "string"
    }
  },
  "title": "FlakyCoachScope",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

GET /api/v1/projects/{project_id}/flaky-coach — Get Project Flaky Coach

Used by schemas

FlakyCoachResponse

More details

Specification: OpenAPI JSON