The project hosts a classical b2b-interface (Web-API) specification for (insurance) contract data and document exchange.

This is a java project leveraging swagger-core and a converter to create the OpenAPI 2.0 specs. It provides the Contracts API according to the OpenAPI Spec. This application uses JAX-RS annotated resources to resolve a valid OpenAPI definition out of Java classes representing the API

The name Corellia is a reference to a fictitious planet from StarWars: one of the first trading planets in the universe with its own Corellian Trade Spine.

You can find the openapi specs in the following files:

OpenAPI v3 Specs: docs/openapi.json

OpenAPI v2 Specs: docs/swagger.json

To generate the docs/openapi.json OpenAPI specification, call

$ mvn exec:java@gen-openapi

Note: (One must at least once have called $ mvn install, otherwise the above call won't work)

Firstly generate the OpenAPI v3 specs (will be located at docs/openapi.json) Then use the following call to convert the OpenAPI v2 specs (will be located at docs/swagger.json)

$ mvn exec:java@gen-swagger

Note: (One must have issued npm install previously.)

Run e.g. on master: mvn -B release:prepare e.g. via

Subsequently the GitHub action worksflow "create release" will pick up the published tag and release and deploy the artifacts in the Github package registry.