xref: /aosp_15_r20/external/pigweed/docs/module_metadata_schema.json (revision 61c4878ac05f98d0ceed94b57d316916de578985) 
1{
2  "description": "Schema for //docs/module_metadata.json.",
3  "type": "object",
4  "patternProperties": {
5    "^pw_.*": {
6      "description": "The metadata for each module must match this schema.",
7      "type": "object",
8      "properties": {
9        "languages": {
10          "description": "Supported languages, build systems, etc. TODO: https://pwbug.dev/345534064 - Refactor this.",
11          "type": "array",
12          "items": {
13            "type": "string",
14            "enum": [
15              "Bazel",
16              "C",
17              "C11",
18              "C++",
19              "C++17",
20              "C++20",
21              "CLI",
22              "CMake",
23              "GN",
24              "Go",
25              "Java",
26              "JavaScript",
27              "Python",
28              "Rust",
29              "Starlark",
30              "TypeScript",
31              "VS Code"
32            ]
33          }
34        },
35        "size": {
36          "description": "A summary of the code size impact of the module.",
37          "type": "string"
38        },
39        "status": {
40          "description": "The status of the module.",
41          "type": "string",
42          "enum": [
43            "stable",
44            "unstable",
45            "experimental",
46            "deprecated"
47          ]
48        },
49        "tagline": {
50          "description": "A concise summary of the module's value proposition.",
51          "type": "string"
52        }
53      },
54      "required": [
55        "status"
56      ],
57      "additionalProperties": false
58    }
59  },
60  "additionalProperties": false
61}
62