Skip to content

BharatAddress/specs

Bharat Address Specifications

Website: https://bharataddress.github.io

Schema Lint

Purpose: normative documents and schemas for the Bharat Address project. This repo defines the minimal address feature schema (JSON Schema draft 2020-12) and related guidance for ULBs and integrators.

Contents

  • address-register.schema.json: minimal JSON Schema for address features.
  • street-naming-numbering.md: guidance for ULBs.
  • digipin-integration.md: DIGIPIN entrance point selection and privacy notes.
  • lgd-ulb-codes.md: how to key every record to LGD and wards.
  • ulpin-linkage.md: optional linkage to ULPIN.
  • ogc-api-features.yml / ogc-api-features.json: OpenAPI 3.1 for OGC API Features.
  • examples/: example Feature and FeatureCollection payloads.
  • scripts/: schema and example validators.
  • DATA_DICTIONARY.md: field-by-field semantics.
  • CONFORMANCE.md: OGC conformance notes.
  • CHANGELOG.md: versioned changes.

Quickstart

python scripts/check_schema.py

How to use

  • Treat address-register.schema.json as the canonical schema.
  • Use examples/ as reference payloads for validators and tooling.
  • Update DATA_DICTIONARY.md when fields or semantics change.

Versioning

  • Semantic versioning.
  • Current release: 0.1.0.

References

Contributor Guide

Releases

No releases published

Packages

No packages published

Languages