Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
emmanuelgautier committed Oct 2, 2024
1 parent 02424f6 commit a55aeb8
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,36 @@ All the vulnerabilities detected by the project are listed at this URL:
## Example usage

### Using OpenAPI

```yaml
name: Scan for API vulnerabilities

on: [push]

permissions:
contents: read

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: VulnAPI
uses: cerberauth/vulnapi-action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
openapi: 'openapi.yaml'
```
### Using Curl
```yaml
name: VulnAPI
name: Scan for API vulnerabilities

on: [push]

Expand All @@ -55,8 +83,7 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
curl:
'curl http://localhost:8080 -H "Authorization: Bearer eyJhbGci..."'
curl: 'curl http://localhost:8080 -H "Authorization: Bearer eyJhbGci..."'
```
## Inputs
Expand Down

0 comments on commit a55aeb8

Please sign in to comment.