@owlgrid-dev/specifications v0.0.0

OwlGrid OpenAPI specifications generator

The goal of this module is to write JSON schemas and OpenAPI specifications in different files (to enhance readibility), then the module will generate a single OpenAPI specification file.

Usage

Write your OpenAPI specifications in JSON inside the specifications folder. References must be written as "$ref": "local/path/to/your/definition".

Then, run yarn generate to generate the OpenAPI specifications in JSON. The generated files will be written in the generated folder.

The command yarn export will generate the OpenAPI specifications (yarn generate), export them to the folder ../../owl-docUser-webFront/openapi and run yarn openapi to generate markdown files inside the documentation repository.