Skip to content

Commit

Permalink
add some docu
Browse files Browse the repository at this point in the history
  • Loading branch information
CubicrootXYZ committed Oct 5, 2024
1 parent 0555eb5 commit 86eb335
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 86eb335

Please sign in to comment.