Schema Registry
Registry skema JSON untuk format spesifikasi NEIR — skema berversi untuk memvalidasi dokumen NAEOS Engineering Intelligence Representation.
Ringkasan
NEIR Schema Registry menghosting definisi JSON Schema berversi untuk format spesifikasi NAEOS Engineering Intelligence Representation (NEIR). Skema ini memungkinkan autocompletion IDE, validasi, dan dukungan alat untuk file .naeos.yaml dan .naeos.json.
Skema Terbaru
Skema stabil saat ini adalah v1.
| Versi | URL Skema | Status |
|---|---|---|
| v1 | /schemaregistry/v1/neir.json | Stabil |
| latest | /schemaregistry/latest.json | Stabil terbaru |
Penggunaan
Integrasi Editor
Tambahkan field $schema ke file spesifikasi NEIR Anda:
# naeos.yaml
$schema: https://naeos.dev/schemaregistry/latest.json
project: my-project
modules:
- name: core
path: ./internal/core
Ini mengaktifkan IntelliSense dan validasi inline di editor seperti VS Code, JetBrains, dan lainnya yang mendukung JSON Schema.
Validasi CLI
Gunakan CLI NAEOS untuk memvalidasi spesifikasi terhadap skema registry:
naeos schema validate spec.yaml
naeos schema validate spec.json --output json
Penggunaan Programatis
Ambil skema secara programatis:
curl -s https://naeos.dev/schemaregistry/latest.json
Versioning
Versi skema mengikuti versi spesifikasi NEIR. Perubahan yang tidak kompatibel ke belakang pada model NEIR menghasilkan versi skema baru. Penambahan kecil (field opsional baru) bersifat aditif dalam satu versi.
| NEIR Version | Schema Version | Catatan |
|---|---|---|
| 1.x | v1 | Skema stabil awal |
Konten Skema
Skema JSON NEIR mendefinisikan bagian-bagian tingkat atas ini:
project— Metadata proyek (nama, versi, deskripsi, lisensi, penulis)architecture— Pola arsitektur dan lapisandomain— Model domain dengan bounded context, aggregate, entitymodules— Definisi modul dengan path dan paketcomponents— Katalog komponen dengan jenis dan dependensiservices— Definisi layanan dengan endpoint dan portapis— Spesifikasi API dengan protokol dan skemastorage— Backend penyimpanan (SQL, NoSQL, cache, queue, blob)infrastructure— Penyedia dan sumber daya infrastruktursecurity— Autentikasi, otorisasi, enkripsi, rahasiaai— Integrasi model AI, prompt, bundel konteksdocumentation— Panduan dokumentasi, referensi, ADRdeployment— Strategi deployment, lingkungan, scalingtesting— Strategi pengujian, framework, cakupan, fixturemetadata— Metadata spesifikasi dengan pelacakan versi dan timestampgeneration— Konfigurasi generasi kode