Skip to content

API Reference

Lombok’s HTTP API reference is generated from the committed OpenAPI artifact in the application repository.

This page currently links to the raw committed OpenAPI artifact as a practical fallback because the richer docs-side renderer could not be installed in this environment.

The canonical spec lives in the main Lombok app repo at:

  • packages/api/src/openapi.json

A vendored copy is kept in this docs repo at:

  • public/openapi-lombok.json

That vendored copy exists so the docs site can publish a stable reference surface without needing cross-repo filesystem access at build time.

The docs repo is prepared to expose the OpenAPI artifact as a first-class reference surface, but the dedicated rendering dependency could not be installed in this environment because the sandbox ran out of disk space during package extraction.

Until that is resolved, use the raw committed spec directly:

The current vendored spec is OpenAPI 3.1.0 and was copied from the committed application artifact.

Once dependencies can be installed successfully, this page should be upgraded to render the vendored spec through a Starlight-native OpenAPI reference surface so operations, schemas, and tags are navigable in the docs UI.