# schemaker

**Repository Path**: mirrors_mozilla/schemaker

## Basic Information

- **Project Name**: schemaker
- **Description**: Web service to perform JSON and Parquet schema format conversion and validation
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Schemaker
=========

The "schema service" is a collection of tools, including a web service and some
glue code that is used to validate incoming telemetry and other data against
the specified schema that the data is supposed to honor, and support the
efforts of converting data from the ingested format (initially JSON) to the
desired storage format (initially Parquet).

[![CircleCI](https://img.shields.io/circleci/project/github/mozilla/schemaker/master.svg)](https://circleci.com/gh/mozilla/schemaker)
[![codecov](https://codecov.io/gh/mozilla/schemaker/branch/master/graph/badge.svg)](https://codecov.io/gh/mozilla/schemaker)

Development Setup
-----------------

This application uses Docker for local development. Please make sure to
[install Docker](https://docs.docker.com/mac/) and
[Docker Compose](https://docs.docker.com/compose/install/).

To start the application, run:

    make up

Run the tests
-------------

Run the tests using the following command on your computer:

    make test

This will spin up a Docker container to run the tests, so please set up
the development setup first.


API Endpoints
=============

### `POST /convert`

Converts the provided schema to the requested output schema.

Query parameters:

* `output` (required): The requested output format. Currently the only format
  supported is 'parquet-mr'.

Provide the input schema as the body of the POST request.

Example output:
```
{
  "parquet-mr": "<full output of schema>"
}
```