Helm Chart Repository Index

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://helm.sh/schemas/repository-index.json",
  "title": "Helm Chart Repository Index",
  "description": "Schema for the index.yaml file served by a Helm chart repository. The index file is the primary discovery mechanism for Helm clients, listing all available charts and their versions along with download URLs and integrity digests. It is generated by the 'helm repo index' command and served at the /index.yaml endpoint of a chart repository.",
  "type": "object",
  "required": [
    "apiVersion",
    "entries"
  ],
  "properties": {
    "apiVersion": {
      "type": "string",
      "description": "The API version of the index file format.",
      "const": "v1"
    },
    "generated": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the index was generated."
    },
    "entries": {
      "type": "object",
      "description": "A map of chart names to arrays of chart version metadata. Each key is a chart name and each value is a list of all available versions for that chart, sorted in reverse SemVer order.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "#/$defs/ChartEntry"
        }
      }
    }
  },
  "$defs": {
    "ChartEntry": {
      "type": "object",
      "description": "Metadata for a single chart version as it appears in the repository index. Combines Chart.yaml metadata with repository-specific fields like download URLs and digests.",
      "required": [
        "apiVersion",
        "name",
        "version",
        "urls",
        "digest"
      ],
      "properties": {
        "apiVersion": {
          "type": "string",
          "description": "The chart API version.",
          "enum": [
            "v1",
            "v2"
          ]
        },
        "name": {
          "type": "string",
          "description": "The name of the chart."
        },
        "version": {
          "type": "string",
          "description": "The SemVer 2 version of the chart."
        },
        "kubeVersion": {
          "type": "string",
          "description": "A SemVer range of compatible Kubernetes versions."
        },
        "description": {
          "type": "string",
          "description": "A single-sentence description of the chart."
        },
        "type": {
          "type": "string",
          "description": "The type of the chart.",
          "enum": [
            "application",
            "library"
          ]
        },
        "keywords": {
          "type": "array",
          "description": "Keywords for search and categorization.",
          "items": {
            "type": "string"
          }
        },
        "home": {
          "type": "string",
          "format": "uri",
          "description": "The URL of the project home page."
        },
        "sources": {
          "type": "array",
          "description": "URLs to source code for the chart.",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "dependencies": {
          "type": "array",
          "description": "Chart dependencies.",
          "items": {
            "$ref": "#/$defs/Dependency"
          }
        },
        "maintainers": {
          "type": "array",
          "description": "Chart maintainers.",
          "items": {
            "$ref": "#/$defs/Maintainer"
          }
        },
        "icon": {
          "type": "string",
          "format": "uri",
          "description": "URL to an icon for the chart."
        },
        "appVersion": {
          "type": "string",
          "description": "The version of the application contained in the chart."
        },
        "deprecated": {
          "type": "boolean",
          "description": "Whether this chart version is deprecated."
        },
        "annotations": {
          "type": "object",
          "description": "Additional metadata annotations.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "urls": {
          "type": "array",
          "description": "A list of URLs where this chart version can be downloaded. At least one URL is required.",
          "items": {
            "type": "string",
            "format": "uri"
          },
          "minItems": 1
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when this chart version was added to the repository."
        },
        "removed": {
          "type": "boolean",
          "description": "Whether this chart version has been removed."
        },
        "digest": {
          "type": "string",
          "description": "The SHA-256 digest of the chart package for integrity verification."
        }
      }
    },
    "Dependency": {
      "type": "object",
      "description": "A chart dependency reference.",
      "required": [
        "name",
        "version"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "repository": {
          "type": "string"
        },
        "condition": {
          "type": "string"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "import-values": {
          "type": "array",
          "items": {}
        },
        "alias": {
          "type": "string"
        }
      }
    },
    "Maintainer": {
      "type": "object",
      "description": "Chart maintainer contact information.",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      }
    }
  }
}