Welcome to the Arta API Reference repository. This project is designed to generate the Open API Specification (OAS) for the Arta API. It is built using Elixir and leverages the Open API Spex library to define and document the API specifications.

On merges to the master branch, the build-deploy GitHub Actions workflow generates an OpenAPI JSON spec which is then pushed to api-reference.arta.io via bump.sh.

To run this project, you will need to install the following dependencies on your system:

• Elixir
• Scalar CLI
• jq

From the project root, run the following command in your terminal:

bin/run

From the project root, run the following command in your terminal:

bin/server

This will generate the API specification and start a Scalar API Client server to preview the generated documentation.