Skip to content

Commit

Permalink
document spec building
Browse files Browse the repository at this point in the history
  • Loading branch information
CubicrootXYZ committed Oct 13, 2024
1 parent 4289dea commit cbe2c77
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,17 @@ jobs:
spec_artifact_name: spec
spec_artifact_path: tests/openapi2/
spec_filename: petstore.yaml
```

### Generate OpenAPI 2 spec from golang source code

Generate OpenAPI 2 spec file based on `swag` compatible annotiations in the source code.

```yaml
jobs:
build:
uses: ./.github/workflows/openapi2_golang_build.yaml
with:
entrypoint: cmd/main.go
workdir: ./
```

0 comments on commit cbe2c77

Please sign in to comment.