xref: /aosp_15_r20/external/pigweed/docs/module_metadata_schema.json (revision 61c4878ac05f98d0ceed94b57d316916de578985)

{
  "description": "Schema for //docs/module_metadata.json.",
  "type": "object",
  "patternProperties": {
    "^pw_.*": {
      "description": "The metadata for each module must match this schema.",
      "type": "object",
      "properties": {
        "languages": {
          "description": "Supported languages, build systems, etc. TODO: https://pwbug.dev/345534064 - Refactor this.",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "Bazel",
              "C",
              "C11",
              "C++",
              "C++17",
              "C++20",
              "CLI",
              "CMake",
              "GN",
              "Go",
              "Java",
              "JavaScript",
              "Python",
              "Rust",
              "Starlark",
              "TypeScript",
              "VS Code"
            ]
          }
        },
        "size": {
          "description": "A summary of the code size impact of the module.",
          "type": "string"
        },
        "status": {
          "description": "The status of the module.",
          "type": "string",
          "enum": [
            "stable",
            "unstable",
            "experimental",
            "deprecated"
          ]
        },
        "tagline": {
          "description": "A concise summary of the module's value proposition.",
          "type": "string"
        }
      },
      "required": [
        "status"
      ],
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}