blocks.json-schema
Fullständigt schema
JSON
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"public": "https://example.com/registry.json",
"private": {
"url": "https://private.example.com/registry.json",
"headers": {
"Authorization": "Bearer ${REGISTRY_TOKEN}"
}
}
}
}
Fält
| Fält | Typ | Krävs | Beskrivning |
|---|---|---|---|
$schema |
string |
Nej | JSON Schema URL för validering i redigeraren. |
directory |
string |
Ja | Relativ sökväg från blocks.json där block installeras. Får inte vara tom. |
registries |
Record<string, string | RegistryRef> |
Ja | Avbildning av namnrymder till registerreferenser. Kan vara tom. |
Format för registerreferenser
Varje värde i registries är antingen en sträng URL eller ett objekt:
Sträng: en giltig URL till en registry.json-fil.
Objekt:
| Fält | Typ | Krävs | Beskrivning |
|---|---|---|---|
url |
string |
Ja | Giltig URL till en registry.json-fil. |
headers |
Record<string, string> |
Nej | HTTP-headers som skickas med varje förfrågan till det här registret. Värden stöder interpolation med ${ENV_VAR}. |
Valideringsregler
directorymåste vara en sträng som inte är tom.- Varje nyckel i
registriesmåste vara en sträng som inte är tom. - Strängvärden för register måste vara giltiga URL:er.
- Registervärden som är objekt måste ha ett giltigt
url-fält. ${ENV_VAR}-referenser i headers löses vid körning. Saknade variabler ger ett fel som anger variabeln och headern.- Objektet
registrieskan vara tomt. Då avslutasaddmedNo registries configured in blocks.json. Add a registry first.,listskriver utNo registries configured.ochsearchskriver utNo blocks matching "<query>".
Identifiering av konfigurationsfil
CLI söker efter blocks.json med början i den aktuella arbetskatalogen
och går upp genom överordnade kataloger, högst 20 nivåer. Den första
blocks.json som hittas används.