JSON Toolkit

JSON Schema से YAML का सत्यापन: कॉन्फ़िग फ़ाइलों का सेफ्टी नेट

मुख्य बात: बिना त्रुटि parse होने वाली YAML फ़ाइल सही फ़ाइल नहीं है: YAML 1.1 पार्सर के लिए country: NO स्ट्रिंग नहीं है, और version: 1.10 चुपचाप float 1.1 बन जाता है। यह गाइड समझाता है कि JSON Schema YAML का सत्यापन क्यों कर सकता है, CLI और एडिटर रास्ते कैसे सेट करें, एक schema नॉर्वे देश-कोड वाली असली घटना कैसे पकड़ लेता, और schema सत्यापन की तीन सीमाएँ।

मध्यम~6 मिनट पढ़ें2026-11-13 को प्रकाशित2026-11-13 को अपडेट किया गया
JSON Schema से YAML कॉन्फ़िग फ़ाइल सत्यापन का चित्रण

निष्कर्ष: YAML 1.2 JSON का सख़्त सुपरसेट है, इसलिए JSON Schema parse के बाद की डेटा संरचना का सत्यापन करता है, फ़ाइल का फॉर्मेट नहीं — schema एक बार लिखिए, और वह JSON व YAML दोनों डेटा को कवर करती है। यही कारण है कि पार्सर चुपचाप टाइप बदलने पर यह उसे पकड़ लेता है।

बिना त्रुटि का yaml.safe_load सिर्फ़ इतना सिद्ध करता है कि फ़ाइल वैध YAML है। यह सिद्ध नहीं करता कि country: NO अब भी स्ट्रिंग है — YAML 1.1 पार्सर के तहत आपका कोड फ़ाइल देखने से बहुत पहले ही वह false बन चुका होता है।

एक: बिना त्रुटि parse ≠ सही कॉन्फ़िग — पहले एक असली घटना

एक ई-कॉमर्स टीम ने डिलीवरी देशों में नॉर्वे जोड़ा: एक लाइन, NO, Ansible की group_vars में एक लिस्ट में। रिव्यू हुआ, सत्यापन हुआ, डिप्लॉय हुआ। एक सप्ताह बाद: नॉर्वे के शून्य ऑर्डर — सर्वरों पर JSON फ़ाइल में "DK", false, "SE" था। Ansible अपनी वेरिएबल फ़ाइलें PyYAML से parse करता है, जो YAML 1.1 पार्सर है: फ़ाइल पढ़ते ही NO बूलियन false बन गया था, और to_json फ़िल्टर ने वैसा ही लिख दिया। टेम्पलेट रेंडर हो गया, JSON वैध था, किसी ने शिकायत नहीं की — केवल checkout सर्विस हर नॉर्वेजियन ग्राहक को लौटाती रही, क्योंकि NO लिस्ट में नहीं था।

ऐसी घटनाओं की साझा विशेषता: सारे सिंटैक्स टूल हरे हैं, पर डेटा परत पहले ही गलत है। नीचे की तालिका PyYAML 6.0.3 पर मापा गया टाइप ड्रिफ्ट दिखाती है; YAML 1.2 पार्सर इसका कुछ हिस्सा ही ठीक करते हैं:

आप लिखते हैं YAML 1.1 पढ़ता है YAML 1.2 पढ़ता है आप चाहते थे
country: NO false "NO" "NO"
version: 1.10 float 1.1 float 1.1 "1.10"
zip: 02134 ऑक्टल 1116 दशमलव 2134 "02134"
mode: 0755 दशमलव 493 दशमलव 755 493 या "0755"
ports: ["22:22"] षासंद्र 1342 "22:22" "22:22"

मूल उपाय: जो स्ट्रिंग कोड जैसी लगे उस पर कोट्स लगाना। पर कोट्स मानवीय स्मृति पर टिके हैं; schema मशीनी जाँच पर टिका है — इसीलिए YAML JSON Schema का हकदार है।

दो: JSON Schema YAML पर शासन क्यों कर सकता है

YAML 1.2 विनिर्देश सीधे कहता है: 1.2 का मुख्य लक्ष्य YAML को JSON का सख़्त सुपरसेट बनाना था, और 1.2 पार्सर साधारण JSON को बिना बदले पढ़ता है। दोनों फॉर्मेट उन्हीं डेटा संरचनाओं में parse होते हैं, इसलिए वैलिडेटर के लिए फ़ाइल एक्सटेंशन का कोई मतलब नहीं। पूरा पाइपलाइन तीन कदम का है:

  1. YAML फ़ाइल को ऑब्जेक्ट/एरे में parse करना;
  2. JSON Schema लोड करना;
  3. डेटा को schema के विरुद्ध सत्यापित करना — त्रुटियाँ या पास।

ध्यान दें कि पहला कदम YAML को JSON टेक्स्ट में सीरियलाइज़ कर दोबारा parse करने की माँग नहीं करता; आपकी भाषा की YAML लाइब्रेरी संरचना सीधे वैलिडेटर को देती है। schema खुद भी YAML में लिखा जा सकता है (yq -P schema.json > schema.yaml एक कमांड में बदल देता है), पर JSON में रखना सबसे सुरक्षित विकल्प है: टूल संगतता बेहतर, और schemastore.org कैटलॉग की सारी schemas JSON हैं।

तीन: तीन CLI रास्ते जो आज से काम करते हैं

एक config.yaml लें जिसमें schema name और version माँगती है, semver आकार थोपती है, और countries दो बड़े अक्षरों की स्ट्रिंग्स का एरे है:

# config.yaml
name: checkout
version: "1.4.2"
countries:
  - DK
  - NO
  - SE

Python (jsonschema + PyYAML):

import json, yaml
from jsonschema import validate

data = yaml.safe_load(open("config.yaml", encoding="utf-8"))
schema = json.load(open("schema.json", encoding="utf-8"))
validate(instance=data, schema=schema)

Node (js-yaml + Ajv):

import Ajv from "ajv";
import yaml from "js-yaml";
import fs from "fs";

const schema = JSON.parse(fs.readFileSync("schema.json", "utf8"));
const data = yaml.load(fs.readFileSync("config.yaml", "utf8"));
const validate = new Ajv().compile(schema);
if (!validate(data)) console.error(validate.errors);

शुद्ध पाइपलाइन (yq + ajv-cli):

yq -o=json config.yaml | ajv validate -s schema.json -d -
# या check-jsonschema, जो YAML सीधे स्वीकार करता है
pip install check-jsonschema
check-jsonschema --schemafile schema.json config.yaml

तीन रास्ते केवल parse कदम में भिन्न हैं: पहले दो स्पष्ट, दो पंक्तियों में; पाइपलाइन एक धारा में बहती है; और check-jsonschema भीतर ही YAML→JSON रूपांतरण करता है। schema फ़ाइल तीनों के लिए एक ही है।

चार: एडिटर में रीयल-टाइम सत्यापन: modeline और SchemaStore

Red Hat का YAML एक्सटेंशन (yaml-language-server आधारित) VS Code में लगभग 3 करोड़ इंस्टॉल रखता है और JSON Schema draft-04/07/2019-09/2020-12 समर्थन करता है। इसे जोड़ने के तीन तरीके:

# तरीका 1: modeline — फ़ाइल की पहली पंक्ति schema की ओर इशारा करती है
# yaml-language-server: $schema=./schema.json
name: checkout
// तरीके 2 और 3: .vscode/settings.json, फ़ाइल नाम या glob से
{
  "yaml.schemas": {
    "./schema.json": ["config/*.yaml", "*.config.yaml"],
    "https://json.schemastore.org/github-workflow.json": ".github/workflows/*.yml"
  }
}

yaml.schemaStore.enable डिफ़ॉल्ट रूप से चालू है: package.json, GitHub workflow या docker-compose जैसी जानी-पहचानी फ़ाइलें स्वतः schemastore.org कैटलॉग से जुड़ जाती हैं, बिना किसी कॉन्फ़िगरेशन के। schema के description फ़ील्ड autocompletion संकेत और टूलटिप बन जाते हैं, और गायब required प्रॉपर्टी लाल अंडरलाइन में दिखती है — कॉन्फ़िग की त्रुटियाँ "डिप्लॉय-बाद डिबग" से आगे बढ़कर "आप जिस क्षण टाइप कर रहे हैं" में आ जाती हैं। यह यह भी समझाता है कि SchemaStore क्यों, YAML का कोई "schema मानक" क्यों नहीं: YAML का कोई आधिकारिक schema मानक नहीं है, और JSON Schema de facto मानक है।

पाँच: एक schema नॉर्वे समस्या कैसे पकड़ता

पहले भाग की NO घटना पर लौटें। countries को एलिमेंट स्तर का schema दें:

{
  "type": "object",
  "required": ["name", "version", "countries"],
  "properties": {
    "countries": {
      "type": "array",
      "items": { "type": "string", "pattern": "^[A-Z]{2}$" }
    }
  }
}

PyYAML का बनाया false स्ट्रिंग नहीं है, इसलिए type: string तुरंत गिरता है; पार्सर उसे छोटे अक्षरों का "no" भी पढ़ ले तो pattern रोक देता। और कड़ाई के लिए enum व्हाइटलिस्ट जोड़ें। वही schema तीसरे भाग के CLI रास्तों से CI में चलता है, और चौथे भाग की modeline से एडिटर में — दोनों सिरों पर एक अनुबंध।

yamllint के साथ श्रम-विभाजन एक वाक्य का हकदार: yamllint का truthy नियम (केवल true/false स्वीकार, अन्य बूलियन वर्तनी चिह्नित) लेखन शैली पर शासन करता है और lint स्तर पर flag: yes पकड़ता है; JSON Schema डेटा की आकृति पर शासन करता है, पार्सर जो भी हो। घटना वाली टीम ने अंततः तीनों अपनाए: स्ट्रिंग्स पर कोट्स, पाइपलाइन में yamllint truthy, और टेम्पलेट में दो-अक्षर स्ट्रिंग की जाँच। दोनों रक्षा परतें एक-दूसरे को ढकती नहीं — पूरक होती हैं।

छह: Kubernetes मैनिफेस्ट का बैच सत्यापन

Kubernetes API खुद OpenAPI में वर्णित है, और kubernetes-json-schema प्रोजेक्ट उसे मानक JSON Schema में बदलता है। Kubeconform इसी रजिस्ट्री से बैच सत्यापन करता है: 4-कोर लैपटॉप पर 35,139 फ़ाइलें और 50,714 रिसोर्स kubeconform -ignore-missing-schemas -n 8 -summary से 6.7 सेकंड में खत्म, उसी काम पर kubeval 35 सेकंड लेता है। Helm का मानक अंदाज़: पहले render, फिर सत्यापन:

helm template my-app ./charts/my-app > rendered.yaml
kubeconform -strict -summary -kubernetes-version 1.28.0 rendered.yaml

-strict schema में अनर्परिभाषित फ़ील्ड अस्वीकार करता है (टाइपो जल्दी दिखते हैं); CRD रिसोर्स -ignore-missing-schemas से छोड़े जा सकते हैं या -schema-location से अपनी रजिस्ट्री जुड़ सकती है।

सात: schema सत्यापन जो नहीं कर सकता: तीन सीमाएँ

  1. पार्सर संस्करण का ड्रिफ्ट parse कदम पर ही होता है। schema parse का परिणाम देखती है: PyYAML ने जो NO पढ़ा वह अब false है, और schema उस गलत मान को केवल type/pattern से बंद कर सकती है। मूल उपाय कोट्स ही हैं; schema से पार्सर की मरम्मत की उम्मीद मत रखिए।
  2. तार्किक त्रुटियाँ परिधि के बाहर। selector में टाइपो या अनुपस्थित label की ओर इशारा करता K8s selector — schema आकृतियाँ जानती है, अर्थ नहीं। यह admission webhooks, OPA नीतियों या kubectl apply --dry-run=server की भूमि है।
  3. डुप्लिकेट की चुपचाप जीत जाते हैं। कई YAML पार्सर डुप्लिकेट की बिना चेतावनी स्वीकार करते हैं (आख़िरी जीतता है), इसलिए schema को ऐसा डेटा मिलता है जिसकी एक की पहले ही खो चुकी है। yamllint का key-duplicates नियम या parse hook ही पहचानकर्ता बने रहते हैं।

डिप्लॉय-पूर्व चेकलिस्ट: कोड जैसी स्ट्रिंग्स पर कोट्स → yamllint चलाएँ (truthy + key-duplicates) → JSON Schema सत्यापन CI और एडिटर दोनों जगह → क्लस्टर रिसोर्स पर अतिरिक्त --dry-run=server। इन चार कदमों से पहले भाग की नॉर्वे घटना पाइपलाइन का दूसरा कदम तक भी नहीं बचती।

FAQ

क्या JSON Schema सीधे YAML फ़ाइलों का सत्यापन कर सकता है?

हाँ — पर वह फ़ाइल के parse में आए डेटा को सत्यापित करता है, फ़ाइल को नहीं। YAML 1.2 JSON का सख़्त सुपरसेट है, दोनों उन्हीं संरचनाओं में parse होते हैं, इसलिए एक schema JSON और YAML दोनों की काम देती है। चार रास्तों में से एक चुनें — Python, Node, yq पाइपलाइन या check-jsonschema — फॉर्मेट हाथ से बदले बिना।

SchemaStore क्या है और कैसे इस्तेमाल करें?

schemastore.org एक JSON Schema कैटलॉग (catalog.json) है जिसमें सैकड़ों परिचित कॉन्फ़िग फ़ाइलों की schemas एकत्र हैं: package.json, GitHub workflow, docker-compose आदि। YAML/JSON समर्थन वाले एडिटर फ़ाइलों को इस कैटलॉग से स्वतः जोड़ते हैं, या आप yaml.schemas में URL मैन्युअल रूप से मैप कर सकते हैं। अपने प्रोजेक्ट की schema भी कैटलॉग में भेज सकते हैं।

क्या yamllint और JSON Schema एक-दूसरे को डुप्लिकेट करते हैं?

नहीं। yamllint लेखन शैली जाँचता है (इंडेंट, पंक्ति लंबाई, truthy, डुप्लिकेट की) टेक्स्ट स्तर पर; JSON Schema डेटा स्तर पर डेटा की संरचना जाँचता है (टाइप, required, enum, pattern)। नॉर्वे घटना की सुधार-सूची ने दोनों इस्तेमाल किए: truthy नियम flag: yes जैसी वर्तनी पकड़ता है, जबकि schema स्ट्रिंग एरे में पहुँच गए एक false को पकड़ता है।

Kubernetes के लिए: kubeconform या kubectl dry-run?

दो अलग पेशे। Kubeconform ऑफ़लाइन और बैच में चलता है, क्लस्टर चाहिए नहीं, संरचनात्मक त्रुटियों के लिए उसकी जगह CI में है; dry-run=server असली API सर्वर से बात करता है और admission webhook व कोटा की समस्याएँ खोलता है, पर क्लस्टर पहुँच चाहिए। मानक संयोजन: CI में kubeconform, फिर डिप्लॉय से पहले एक चक्कर --dry-run=server — दोनों परतें रखिए।


schema लिखने के बाद अपने YAML से बदला JSON ऑनलाइन JSON वैलिडेटर में पेस्ट कर पहले त्रुटियाँ देखें; schema के कीवर्ड लिखने हेतु देखें JSON Schema गाइड; schema को CI के टेस्ट से पहरे रखने हेतु पढ़ें JSON Schema कॉन्ट्रैक्ट टेस्टिंग; दैनिक JSON↔YAML रूपांतरण के लिए JSON YAML XML कन्वर्टर इस्तेमाल करें।