From 86eb335bf42aa81d826de4f074025b624469ef43 Mon Sep 17 00:00:00 2001
From: cubicroot <github@cubicroot.xyz>
Date: Sat, 5 Oct 2024 16:50:57 +0200
Subject: [PATCH] add some docu

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 088593a..fccecf2 100644
--- a/README.md
+++ b/README.md
@@ -50,4 +50,20 @@ jobs:
       workdir: "tests/golang_test/"
       services: '{"database": {"image": "mysql:8.0", "ports": ["3306:3306"]}}'
       env: '{"TESTENV": "value"}'
+```
+
+## OpenAPI
+
+### Render OpenAPI 2 specs with redoc
+
+Render an OpenAPI 2 spec with `redoc`. The spec file needs to be present in the given artifact. The rendered `index.html` will be added to the artifact `rendered-api-docu`.
+
+```yaml
+jobs:
+  render:
+    uses: CubicrootXYZ/Workflows/.github/workflows/openapi2_render.yaml
+    with:
+      spec_artifact_name: spec
+      spec_artifact_path: tests/openapi2/
+      spec_filename: petstore.yaml
 ```
\ No newline at end of file