µEd API (µEd-api)

Education Microservices API specification.

This repository is intentionally spec-only. It defines an OpenAPI 3.1 contract that educational services can implement to conform to the µEd API.

Contents

• openapi.yml — the main entry point (OpenAPI 3.1)
• paths/ — endpoint definitions (multi-file structure)

What the spec covers

At a high level, the API specifies endpoints for:

• generating feedback for student submissions
• educational chat interactions

All request/response shapes, validation rules, and examples live in the spec files.

Development

Prerequisites

npm install

Linting

Lint the OpenAPI spec using Redocly CLI:

npm run lint

Bundling

Bundle the multi-file spec into a single file at dist/openapi.yml:

npm run bundle

Viewing the spec

The published spec is also available in an online viewer at mued.org/spec.

For local viewing, open openapi.yml in any OpenAPI-capable tool (e.g., Swagger Editor, Swagger UI, Stoplight, Redocly). If you want a single-file version, run npm run bundle first and then open dist/openapi.yml.

Contributing

Contributor workflow guidance for issues, branching, reviews, and merging lives in CONTRIBUTING.md.