README.md

🚨🚨🚨 NOT PRODUCTION READY 🚨🚨🚨

These spec files are in active development.

---

API Specs

---

Overview

This project documents MaxMind's public APIs using the OpenAPI spec for web services and JSON Schema spec for non-web services.

Spec files:

• minFraud 2.0 (bundled | dereferenced)

Usage

• Minimum Requirements
• Installation
• Development
• Testing
• Building
• Deployments

Minimum Requirements

• Node 12
• Yarn 1.22

If you need help installing and/or managing Node and Yarn versions, check out NVM or Volta.

Installation

yarn install

Development

The specs are defined using TypeScript. Configuring "intellisense" in your text editor to will improve your developer experience by adding niceties such as code completion, parameter info, interface info, and member lists.

Testing

yarn test

Building

yarn build

Deployment

A deploy GitHub action is configured to push the compiled JSON build artifacts to GitHub pages.