Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ckoegel committed Nov 8, 2024
1 parent 2db2707 commit 050dedb
Showing 1 changed file with 9 additions and 25 deletions.
34 changes: 9 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,27 @@ This action utilizes the [openapi-generator-cli](https://github.com/OpenAPITools
## Inputs

```yml
branch-name:
description: Branch name
required: true
token:
description: Github auth token
required: true
language:
description: The generator name (language) (`-g`) argument for the openapi-generator-cli
required: true
config:
description: The configuration (`-c`) argument for the openapi-generator-cli
required: true
user-email:
description: Git user email
default: [email protected]
required: false
username:
description: Github username
default: DX-Bandwidth
default: ./openapi-config.yml
api-spec-path:
description: The destination of the API Specification to generate a client from
required: false
default: ./bandwidth.yml
openapi-generator-version:
description: The OpenAPI Generator project version, in `x.x.x` format
required: false
default: '6.5.0'
api-spec-path:
description: The destination of the API Specification to generate a client from
default: '7.6.0'
additional-properties:
description: Additional properties to pass to the generator
required: false
default: ./bandwidth.yml
working-directory:
default: ''
working-directory:
description: The working directory to run the action in
required: false
default: ./
```
## Outputs
```yml
changes:
description: Boolean representing if files in the SDK were changed or not.
```

0 comments on commit 050dedb

Please sign in to comment.