mms-api-schema

0.0.0 • Public • Published

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.

Documentation

Consumers

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 Friendly Skunk

Readme

Keywords

Package Sidebar

Install

npm i mms-api-schema

Weekly Downloads

0

Version

0.0.0

License

MIT

Last publish

Collaborators

  • denniskuczynski