https://github.com/geojson/schema

JSON Schema for GeoJSON
https://github.com/geojson/schema

geojson json-schema

Last synced: 3 months ago
JSON representation

JSON Schema for GeoJSON

• Host: GitHub
• URL: https://github.com/geojson/schema
• Owner: geojson
• License: mit
• Created: 2018-03-03T21:20:45.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-17T18:03:26.000Z (8 months ago)
• Last Synced: 2024-04-26T22:21:10.358Z (6 months ago)
• Topics: geojson, json-schema
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/geojson-schema
• Size: 441 KB
• Stars: 87
• Watchers: 13
• Forks: 17
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

• awesome-starred - geojson/schema - JSON Schema for GeoJSON (others)

README

        
# GeoJSON Schema

This repository provides tools for building [JSON Schema](https://json-schema.org/) docs for [GeoJSON](https://geojson.org/).  A schema is generated for each of the GeoJSON object types, and each individual doc is complete (without `$ref`s to other documents).  So applications can consume just what they need and avoid extra fetching.

See JSON Schema docs for the GeoJSON types below:

 * [`FeatureCollection`](https://geojson.org/schema/FeatureCollection.json)

 * [`Feature`](https://geojson.org/schema/Feature.json)

 * [`Geometry`](https://geojson.org/schema/Geometry.json)

 * [`GeometryCollection`](https://geojson.org/schema/GeometryCollection.json)

 * [`MultiPolygon`](https://geojson.org/schema/MultiPolygon.json)

 * [`MultiLineString`](https://geojson.org/schema/MultiLineString.json)

 * [`MultiPoint`](https://geojson.org/schema/MultiPoint.json)

 * [`Polygon`](https://geojson.org/schema/Polygon.json)

 * [`LineString`](https://geojson.org/schema/LineString.json)

 * [`Point`](https://geojson.org/schema/Point.json)

The overall GeoJSON schema can be found at

 * [`GeoJSON`](https://geojson.org/schema/GeoJSON.json)

The schema files are also published to the [`geojson-schema` package](https://www.npmjs.com/package/geojson-schema) on npm.  You can add them as a dependency to your project with the following:

    npm install geojson-schema

## Limitations

The schema can not be used to validate that linear rings are closed or that they follow the right-hand rule.  These two elements of the [GeoJSON specification](https://datatracker.ietf.org/doc/html/rfc7946) cannot be represented in JSON Schema.  To enforce these two elements of linear ring validation, parsers must implement their own logic on top of JSON Schema validation.

# Development

Install dependencies:

    npm install

To build the schema docs:

    make

The output will be in the `build` directory.

A CI job builds commits pushed to `main`.  After a successful build, artifacts are pushed to the `gh-pages` branch and will be accessible at geojson.org/schema/.json (e.g. https://geojson.org/schema/Point.json).

![Status](https://github.com/geojson/schema/actions/workflows/test.yml/badge.svg)

# Publishing

To publish the [`geojson-schema` package](https://www.npmjs.com/package/geojson-schema), run the following:

    npm version minor # or major or patch

    make build

    git push --tags origin main

    pushd build && npm publish && popd