Clustron API

This repository contains the TypeSpec API definitions for Clustron.

API Documentation

• Swagger UI
• Redocly

Prerequisites

• Node.js and npm
• TypeSpec compiler (@typespec/compiler)

Installation

# Install TypeSpec compiler globally
npm install -g @typespec/compiler

# Install project dependencies
tsp install

Build Commands

The project includes a Makefile with the following commands:

Format Check

make format

Compilation

make compile

Cleanup

make clean

Full Build

make

Output

The compilation process generates OpenAPI specification in the tsp-output/schema/openapi.yaml file.

GitHub Actions

This project includes GitHub Actions workflow that:

1. Checks TypeSpec formatting
2. Compiles TypeSpec to OpenAPI
3. Generates and deploys Swagger UI documentation to GitHub Pages