# api-specs

**Repository Path**: mirrors_maxmind/api-specs

## Basic Information

- **Project Name**: api-specs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h4 align="center">
  🚨🚨🚨 NOT PRODUCTION READY 🚨🚨🚨
  <br/>
  <br/>
  <small>These spec files are in active development.</small>
</h4>

- - -

<h3 align="center">
  <img
    alt="MaxMind"
    src=".github/images/maxmind-logo.svg"
    width="300"
  />
  <br/>
  <br/>
  <small>API Specs</small>
</h3>

- - -

## Overview

This project documents MaxMind's public APIs using the [OpenAPI spec](http://spec.openapis.org/oas/v3.0.3) for web services and [JSON Schema spec](https://json-schema.org/) for non-web services.

Spec files:
* minFraud 2.0 ([bundled](https://maxmind.github.io/api-specs/minfraud/2.0/spec.bundled.json) | [dereferenced](https://maxmind.github.io/api-specs/minfraud/2.0/spec.dereferenced.json))

## Usage

* [Minimum Requirements](#minimum-requirements)
* [Installation](#installation)
* [Development](#development)
* [Testing](#testing)
* [Building](#building)
* [Deployments](#deployments)

### Minimum Requirements
* Node 12
* Yarn 1.22

If you need help installing and/or managing Node and Yarn versions, check out [NVM](https://github.com/nvm-sh/nvm) or [Volta](https://docs.volta.sh/guide/).

### Installation
```sh
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
```sh
yarn build
```

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