Skip to content

Commit

Permalink
README: mention caching of *2plantuml endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
agarciadom committed Dec 9, 2024
1 parent babff67 commit 24f148a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ This is a Micronaut library project which implements the core microservices used

* `POST /emfatic2plantuml`: transforms a metamodel written in [Emfatic](https://eclipse.dev/emfatic/) to a [PlantUML class diagram](https://plantuml.com/class-diagram).
* `POST /flexmi2plantuml`: transforms a model written in [Flexmi](https://eclipse.dev/epsilon/doc/flexmi/) that conforms to a metamodel written in Emfatic to a PlantUML class diagram.
* `POST /xmi2plantuml`: transforms a model written in XMI that conforms to a metamodel written in Emfatic to a PlantUML class diagram.
* `POST /epsilon`: runs an Epsilon script against a given set of metamodels (written in Emfatic) and models (written in Flexmi or XMI). The first model can alternatively be a JSON document.

The `*2plantuml` endpoints use in-memory caches to avoid rendering the same diagram multiple times.
These caches are limited in size by default: for further configuration, consult the [Micronaut Cache](https://micronaut-projects.github.io/micronaut-cache/latest/guide/) documentation.

## Configuration options

Besides the default [Micronaut options](https://docs.micronaut.io/latest/guide/index.html), the endpoints can be configured through these environment variables:
Expand Down

0 comments on commit 24f148a

Please sign in to comment.