distribution.status

{
  "type": "object",
  "additionalProperties": false,
  "description": "No input.",
  "title": "Empty"
}

{
  "type": "object",
  "properties": {
    "installable": {
      "type": "boolean",
      "description": "True when every check holds: a stable release is recorded and complete."
    },
    "summary": {
      "type": "string",
      "description": "One line for a person: what the state is, in the project's own terms."
    },
    "local_version": {
      "type": "string",
      "description": "The version this tree would release."
    },
    "stable_tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "The tag an unpinned installation resolves to, when a stable release is recorded."
    },
    "required_targets": {
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "description": "How many targets a release must publish for that release to be complete."
    },
    "published_artifacts": {
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "description": "How many of them the stable release actually publishes."
    },
    "install_command": {
      "type": "string",
      "description": "The command a person would run, whether or not it currently works."
    },
    "installer_url": {
      "type": "string",
      "description": "Where the installer is served."
    },
    "latest_url": {
      "type": "string",
      "description": "Where the stable pointer is served."
    },
    "checks": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/InstallCheck"
      },
      "description": "Every check, in the order they are worth reading."
    }
  },
  "required": [
    "installable",
    "summary",
    "local_version",
    "required_targets",
    "published_artifacts",
    "install_command",
    "installer_url",
    "latest_url",
    "checks"
  ],
  "description": "Whether the advertised one-line installation works right now, and if not, what is missing.\n\nThis answers the operator's actual question — *can a machine that has never seen this\nproject install it with the published command?* — from local state alone. It performs no\nnetwork access: a repository can be offline and this still answers, because everything it\nneeds is the distribution model and the release records the repository itself carries.\nWhat it cannot see it reports as `unknown` rather than guessing; the public half of the\nquestion is answered by the release workflow's smoke phase, which installs from the\npublished URL on every native runner and is the only thing that proves the public path.",
  "title": "InstallabilityReport",
  "$defs": {
    "InstallCheck": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "A short stable name: `model`, `version`, `targets`, `release`, `artifacts`, `metadata`."
        },
        "state": {
          "$ref": "#/$defs/CheckState",
          "description": "Whether it holds."
        },
        "observed": {
          "type": "string",
          "description": "What was observed, in one line."
        },
        "cause": {
          "type": [
            "string",
            "null"
          ],
          "description": "Why it does not hold. Absent when it does."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "The command or action that would change it. Absent when there is nothing to do."
        }
      },
      "required": [
        "id",
        "state",
        "observed"
      ],
      "description": "One check: what was asked, what was seen, and — when it does not hold — why, and the\ncommand that changes it. The `cause` and `next` fields exist so that a report is\nactionable without a second document; a check that fails without naming its remedy is\na diagnostic nobody can act on."
    },
    "CheckState": {
      "oneOf": [
        {
          "type": "string",
          "const": "ok",
          "description": "The check holds."
        },
        {
          "type": "string",
          "const": "failed",
          "description": "The check does not hold, and the public installation is affected."
        },
        {
          "type": "string",
          "const": "unknown",
          "description": "The check could not be made here; it says nothing either way."
        }
      ],
      "description": "The state of one check in the installability report. Three states and no more: a check\neither holds, does not, or could not be made from what this process can see."
    }
  }
}