product.validate

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

{
  "$defs": {
    "ProductCounts": {
      "description": "How much the model holds. Every count anywhere is one of these.",
      "properties": {
        "commands": {
          "description": "Public commands of the shell tool.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "commands_covered": {
          "description": "Commands a stable feature names.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "featured": {
          "description": "Stable features the homepage shows.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "features": {
          "description": "Stable features.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "features_all": {
          "description": "Features of every status, drafts included.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "kinds": {
          "description": "Kinds of the layer a feature can present.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "kinds_covered": {
          "description": "Kinds a stable feature names.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "modules": {
          "description": "Builtin modules of the executable, and how many a stable feature names.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "modules_covered": {
          "description": "Modules a stable feature names.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "providers": {
          "description": "Providers the tool has an adapter for.",
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "features",
        "features_all",
        "featured",
        "providers",
        "modules",
        "modules_covered",
        "commands",
        "commands_covered",
        "kinds",
        "kinds_covered"
      ],
      "type": "object"
    },
    "ProductFinding": {
      "description": "One thing wrong with the product model, named where it is, with the nearest candidate\nwhen there is one.",
      "properties": {
        "code": {
          "description": "`unknown_reference`, `duplicate_identity`, `missing_content`, `uncovered`, ...",
          "type": "string"
        },
        "did_you_mean": {
          "description": "The nearest existing name, when the value looks like a typo of one.",
          "type": [
            "string",
            "null"
          ]
        },
        "field": {
          "description": "The front-matter key the finding is about, when one key owns it.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The record's identity, when one record owns the finding.",
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "description": "What is wrong, in one sentence.",
          "type": "string"
        },
        "path": {
          "description": "The repository-relative file the finding is in, or the registry it is about.",
          "type": "string"
        },
        "severity": {
          "$ref": "#/$defs/Severity",
          "description": "`error` or `warning`."
        }
      },
      "required": [
        "severity",
        "code",
        "path",
        "message"
      ],
      "type": "object"
    },
    "Severity": {
      "description": "How bad a diagnostic is. `Error` excludes the file it concerns from the index and puts\nthe index into the degraded state; `Warning` and `Info` do neither.",
      "oneOf": [
        {
          "const": "info",
          "description": "Worth knowing; changes nothing.",
          "type": "string"
        },
        {
          "const": "warning",
          "description": "Something to look at; the object is still served.",
          "type": "string"
        },
        {
          "const": "error",
          "description": "The file is excluded and the index is degraded.",
          "type": "string"
        }
      ]
    }
  },
  "description": "What the model's own validation found.",
  "properties": {
    "counts": {
      "$ref": "#/$defs/ProductCounts",
      "description": "The counts the model reached."
    },
    "errors": {
      "description": "How many findings are errors.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "findings": {
      "description": "The findings, errors first, then by file.",
      "items": {
        "$ref": "#/$defs/ProductFinding"
      },
      "type": "array"
    },
    "valid": {
      "description": "True when nothing is an error. Warnings do not make it false.",
      "type": "boolean"
    },
    "warnings": {
      "description": "How many findings are warnings.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "valid",
    "errors",
    "warnings",
    "counts",
    "findings"
  ],
  "title": "ProductValidationReport",
  "type": "object"
}