Skip to content

ErkanUK/flex_api

Repository files navigation

This is an OAS 3.0 API specification
It is an example definition with only 1 GET operation for documentation purposes.
We are using ChatGPT and Copilot to develop generic building blocks.

We strive to create machine readable models. Therefor we use LinkML, SKOS and RDF type data where we can.

# Scripts

This folder contains helper scripts used to generate and maintain repo artifacts.

#ChatGPT
The GPT that creates an OAS spec file from a service description can be found here:
https://chatgpt.com/share/e/6957fc13-d28c-8016-b731-84468fc79a9f 


#Workflow

The workflow will generate diagrams in docs/diagrams/generated.

The workflow checks for services and will generate an Index.html page.

Renders PlantUML `.puml` files found under `docs/diagrams` and `docs/maps` to SVG and/or PNG.

Usage:
```bash
# SVG (default)
scripts/render-diagrams.sh

# PNG
scripts/render-diagrams.sh png

# Both
scripts/render-diagrams.sh both