Repository navigation
Expand file tree
/
Copy pathplugins.schema.json
More file actions
33 lines (33 loc) · 1.83 KB
/
Copy pathplugins.schema.json
File metadata and controls
33 lines (33 loc) · 1.83 KB
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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/patch-it-dev/patch-it-plugins/blob/main/docs/plugins.schema.json",
"title": "patch-it plugins",
"description": "docs/plugins.json: every registered plugin, generated by `make plugins-json` from the plugin registry and docs/plugins.md.",
"type": "object",
"required": ["_comment", "$schema", "count", "plugins"],
"additionalProperties": false,
"properties": {
"_comment": { "type": "string" },
"$schema": { "type": "string" },
"count": { "type": "integer", "description": "How many plugins are listed." },
"plugins": {
"type": "array",
"items": {
"type": "object",
"required": ["id", "provider", "layer", "watches", "format", "source_url", "status", "provider_page"],
"additionalProperties": false,
"properties": {
"id": { "type": "string", "pattern": "^[a-z0-9][a-z0-9.-]*$", "description": "The plugin's --api id and every event's api field." },
"provider": { "type": "string", "minLength": 1 },
"layer": { "type": "string", "enum": ["api", "sdk", "package", "runtime", "ci", "ai-models"] },
"watches": { "type": "string", "minLength": 1 },
"format": { "type": "string", "enum": ["openapi", "retirements", "migrationguide", "removedmembers", "changelog", "feed", "apichangelog", "catalog", "eol"] },
"source_url": { "type": "string", "pattern": "^https://" },
"status": { "type": "string", "enum": ["live", "paused", "planned"] },
"status_note": { "type": "string", "description": "Why, for a paused plugin." },
"provider_page": { "type": "string", "pattern": "^providers/[a-z0-9][a-z0-9.-]*\\.md$", "description": "One page per provider: plugins of the same provider may share it." }
}
}
}
}
}