mms-api-schema v0.0.0

MMS API Schema

This repository contains a JSON Schema / Hyper-Schema representation of the MongoDB Management Service Public API.

This project is inspired by the work Heroku is doing their public API.

• https://blog.heroku.com/archives/2014/1/8/json_schema_for_heroku_platform_api

Documentation

• Auto-Generated Documentation

Consumers

• node-mms-client

Generating Schema and Documentation

Schema files are generated using the prmd tool.

gem install prmd

cd docs/schema
prmd combine --meta meta.json schemata/ > schema.json
prmd verify schema.json
prmd doc schema.json --prepend overview.md > schema.md

License

Licensed under the MIT license.

Shout Outs

mms-api-schema is a MongoDB Skunkworks Project