claui / super-secret-api-spec

API specification for the LED wall

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Purpose

This repository contains the API specification in OpenAPI 3 format. Server and client stubs can be generated from this API specification.

Requirements

  • Node.js
  • Yarn

Usage

Generating server stubs from scratch

The following Bash snippet is for generating server stubs. The resulting server stubs are not meant to be committed to this repository.

Wall:

(
  set -ex

  yarn install
  yarn trash build/server

  yarn openapi-generator generate \
    -g ruby-sinatra \
    -i src/openapi/wall.json \
    -o build/server

  cd build/server

  bundle config --local allow_offline_install true
  bundle config --local path vendor/bundle
)

Kiosk:

(
  set -ex

  yarn install
  yarn trash build/server

  yarn openapi-generator generate \
    -g ruby-sinatra \
    -i src/openapi/kiosk.json \
    -o build/server

  cd build/server

  bundle config --local allow_offline_install true
  bundle config --local path vendor/bundle
)

About

API specification for the LED wall