FAIR JSON Meta-Schema

Caution

EARLY DEVELOPMENT STAGE: This project and its meta-schemas are in early development for prototyping and testing only. Focus is on implementing core vocabularies and ensuring architectural consistency. Avoid production-ready assumptions.

A custom JSON Schema dialect and vocabularies for FAIR Datasets.

Versioning

The FAIR Data JSON Schema follows a versioned release strategy:

• Release Versions (e.g., /0.1.0/): Stable points documented in the changelog.

• Development Track (/dev/): The bleeding edge where new features are prototyped.

• Landing Page: The root URL (https://highvaluedata.net/fair-data-schema/) serves the interactive project overview.

Introduction

• Background & Motivation
  • The Challenge
  • An Enrichment of Common IT Practice, Not a New Dataset Model
  • The 2-Tier Usability Model
  • What is a JSON Meta-Schema?
• Alignment with CDIF v1.1 Profiles & FAIR Data JSON Schema
  • 1. What is CDIF Version 1.1?
  • 2. Profile-by-Profile Alignment Matrix
  • 3. How They Work Together (The Ingest Pipeline)
  • 4. Technical Comparison Table
  • 5. Summary

Publications

• Publications & Vision
• Executive Overviews
• Vision & Positioning
• Introducing FAIR Data JSON Schema: Bringing FAIR Data Principles to Modern Software

Specifications

• Specifications
  • Specification Overview
  • Scope Architecture
  • Machine Actionability & Zero Lock-In
  • Advanced Extension Mechanisms
• Keyword Reference & Scopes
  • 1. Universal Scope (Any Schema Object)
  • 2. Dataset Scope (Container / Resource Level)
  • 3. Property Scope (Variable / Column Level)

Cookbook & Guides

• FAIR Data Cookbook
  • 🟢 Tier 1: Essential Recipes (Start Here)
  • 🔵 Tier 2: Advanced & Extended Recipes (Optional Deep-Dive)
  • All Recipes
• Validation Guide — Validating JSON & YAML Datasets
  • Zero New Tools to Learn
  • 1. Command Line (CLI)
  • 2. REST API Validation (/v1/validate & /v1/lint)
  • 2. Python
  • 3. JavaScript / Node.js
  • 4. Other Ecosystems (Rust, Go, Java)
  • 5. CI/CD Integration (GitHub Actions)
  • Summary Matrix
• REST API Reference & Deployment Guide
  • 1. OpenAPI Documentation
  • 2. API Endpoints Overview
  • 3. Hosting & Deployment Options
• Python SDK — Pydantic Models
  • Standalone Design
  • Installation
  • Basic Usage
  • Advanced Usage
  • RO-Crate 1.1 Export
  • Auto-Generation
• TypeScript SDK — Types & Zod Schemas
  • Overview
  • Installation
  • Basic Usage
  • Auto-Generation
• Rust SDK — Serde Data Models
  • Overview
  • Dependencies (Cargo.toml)
  • Basic Usage
  • Auto-Generation

Extension Mechanisms (Advanced)

• Extension Mechanisms

Language Packages & API Reference

• Python Package and API
• TypeScript Package & API Reference
• Rust Package & API Reference

Project

• Changelog