Skip to content

Add OpenAPI 3.0 specification for API v2 #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
renecannao merged 1 commit into from
Mar 24, 2026
Merged

Add OpenAPI 3.0 specification for API v2 #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/api-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Orchestrator API v2 provides a cleaner, more consistent REST API with structured

All v2 endpoints are mounted under `/api/v2` (respecting the configured `URLPrefix`).

## OpenAPI Specification

A machine-readable OpenAPI 3.0 specification for the v2 API is available at
[`docs/api/openapi.yaml`](api/openapi.yaml). You can use it with tools such as
Swagger UI, Redoc, or any OpenAPI-compatible client generator.

## Response Format

All v2 endpoints return a consistent JSON envelope:
Expand Down
Loading
Loading