https://github.com/adiwg/mdjson-schemas

JSON schemas, examples, and templates for ADIwg metadata standards
https://github.com/adiwg/mdjson-schemas

adiwg json-schemas metadata

Last synced: 4 days ago
JSON representation

JSON schemas, examples, and templates for ADIwg metadata standards

• Host: GitHub
• URL: https://github.com/adiwg/mdjson-schemas
• Owner: adiwg
• License: lgpl-3.0
• Created: 2014-02-18T19:31:03.000Z (almost 11 years ago)
• Default Branch: develop
• Last Pushed: 2024-12-20T17:37:17.000Z (13 days ago)
• Last Synced: 2024-12-26T02:05:08.768Z (8 days ago)
• Topics: adiwg, json-schemas, metadata
• Language: Ruby
• Homepage: http://www.adiwg.org/projects/
• Size: 1.01 MB
• Stars: 18
• Watchers: 14
• Forks: 16
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/adiwg/mdJson-schemas.svg?branch=master)](https://travis-ci.org/adiwg/mdJson-schemas)

[![Gem Version](https://badge.fury.io/rb/adiwg-mdjson_schemas.svg)](http://badge.fury.io/rb/adiwg-mdjson_schemas)

[![Bower version](https://badge.fury.io/bo/mdjson-schemas.svg)](https://badge.fury.io/bo/mdjson-schemas)

[![npm version](https://badge.fury.io/js/mdjson-schemas.svg)](https://badge.fury.io/js/mdjson-schemas)

# mdJson-schemas

JSON schemas for the ADIwg project and data metadata standard

## Ruby Gem

Use with [ruby-json-schema/json-schema](https://github.com/ruby-json-schema/json-schema) to validate mdJSON records in Ruby.

### Installation

Add this line to your application's Gemfile:

    gem 'adiwg-mdjson_schemas'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install adiwg-mdjson_schemas

## npm

Install:

    $ npm install mdjson-schemas

    const Schemas = require('../resources/js/schemas.js');

### Usage

The main schema file is `schema/schema.json`. Load that file in your [validator](http://json-schema.org/implementations.html#libraries).

**NOTE**: The schemas use relative addresses for `$ref` paths. If this causes a problem

with the [ruby-json-schema/json-schema](https://github.com/ruby-json-schema/json-schema) gem,

as a workaround you can pre-load all of the schemas by calling `ADIWG::MdjsonSchemas::Utils::load_schemas` before validation.

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

### See [CONTRIBUTING](CONTRIBUTING.md) file

View the [CONTRIBUTING.md](CONTRIBUTING.md) file for additional guidelines related to developing mdJson schemas.