crd-schema-extractor/source.schema.json at main · blacksd/crd-schema-extractor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/blacksd/crd-schema-extractor/source.schema.json",
  "title": "CRD Source Configuration",
  "description": "Schema for source YAML config files in the sources/ directory.",
  "type": "object",
  "required": [
    "sources"
  ],
  "additionalProperties": false,
  "properties": {
    "sources": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": [
          "name",
          "type",
          "version",
          "license",
          "homepage"
        ],
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "pattern": "^[a-z0-9][a-z0-9-]*$",
            "description": "Unique source identifier (lowercase, alphanumeric with hyphens)."
          },
          "type": {
            "type": "string",
            "enum": [
              "helm",
              "url",
              "git+github"
            ],
            "description": "Source type: helm chart, direct URL, or git repository."
          },
          "repo": {
            "type": "string",
            "format": "uri",
            "description": "Repository URL. For helm: chart repository URL. For git+github: GitHub repository URL (https://github.com/owner/repo)."
          },
          "chart": {
            "type": "string",
            "description": "Helm chart name. Required when type is helm."
          },
          "url": {
            "type": "string",
            "format": "uri",
            "description": "Direct URL to a YAML manifest containing CRDs. Required when type is url. Supports {version} placeholder which is replaced with the version field value before fetching."
          },
          "path": {
            "type": "string",
            "description": "Subdirectory within the repository to restrict CRD scanning. Only used when type is git+github."
          },
          "version": {
            "type": "string",
            "pattern": "^v?[0-9]",
            "description": "Upstream version to extract (e.g., v1.17.2)."
          },
          "license": {
            "type": "string",
            "description": "SPDX license identifier (e.g., Apache-2.0). Must permit redistribution of derived artifacts."
          },
          "homepage": {
            "type": "string",
            "format": "uri",
            "description": "Project homepage URL."
          },
          "values": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Helm --set values to pass during template rendering."
          },
          "include": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Allowlist of CRD kinds or group/kind patterns to include."
          },
          "exclude": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Denylist of CRD kinds or group/kind patterns to exclude."
          }
        },
        "allOf": [
          {
            "if": {
              "properties": {
                "type": {
                  "const": "helm"
                }
              }
            },
            "then": {
              "required": [
                "repo",
                "chart"
              ]
            }
          },
          {
            "if": {
              "properties": {
                "type": {
                  "const": "url"
                }
              }
            },
            "then": {
              "required": [
                "url"
              ]
            }
          },
          {
            "if": {
              "properties": {
                "type": {
                  "const": "git+github"
                }
              }
            },
            "then": {
              "required": [
                "repo"
              ]
            }
          }
        ]
      }
    }
  }
}